Docspell

Attachment

secAttachmentIdArchiveGet

Get an attachment archive file.

Get the archive file that was originally uploaded that contains the attachment with the given id. If the attachment was not uploaded as part of an archive, a 404 is returned.


/sec/attachment/{id}/archive

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/attachment/{id}/archive"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AttachmentApi;

import java.io.File;
import java.util.*;

public class AttachmentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            byte[] result = apiInstance.secAttachmentIdArchiveGet(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdArchiveGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AttachmentApi;

public class AttachmentApiExample {

    public static void main(String[] args) {
        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            byte[] result = apiInstance.secAttachmentIdArchiveGet(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdArchiveGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *id = id_example; // An identifier

AttachmentApi *apiInstance = [[AttachmentApi alloc] init];

// Get an attachment archive file.
[apiInstance secAttachmentIdArchiveGetWith:id
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.AttachmentApi()
var id = id_example; // {{String}} An identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secAttachmentIdArchiveGet(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secAttachmentIdArchiveGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new AttachmentApi();
            var id = id_example;  // String | An identifier

            try
            {
                // Get an attachment archive file.
                byte[] result = apiInstance.secAttachmentIdArchiveGet(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AttachmentApi.secAttachmentIdArchiveGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiAttachmentApi();
$id = id_example; // String | An identifier

try {
    $result = $api_instance->secAttachmentIdArchiveGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentApi->secAttachmentIdArchiveGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AttachmentApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AttachmentApi->new();
my $id = id_example; # String | An identifier

eval { 
    my $result = $api_instance->secAttachmentIdArchiveGet(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AttachmentApi->secAttachmentIdArchiveGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AttachmentApi()
id = id_example # String | An identifier

try: 
    # Get an attachment archive file.
    api_response = api_instance.sec_attachment_id_archive_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AttachmentApi->secAttachmentIdArchiveGet: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
An identifier
Required

Responses

Status: 200 - Ok


secAttachmentIdArchiveHead

Get an attachment archive file.

Get information about the archive that contains the attachment with the given id. If the attachment was not uploaded as part of an archive, 404 is returned.


/sec/attachment/{id}/archive

Usage and SDK Samples

curl -X HEAD -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/attachment/{id}/archive"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AttachmentApi;

import java.io.File;
import java.util.*;

public class AttachmentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            apiInstance.secAttachmentIdArchiveHead(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdArchiveHead");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AttachmentApi;

public class AttachmentApiExample {

    public static void main(String[] args) {
        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            apiInstance.secAttachmentIdArchiveHead(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdArchiveHead");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *id = id_example; // An identifier

AttachmentApi *apiInstance = [[AttachmentApi alloc] init];

// Get an attachment archive file.
[apiInstance secAttachmentIdArchiveHeadWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.AttachmentApi()
var id = id_example; // {{String}} An identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.secAttachmentIdArchiveHead(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secAttachmentIdArchiveHeadExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new AttachmentApi();
            var id = id_example;  // String | An identifier

            try
            {
                // Get an attachment archive file.
                apiInstance.secAttachmentIdArchiveHead(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AttachmentApi.secAttachmentIdArchiveHead: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiAttachmentApi();
$id = id_example; // String | An identifier

try {
    $api_instance->secAttachmentIdArchiveHead($id);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentApi->secAttachmentIdArchiveHead: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AttachmentApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AttachmentApi->new();
my $id = id_example; # String | An identifier

eval { 
    $api_instance->secAttachmentIdArchiveHead(id => $id);
};
if ($@) {
    warn "Exception when calling AttachmentApi->secAttachmentIdArchiveHead: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AttachmentApi()
id = id_example # String | An identifier

try: 
    # Get an attachment archive file.
    api_instance.sec_attachment_id_archive_head(id)
except ApiException as e:
    print("Exception when calling AttachmentApi->secAttachmentIdArchiveHead: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
An identifier
Required

Responses

Status: 200 - Ok

Name Type Format Description
Content-Type String
Content-Length Long int64
ETag String
Content-Disposition String

secAttachmentIdDelete

Delete an attachment.

Deletes a single attachment with all its related data like file, the original file, extracted text, results from analysis etc. If the attachment is part of an archive, the archive is only deleted, if it is the last entry left. Archives are otherwise not deleted, if there are remaining attachments available.


/sec/attachment/{id}

Usage and SDK Samples

curl -X DELETE -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/attachment/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AttachmentApi;

import java.io.File;
import java.util.*;

public class AttachmentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            BasicResult result = apiInstance.secAttachmentIdDelete(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AttachmentApi;

public class AttachmentApiExample {

    public static void main(String[] args) {
        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            BasicResult result = apiInstance.secAttachmentIdDelete(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *id = id_example; // An identifier

AttachmentApi *apiInstance = [[AttachmentApi alloc] init];

// Delete an attachment.
[apiInstance secAttachmentIdDeleteWith:id
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.AttachmentApi()
var id = id_example; // {{String}} An identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secAttachmentIdDelete(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secAttachmentIdDeleteExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new AttachmentApi();
            var id = id_example;  // String | An identifier

            try
            {
                // Delete an attachment.
                BasicResult result = apiInstance.secAttachmentIdDelete(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AttachmentApi.secAttachmentIdDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiAttachmentApi();
$id = id_example; // String | An identifier

try {
    $result = $api_instance->secAttachmentIdDelete($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentApi->secAttachmentIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AttachmentApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AttachmentApi->new();
my $id = id_example; # String | An identifier

eval { 
    my $result = $api_instance->secAttachmentIdDelete(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AttachmentApi->secAttachmentIdDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AttachmentApi()
id = id_example # String | An identifier

try: 
    # Delete an attachment.
    api_response = api_instance.sec_attachment_id_delete(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AttachmentApi->secAttachmentIdDelete: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
An identifier
Required

Responses

Status: 200 - Ok


secAttachmentIdGet

Get an attachment file.

Get the binary file belonging to the attachment with the given id.


/sec/attachment/{id}

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/attachment/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AttachmentApi;

import java.io.File;
import java.util.*;

public class AttachmentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            byte[] result = apiInstance.secAttachmentIdGet(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AttachmentApi;

public class AttachmentApiExample {

    public static void main(String[] args) {
        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            byte[] result = apiInstance.secAttachmentIdGet(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *id = id_example; // An identifier

AttachmentApi *apiInstance = [[AttachmentApi alloc] init];

// Get an attachment file.
[apiInstance secAttachmentIdGetWith:id
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.AttachmentApi()
var id = id_example; // {{String}} An identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secAttachmentIdGet(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secAttachmentIdGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new AttachmentApi();
            var id = id_example;  // String | An identifier

            try
            {
                // Get an attachment file.
                byte[] result = apiInstance.secAttachmentIdGet(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AttachmentApi.secAttachmentIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiAttachmentApi();
$id = id_example; // String | An identifier

try {
    $result = $api_instance->secAttachmentIdGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentApi->secAttachmentIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AttachmentApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AttachmentApi->new();
my $id = id_example; # String | An identifier

eval { 
    my $result = $api_instance->secAttachmentIdGet(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AttachmentApi->secAttachmentIdGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AttachmentApi()
id = id_example # String | An identifier

try: 
    # Get an attachment file.
    api_response = api_instance.sec_attachment_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AttachmentApi->secAttachmentIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
An identifier
Required

Responses

Status: 200 - Ok


secAttachmentIdHead

Get an attachment file.

Get information about the binary file belonging to the attachment with the given id.


/sec/attachment/{id}

Usage and SDK Samples

curl -X HEAD -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/attachment/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AttachmentApi;

import java.io.File;
import java.util.*;

public class AttachmentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            apiInstance.secAttachmentIdHead(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdHead");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AttachmentApi;

public class AttachmentApiExample {

    public static void main(String[] args) {
        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            apiInstance.secAttachmentIdHead(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdHead");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *id = id_example; // An identifier

AttachmentApi *apiInstance = [[AttachmentApi alloc] init];

// Get an attachment file.
[apiInstance secAttachmentIdHeadWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.AttachmentApi()
var id = id_example; // {{String}} An identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.secAttachmentIdHead(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secAttachmentIdHeadExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new AttachmentApi();
            var id = id_example;  // String | An identifier

            try
            {
                // Get an attachment file.
                apiInstance.secAttachmentIdHead(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AttachmentApi.secAttachmentIdHead: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiAttachmentApi();
$id = id_example; // String | An identifier

try {
    $api_instance->secAttachmentIdHead($id);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentApi->secAttachmentIdHead: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AttachmentApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AttachmentApi->new();
my $id = id_example; # String | An identifier

eval { 
    $api_instance->secAttachmentIdHead(id => $id);
};
if ($@) {
    warn "Exception when calling AttachmentApi->secAttachmentIdHead: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AttachmentApi()
id = id_example # String | An identifier

try: 
    # Get an attachment file.
    api_instance.sec_attachment_id_head(id)
except ApiException as e:
    print("Exception when calling AttachmentApi->secAttachmentIdHead: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
An identifier
Required

Responses

Status: 200 - Ok

Name Type Format Description
Content-Type String
Content-Length Long int64
ETag String
Content-Disposition String

secAttachmentIdMetaGet

Get the attachment's meta data.

Get meta data for this attachment. The meta data has been extracted from the contents.


/sec/attachment/{id}/meta

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/attachment/{id}/meta"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AttachmentApi;

import java.io.File;
import java.util.*;

public class AttachmentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            AttachmentMeta result = apiInstance.secAttachmentIdMetaGet(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdMetaGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AttachmentApi;

public class AttachmentApiExample {

    public static void main(String[] args) {
        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            AttachmentMeta result = apiInstance.secAttachmentIdMetaGet(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdMetaGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *id = id_example; // An identifier

AttachmentApi *apiInstance = [[AttachmentApi alloc] init];

// Get the attachment's meta data.
[apiInstance secAttachmentIdMetaGetWith:id
              completionHandler: ^(AttachmentMeta output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.AttachmentApi()
var id = id_example; // {{String}} An identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secAttachmentIdMetaGet(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secAttachmentIdMetaGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new AttachmentApi();
            var id = id_example;  // String | An identifier

            try
            {
                // Get the attachment's meta data.
                AttachmentMeta result = apiInstance.secAttachmentIdMetaGet(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AttachmentApi.secAttachmentIdMetaGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiAttachmentApi();
$id = id_example; // String | An identifier

try {
    $result = $api_instance->secAttachmentIdMetaGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentApi->secAttachmentIdMetaGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AttachmentApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AttachmentApi->new();
my $id = id_example; # String | An identifier

eval { 
    my $result = $api_instance->secAttachmentIdMetaGet(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AttachmentApi->secAttachmentIdMetaGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AttachmentApi()
id = id_example # String | An identifier

try: 
    # Get the attachment's meta data.
    api_response = api_instance.sec_attachment_id_meta_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AttachmentApi->secAttachmentIdMetaGet: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
An identifier
Required

Responses

Status: 200 - Ok


secAttachmentIdNamePost

Changes the name of an attachment

Change the name of the attachment with the given id. The attachment must be part of an item that belongs to the collective of the current user.


/sec/attachment/{id}/name

Usage and SDK Samples

curl -X POST -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/attachment/{id}/name"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AttachmentApi;

import java.io.File;
import java.util.*;

public class AttachmentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        OptionalText body = ; // OptionalText | 
        try {
            BasicResult result = apiInstance.secAttachmentIdNamePost(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdNamePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AttachmentApi;

public class AttachmentApiExample {

    public static void main(String[] args) {
        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        OptionalText body = ; // OptionalText | 
        try {
            BasicResult result = apiInstance.secAttachmentIdNamePost(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdNamePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *id = id_example; // An identifier
OptionalText *body = ; //  (optional)

AttachmentApi *apiInstance = [[AttachmentApi alloc] init];

// Changes the name of an attachment
[apiInstance secAttachmentIdNamePostWith:id
    body:body
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.AttachmentApi()
var id = id_example; // {{String}} An identifier
var opts = { 
  'body':  // {{OptionalText}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secAttachmentIdNamePost(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secAttachmentIdNamePostExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new AttachmentApi();
            var id = id_example;  // String | An identifier
            var body = new OptionalText(); // OptionalText |  (optional) 

            try
            {
                // Changes the name of an attachment
                BasicResult result = apiInstance.secAttachmentIdNamePost(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AttachmentApi.secAttachmentIdNamePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiAttachmentApi();
$id = id_example; // String | An identifier
$body = ; // OptionalText | 

try {
    $result = $api_instance->secAttachmentIdNamePost($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentApi->secAttachmentIdNamePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AttachmentApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AttachmentApi->new();
my $id = id_example; # String | An identifier
my $body = WWW::SwaggerClient::Object::OptionalText->new(); # OptionalText | 

eval { 
    my $result = $api_instance->secAttachmentIdNamePost(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AttachmentApi->secAttachmentIdNamePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AttachmentApi()
id = id_example # String | An identifier
body =  # OptionalText |  (optional)

try: 
    # Changes the name of an attachment
    api_response = api_instance.sec_attachment_id_name_post(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AttachmentApi->secAttachmentIdNamePost: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
An identifier
Required
Body parameters
Name Description
body

Responses

Status: 200 - Ok


secAttachmentIdOriginalGet

Get an attachment file.

Get the original binary file of the attachment with the given id. If the attachment is a converted PDF file, this route gets the original file as it was uploaded.


/sec/attachment/{id}/original

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/attachment/{id}/original"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AttachmentApi;

import java.io.File;
import java.util.*;

public class AttachmentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            byte[] result = apiInstance.secAttachmentIdOriginalGet(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdOriginalGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AttachmentApi;

public class AttachmentApiExample {

    public static void main(String[] args) {
        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            byte[] result = apiInstance.secAttachmentIdOriginalGet(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdOriginalGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *id = id_example; // An identifier

AttachmentApi *apiInstance = [[AttachmentApi alloc] init];

// Get an attachment file.
[apiInstance secAttachmentIdOriginalGetWith:id
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.AttachmentApi()
var id = id_example; // {{String}} An identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secAttachmentIdOriginalGet(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secAttachmentIdOriginalGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new AttachmentApi();
            var id = id_example;  // String | An identifier

            try
            {
                // Get an attachment file.
                byte[] result = apiInstance.secAttachmentIdOriginalGet(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AttachmentApi.secAttachmentIdOriginalGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiAttachmentApi();
$id = id_example; // String | An identifier

try {
    $result = $api_instance->secAttachmentIdOriginalGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentApi->secAttachmentIdOriginalGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AttachmentApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AttachmentApi->new();
my $id = id_example; # String | An identifier

eval { 
    my $result = $api_instance->secAttachmentIdOriginalGet(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AttachmentApi->secAttachmentIdOriginalGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AttachmentApi()
id = id_example # String | An identifier

try: 
    # Get an attachment file.
    api_response = api_instance.sec_attachment_id_original_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AttachmentApi->secAttachmentIdOriginalGet: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
An identifier
Required

Responses

Status: 200 - Ok


secAttachmentIdOriginalHead

Get an attachment file.

Get information about the original binary file of the attachment with the given id. If the attachment is a converted PDF file, this route gets the original file as it was uploaded.


/sec/attachment/{id}/original

Usage and SDK Samples

curl -X HEAD -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/attachment/{id}/original"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AttachmentApi;

import java.io.File;
import java.util.*;

public class AttachmentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            apiInstance.secAttachmentIdOriginalHead(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdOriginalHead");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AttachmentApi;

public class AttachmentApiExample {

    public static void main(String[] args) {
        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            apiInstance.secAttachmentIdOriginalHead(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdOriginalHead");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *id = id_example; // An identifier

AttachmentApi *apiInstance = [[AttachmentApi alloc] init];

// Get an attachment file.
[apiInstance secAttachmentIdOriginalHeadWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.AttachmentApi()
var id = id_example; // {{String}} An identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.secAttachmentIdOriginalHead(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secAttachmentIdOriginalHeadExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new AttachmentApi();
            var id = id_example;  // String | An identifier

            try
            {
                // Get an attachment file.
                apiInstance.secAttachmentIdOriginalHead(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AttachmentApi.secAttachmentIdOriginalHead: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiAttachmentApi();
$id = id_example; // String | An identifier

try {
    $api_instance->secAttachmentIdOriginalHead($id);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentApi->secAttachmentIdOriginalHead: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AttachmentApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AttachmentApi->new();
my $id = id_example; # String | An identifier

eval { 
    $api_instance->secAttachmentIdOriginalHead(id => $id);
};
if ($@) {
    warn "Exception when calling AttachmentApi->secAttachmentIdOriginalHead: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AttachmentApi()
id = id_example # String | An identifier

try: 
    # Get an attachment file.
    api_instance.sec_attachment_id_original_head(id)
except ApiException as e:
    print("Exception when calling AttachmentApi->secAttachmentIdOriginalHead: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
An identifier
Required

Responses

Status: 200 - Ok

Name Type Format Description
Content-Type String
Content-Length Long int64
ETag String
Content-Disposition String

secAttachmentIdViewGet

A preview of the attachment

This provides a preview of the attachment. It currently uses a third-party javascript library (viewerjs) to display the preview. This works by redirecting to the viewerjs url with the attachment url as parameter. Note that the resulting url that is redirected to is not stable. It may change from version to version. This route, however, is meant to provide a stable url for the preview.


/sec/attachment/{id}/view

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/attachment/{id}/view"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AttachmentApi;

import java.io.File;
import java.util.*;

public class AttachmentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            apiInstance.secAttachmentIdViewGet(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdViewGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AttachmentApi;

public class AttachmentApiExample {

    public static void main(String[] args) {
        AttachmentApi apiInstance = new AttachmentApi();
        String id = id_example; // String | An identifier
        try {
            apiInstance.secAttachmentIdViewGet(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#secAttachmentIdViewGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *id = id_example; // An identifier

AttachmentApi *apiInstance = [[AttachmentApi alloc] init];

// A preview of the attachment
[apiInstance secAttachmentIdViewGetWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.AttachmentApi()
var id = id_example; // {{String}} An identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.secAttachmentIdViewGet(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secAttachmentIdViewGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new AttachmentApi();
            var id = id_example;  // String | An identifier

            try
            {
                // A preview of the attachment
                apiInstance.secAttachmentIdViewGet(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AttachmentApi.secAttachmentIdViewGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiAttachmentApi();
$id = id_example; // String | An identifier

try {
    $api_instance->secAttachmentIdViewGet($id);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentApi->secAttachmentIdViewGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AttachmentApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AttachmentApi->new();
my $id = id_example; # String | An identifier

eval { 
    $api_instance->secAttachmentIdViewGet(id => $id);
};
if ($@) {
    warn "Exception when calling AttachmentApi->secAttachmentIdViewGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AttachmentApi()
id = id_example # String | An identifier

try: 
    # A preview of the attachment
    api_instance.sec_attachment_id_view_get(id)
except ApiException as e:
    print("Exception when calling AttachmentApi->secAttachmentIdViewGet: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
An identifier
Required

Responses

Status: 303 - See Other

Status: 200 - Ok


Authentication

openAuthLoginPost

Authenticate with account name and password.

Authenticate with account name and password. The account name is comprised of the collective id and user id separated by slash, backslash or whitespace. If successful, an authentication token is returned that can be used for subsequent calls to protected routes.


/open/auth/login

Usage and SDK Samples

curl -X POST "/api/v1/open/auth/login"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

import java.io.File;
import java.util.*;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        
        AuthenticationApi apiInstance = new AuthenticationApi();
        UserPass body = ; // UserPass | 
        try {
            AuthResult result = apiInstance.openAuthLoginPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#openAuthLoginPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        UserPass body = ; // UserPass | 
        try {
            AuthResult result = apiInstance.openAuthLoginPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#openAuthLoginPost");
            e.printStackTrace();
        }
    }
}
UserPass *body = ; //  (optional)

AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];

// Authenticate with account name and password.
[apiInstance openAuthLoginPostWith:body
              completionHandler: ^(AuthResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');

var api = new Docspell.AuthenticationApi()
var opts = { 
  'body':  // {{UserPass}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.openAuthLoginPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class openAuthLoginPostExample
    {
        public void main()
        {

            var apiInstance = new AuthenticationApi();
            var body = new UserPass(); // UserPass |  (optional) 

            try
            {
                // Authenticate with account name and password.
                AuthResult result = apiInstance.openAuthLoginPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.openAuthLoginPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthenticationApi();
$body = ; // UserPass | 

try {
    $result = $api_instance->openAuthLoginPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->openAuthLoginPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticationApi;

my $api_instance = WWW::SwaggerClient::AuthenticationApi->new();
my $body = WWW::SwaggerClient::Object::UserPass->new(); # UserPass | 

eval { 
    my $result = $api_instance->openAuthLoginPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->openAuthLoginPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()
body =  # UserPass |  (optional)

try: 
    # Authenticate with account name and password.
    api_response = api_instance.open_auth_login_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->openAuthLoginPost: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Ok


secAuthLogoutPost

Logout.

This route informs the server about a logout. This is not strictly necessary.


/sec/auth/logout

Usage and SDK Samples

curl -X POST -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/auth/logout"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

import java.io.File;
import java.util.*;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            apiInstance.secAuthLogoutPost();
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#secAuthLogoutPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            apiInstance.secAuthLogoutPost();
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#secAuthLogoutPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];

AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];

// Logout.
[apiInstance secAuthLogoutPostWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.AuthenticationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.secAuthLogoutPost(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secAuthLogoutPostExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new AuthenticationApi();

            try
            {
                // Logout.
                apiInstance.secAuthLogoutPost();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.secAuthLogoutPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiAuthenticationApi();

try {
    $api_instance->secAuthLogoutPost();
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->secAuthLogoutPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticationApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AuthenticationApi->new();

eval { 
    $api_instance->secAuthLogoutPost();
};
if ($@) {
    warn "Exception when calling AuthenticationApi->secAuthLogoutPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()

try: 
    # Logout.
    api_instance.sec_auth_logout_post()
except ApiException as e:
    print("Exception when calling AuthenticationApi->secAuthLogoutPost: %s\n" % e)

Parameters

Responses

Status: 200 - Ok


secAuthSessionPost

Authentication with a token

Authenticate with a token. This can be used to get a new authentication token based on another valid one.


/sec/auth/session

Usage and SDK Samples

curl -X POST -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/auth/session"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

import java.io.File;
import java.util.*;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            AuthResult result = apiInstance.secAuthSessionPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#secAuthSessionPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            AuthResult result = apiInstance.secAuthSessionPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#secAuthSessionPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];

AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];

// Authentication with a token
[apiInstance secAuthSessionPostWithCompletionHandler: 
              ^(AuthResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.AuthenticationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secAuthSessionPost(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secAuthSessionPostExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new AuthenticationApi();

            try
            {
                // Authentication with a token
                AuthResult result = apiInstance.secAuthSessionPost();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.secAuthSessionPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiAuthenticationApi();

try {
    $result = $api_instance->secAuthSessionPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->secAuthSessionPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticationApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AuthenticationApi->new();

eval { 
    my $result = $api_instance->secAuthSessionPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->secAuthSessionPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()

try: 
    # Authentication with a token
    api_response = api_instance.sec_auth_session_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->secAuthSessionPost: %s\n" % e)

Parameters

Responses

Status: 200 - Ok


Collective

secCollectiveContactsGet

Return a list of contacts.

Return a list of all contacts available from the collectives address book.


/sec/collective/contacts

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/collective/contacts?q=&kind="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectiveApi;

import java.io.File;
import java.util.*;

public class CollectiveApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        CollectiveApi apiInstance = new CollectiveApi();
        String q = q_example; // String | A query string.
        String kind = kind_example; // String | One of the available contact kinds.

        try {
            ContactList result = apiInstance.secCollectiveContactsGet(q, kind);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secCollectiveContactsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectiveApi;

public class CollectiveApiExample {

    public static void main(String[] args) {
        CollectiveApi apiInstance = new CollectiveApi();
        String q = q_example; // String | A query string.
        String kind = kind_example; // String | One of the available contact kinds.

        try {
            ContactList result = apiInstance.secCollectiveContactsGet(q, kind);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secCollectiveContactsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *q = q_example; // A query string. (optional)
String *kind = kind_example; // One of the available contact kinds.
 (optional)

CollectiveApi *apiInstance = [[CollectiveApi alloc] init];

// Return a list of contacts.
[apiInstance secCollectiveContactsGetWith:q
    kind:kind
              completionHandler: ^(ContactList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.CollectiveApi()
var opts = { 
  'q': q_example, // {{String}} A query string.
  'kind': kind_example // {{String}} One of the available contact kinds.

};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secCollectiveContactsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secCollectiveContactsGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new CollectiveApi();
            var q = q_example;  // String | A query string. (optional) 
            var kind = kind_example;  // String | One of the available contact kinds.
 (optional) 

            try
            {
                // Return a list of contacts.
                ContactList result = apiInstance.secCollectiveContactsGet(q, kind);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectiveApi.secCollectiveContactsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectiveApi();
$q = q_example; // String | A query string.
$kind = kind_example; // String | One of the available contact kinds.


try {
    $result = $api_instance->secCollectiveContactsGet($q, $kind);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectiveApi->secCollectiveContactsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectiveApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectiveApi->new();
my $q = q_example; # String | A query string.
my $kind = kind_example; # String | One of the available contact kinds.


eval { 
    my $result = $api_instance->secCollectiveContactsGet(q => $q, kind => $kind);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectiveApi->secCollectiveContactsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CollectiveApi()
q = q_example # String | A query string. (optional)
kind = kind_example # String | One of the available contact kinds.
 (optional)

try: 
    # Return a list of contacts.
    api_response = api_instance.sec_collective_contacts_get(q=q, kind=kind)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectiveApi->secCollectiveContactsGet: %s\n" % e)

Parameters

Query parameters
Name Description
q
String
A query string.
kind
String
One of the available contact kinds.

Responses

Status: 200 - Ok


secCollectiveGet

Get information about your collective

Return some information about the current collective.


/sec/collective

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/collective"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectiveApi;

import java.io.File;
import java.util.*;

public class CollectiveApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        CollectiveApi apiInstance = new CollectiveApi();
        try {
            Collective result = apiInstance.secCollectiveGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secCollectiveGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectiveApi;

public class CollectiveApiExample {

    public static void main(String[] args) {
        CollectiveApi apiInstance = new CollectiveApi();
        try {
            Collective result = apiInstance.secCollectiveGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secCollectiveGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];

CollectiveApi *apiInstance = [[CollectiveApi alloc] init];

// Get information about your collective
[apiInstance secCollectiveGetWithCompletionHandler: 
              ^(Collective output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.CollectiveApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secCollectiveGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secCollectiveGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new CollectiveApi();

            try
            {
                // Get information about your collective
                Collective result = apiInstance.secCollectiveGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectiveApi.secCollectiveGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectiveApi();

try {
    $result = $api_instance->secCollectiveGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectiveApi->secCollectiveGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectiveApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectiveApi->new();

eval { 
    my $result = $api_instance->secCollectiveGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectiveApi->secCollectiveGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CollectiveApi()

try: 
    # Get information about your collective
    api_response = api_instance.sec_collective_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectiveApi->secCollectiveGet: %s\n" % e)

Parameters

Responses

Status: 200 - Ok


secCollectiveInsightsGet

Get some insights regarding your items.

Returns some information about how many items there are, how much space they occupy etc.


/sec/collective/insights

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/collective/insights"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectiveApi;

import java.io.File;
import java.util.*;

public class CollectiveApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        CollectiveApi apiInstance = new CollectiveApi();
        try {
            ItemInsights result = apiInstance.secCollectiveInsightsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secCollectiveInsightsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectiveApi;

public class CollectiveApiExample {

    public static void main(String[] args) {
        CollectiveApi apiInstance = new CollectiveApi();
        try {
            ItemInsights result = apiInstance.secCollectiveInsightsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secCollectiveInsightsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];

CollectiveApi *apiInstance = [[CollectiveApi alloc] init];

// Get some insights regarding your items.
[apiInstance secCollectiveInsightsGetWithCompletionHandler: 
              ^(ItemInsights output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.CollectiveApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secCollectiveInsightsGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secCollectiveInsightsGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new CollectiveApi();

            try
            {
                // Get some insights regarding your items.
                ItemInsights result = apiInstance.secCollectiveInsightsGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectiveApi.secCollectiveInsightsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectiveApi();

try {
    $result = $api_instance->secCollectiveInsightsGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectiveApi->secCollectiveInsightsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectiveApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectiveApi->new();

eval { 
    my $result = $api_instance->secCollectiveInsightsGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectiveApi->secCollectiveInsightsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CollectiveApi()

try: 
    # Get some insights regarding your items.
    api_response = api_instance.sec_collective_insights_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectiveApi->secCollectiveInsightsGet: %s\n" % e)

Parameters

Responses

Status: 200 - Ok


secCollectiveSettingsGet

Get collective settings

Return the settings of a collective.


/sec/collective/settings

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/collective/settings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectiveApi;

import java.io.File;
import java.util.*;

public class CollectiveApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        CollectiveApi apiInstance = new CollectiveApi();
        try {
            CollectiveSettings result = apiInstance.secCollectiveSettingsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secCollectiveSettingsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectiveApi;

public class CollectiveApiExample {

    public static void main(String[] args) {
        CollectiveApi apiInstance = new CollectiveApi();
        try {
            CollectiveSettings result = apiInstance.secCollectiveSettingsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secCollectiveSettingsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];

CollectiveApi *apiInstance = [[CollectiveApi alloc] init];

// Get collective settings
[apiInstance secCollectiveSettingsGetWithCompletionHandler: 
              ^(CollectiveSettings output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.CollectiveApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secCollectiveSettingsGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secCollectiveSettingsGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new CollectiveApi();

            try
            {
                // Get collective settings
                CollectiveSettings result = apiInstance.secCollectiveSettingsGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectiveApi.secCollectiveSettingsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectiveApi();

try {
    $result = $api_instance->secCollectiveSettingsGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectiveApi->secCollectiveSettingsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectiveApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectiveApi->new();

eval { 
    my $result = $api_instance->secCollectiveSettingsGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectiveApi->secCollectiveSettingsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CollectiveApi()

try: 
    # Get collective settings
    api_response = api_instance.sec_collective_settings_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectiveApi->secCollectiveSettingsGet: %s\n" % e)

Parameters

Responses

Status: 200 - Ok


secCollectiveSettingsPost

Update settings for a collective

Updates settings for a collective.


/sec/collective/settings

Usage and SDK Samples

curl -X POST -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/collective/settings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectiveApi;

import java.io.File;
import java.util.*;

public class CollectiveApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        CollectiveApi apiInstance = new CollectiveApi();
        CollectiveSettings body = ; // CollectiveSettings | 
        try {
            Collective result = apiInstance.secCollectiveSettingsPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secCollectiveSettingsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectiveApi;

public class CollectiveApiExample {

    public static void main(String[] args) {
        CollectiveApi apiInstance = new CollectiveApi();
        CollectiveSettings body = ; // CollectiveSettings | 
        try {
            Collective result = apiInstance.secCollectiveSettingsPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secCollectiveSettingsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
CollectiveSettings *body = ; //  (optional)

CollectiveApi *apiInstance = [[CollectiveApi alloc] init];

// Update settings for a collective
[apiInstance secCollectiveSettingsPostWith:body
              completionHandler: ^(Collective output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.CollectiveApi()
var opts = { 
  'body':  // {{CollectiveSettings}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secCollectiveSettingsPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secCollectiveSettingsPostExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new CollectiveApi();
            var body = new CollectiveSettings(); // CollectiveSettings |  (optional) 

            try
            {
                // Update settings for a collective
                Collective result = apiInstance.secCollectiveSettingsPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectiveApi.secCollectiveSettingsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectiveApi();
$body = ; // CollectiveSettings | 

try {
    $result = $api_instance->secCollectiveSettingsPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectiveApi->secCollectiveSettingsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectiveApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectiveApi->new();
my $body = WWW::SwaggerClient::Object::CollectiveSettings->new(); # CollectiveSettings | 

eval { 
    my $result = $api_instance->secCollectiveSettingsPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectiveApi->secCollectiveSettingsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CollectiveApi()
body =  # CollectiveSettings |  (optional)

try: 
    # Update settings for a collective
    api_response = api_instance.sec_collective_settings_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectiveApi->secCollectiveSettingsPost: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Ok


secUserChangePasswordPost

Change the password.

Allows users to change their password.


/sec/user/changePassword

Usage and SDK Samples

curl -X POST -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/user/changePassword"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectiveApi;

import java.io.File;
import java.util.*;

public class CollectiveApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        CollectiveApi apiInstance = new CollectiveApi();
        PasswordChange body = ; // PasswordChange | 
        try {
            BasicResult result = apiInstance.secUserChangePasswordPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secUserChangePasswordPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectiveApi;

public class CollectiveApiExample {

    public static void main(String[] args) {
        CollectiveApi apiInstance = new CollectiveApi();
        PasswordChange body = ; // PasswordChange | 
        try {
            BasicResult result = apiInstance.secUserChangePasswordPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secUserChangePasswordPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
PasswordChange *body = ; //  (optional)

CollectiveApi *apiInstance = [[CollectiveApi alloc] init];

// Change the password.
[apiInstance secUserChangePasswordPostWith:body
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.CollectiveApi()
var opts = { 
  'body':  // {{PasswordChange}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secUserChangePasswordPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secUserChangePasswordPostExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new CollectiveApi();
            var body = new PasswordChange(); // PasswordChange |  (optional) 

            try
            {
                // Change the password.
                BasicResult result = apiInstance.secUserChangePasswordPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectiveApi.secUserChangePasswordPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectiveApi();
$body = ; // PasswordChange | 

try {
    $result = $api_instance->secUserChangePasswordPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectiveApi->secUserChangePasswordPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectiveApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectiveApi->new();
my $body = WWW::SwaggerClient::Object::PasswordChange->new(); # PasswordChange | 

eval { 
    my $result = $api_instance->secUserChangePasswordPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectiveApi->secUserChangePasswordPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CollectiveApi()
body =  # PasswordChange |  (optional)

try: 
    # Change the password.
    api_response = api_instance.sec_user_change_password_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectiveApi->secUserChangePasswordPost: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Ok


secUserGet

Get a list of collective users.

Return a list of all users of the collective.


/sec/user

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/user"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectiveApi;

import java.io.File;
import java.util.*;

public class CollectiveApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        CollectiveApi apiInstance = new CollectiveApi();
        try {
            UserList result = apiInstance.secUserGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secUserGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectiveApi;

public class CollectiveApiExample {

    public static void main(String[] args) {
        CollectiveApi apiInstance = new CollectiveApi();
        try {
            UserList result = apiInstance.secUserGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secUserGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];

CollectiveApi *apiInstance = [[CollectiveApi alloc] init];

// Get a list of collective users.
[apiInstance secUserGetWithCompletionHandler: 
              ^(UserList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.CollectiveApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secUserGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secUserGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new CollectiveApi();

            try
            {
                // Get a list of collective users.
                UserList result = apiInstance.secUserGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectiveApi.secUserGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectiveApi();

try {
    $result = $api_instance->secUserGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectiveApi->secUserGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectiveApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectiveApi->new();

eval { 
    my $result = $api_instance->secUserGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectiveApi->secUserGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CollectiveApi()

try: 
    # Get a list of collective users.
    api_response = api_instance.sec_user_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectiveApi->secUserGet: %s\n" % e)

Parameters

Responses

Status: 200 - Ok


secUserIdDelete

Delete a user.

Deletes a user.


/sec/user/{id}

Usage and SDK Samples

curl -X DELETE -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/user/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectiveApi;

import java.io.File;
import java.util.*;

public class CollectiveApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        CollectiveApi apiInstance = new CollectiveApi();
        String id = id_example; // String | An identifier
        try {
            BasicResult result = apiInstance.secUserIdDelete(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secUserIdDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectiveApi;

public class CollectiveApiExample {

    public static void main(String[] args) {
        CollectiveApi apiInstance = new CollectiveApi();
        String id = id_example; // String | An identifier
        try {
            BasicResult result = apiInstance.secUserIdDelete(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secUserIdDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *id = id_example; // An identifier

CollectiveApi *apiInstance = [[CollectiveApi alloc] init];

// Delete a user.
[apiInstance secUserIdDeleteWith:id
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.CollectiveApi()
var id = id_example; // {{String}} An identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secUserIdDelete(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secUserIdDeleteExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new CollectiveApi();
            var id = id_example;  // String | An identifier

            try
            {
                // Delete a user.
                BasicResult result = apiInstance.secUserIdDelete(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectiveApi.secUserIdDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectiveApi();
$id = id_example; // String | An identifier

try {
    $result = $api_instance->secUserIdDelete($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectiveApi->secUserIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectiveApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectiveApi->new();
my $id = id_example; # String | An identifier

eval { 
    my $result = $api_instance->secUserIdDelete(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectiveApi->secUserIdDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CollectiveApi()
id = id_example # String | An identifier

try: 
    # Delete a user.
    api_response = api_instance.sec_user_id_delete(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectiveApi->secUserIdDelete: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
An identifier
Required

Responses

Status: 200 - Ok


secUserPost

Create a new collective user.

Create a new collective user. If a user with this name already exists, an error is returned.


/sec/user

Usage and SDK Samples

curl -X POST -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/user"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectiveApi;

import java.io.File;
import java.util.*;

public class CollectiveApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        CollectiveApi apiInstance = new CollectiveApi();
        User body = ; // User | 
        try {
            BasicResult result = apiInstance.secUserPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secUserPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectiveApi;

public class CollectiveApiExample {

    public static void main(String[] args) {
        CollectiveApi apiInstance = new CollectiveApi();
        User body = ; // User | 
        try {
            BasicResult result = apiInstance.secUserPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secUserPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
User *body = ; //  (optional)

CollectiveApi *apiInstance = [[CollectiveApi alloc] init];

// Create a new collective user.
[apiInstance secUserPostWith:body
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.CollectiveApi()
var opts = { 
  'body':  // {{User}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secUserPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secUserPostExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new CollectiveApi();
            var body = new User(); // User |  (optional) 

            try
            {
                // Create a new collective user.
                BasicResult result = apiInstance.secUserPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectiveApi.secUserPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectiveApi();
$body = ; // User | 

try {
    $result = $api_instance->secUserPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectiveApi->secUserPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectiveApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectiveApi->new();
my $body = WWW::SwaggerClient::Object::User->new(); # User | 

eval { 
    my $result = $api_instance->secUserPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectiveApi->secUserPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CollectiveApi()
body =  # User |  (optional)

try: 
    # Create a new collective user.
    api_response = api_instance.sec_user_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectiveApi->secUserPost: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Ok


secUserPut

Change an existing user.

Changes an existing user. The user is looked up by its id and all properties are changed as given.


/sec/user

Usage and SDK Samples

curl -X PUT -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/user"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectiveApi;

import java.io.File;
import java.util.*;

public class CollectiveApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        CollectiveApi apiInstance = new CollectiveApi();
        User body = ; // User | 
        try {
            BasicResult result = apiInstance.secUserPut(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secUserPut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectiveApi;

public class CollectiveApiExample {

    public static void main(String[] args) {
        CollectiveApi apiInstance = new CollectiveApi();
        User body = ; // User | 
        try {
            BasicResult result = apiInstance.secUserPut(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectiveApi#secUserPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
User *body = ; //  (optional)

CollectiveApi *apiInstance = [[CollectiveApi alloc] init];

// Change an existing user.
[apiInstance secUserPutWith:body
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.CollectiveApi()
var opts = { 
  'body':  // {{User}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secUserPut(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secUserPutExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new CollectiveApi();
            var body = new User(); // User |  (optional) 

            try
            {
                // Change an existing user.
                BasicResult result = apiInstance.secUserPut(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectiveApi.secUserPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectiveApi();
$body = ; // User | 

try {
    $result = $api_instance->secUserPut($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectiveApi->secUserPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectiveApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectiveApi->new();
my $body = WWW::SwaggerClient::Object::User->new(); # User | 

eval { 
    my $result = $api_instance->secUserPut(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectiveApi->secUserPut: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CollectiveApi()
body =  # User |  (optional)

try: 
    # Change an existing user.
    api_response = api_instance.sec_user_put(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectiveApi->secUserPut: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Ok


EMail

secEmailSendNameIdPost

Send an email.

Sends an email as specified in the body of the request. The item's attachment are added to the mail if requested.


/sec/email/send/{name}/{id}

Usage and SDK Samples

curl -X POST -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/email/send/{name}/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EMailApi;

import java.io.File;
import java.util.*;

public class EMailApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EMailApi apiInstance = new EMailApi();
        String name = name_example; // String | An e-mail connection name
        String id = id_example; // String | An identifier
        SimpleMail body = ; // SimpleMail | 
        try {
            BasicResult result = apiInstance.secEmailSendNameIdPost(name, id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSendNameIdPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EMailApi;

public class EMailApiExample {

    public static void main(String[] args) {
        EMailApi apiInstance = new EMailApi();
        String name = name_example; // String | An e-mail connection name
        String id = id_example; // String | An identifier
        SimpleMail body = ; // SimpleMail | 
        try {
            BasicResult result = apiInstance.secEmailSendNameIdPost(name, id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSendNameIdPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *name = name_example; // An e-mail connection name
String *id = id_example; // An identifier
SimpleMail *body = ; //  (optional)

EMailApi *apiInstance = [[EMailApi alloc] init];

// Send an email.
[apiInstance secEmailSendNameIdPostWith:name
    id:id
    body:body
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EMailApi()
var name = name_example; // {{String}} An e-mail connection name
var id = id_example; // {{String}} An identifier
var opts = { 
  'body':  // {{SimpleMail}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEmailSendNameIdPost(nameid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEmailSendNameIdPostExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EMailApi();
            var name = name_example;  // String | An e-mail connection name
            var id = id_example;  // String | An identifier
            var body = new SimpleMail(); // SimpleMail |  (optional) 

            try
            {
                // Send an email.
                BasicResult result = apiInstance.secEmailSendNameIdPost(name, id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EMailApi.secEmailSendNameIdPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEMailApi();
$name = name_example; // String | An e-mail connection name
$id = id_example; // String | An identifier
$body = ; // SimpleMail | 

try {
    $result = $api_instance->secEmailSendNameIdPost($name, $id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EMailApi->secEmailSendNameIdPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EMailApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EMailApi->new();
my $name = name_example; # String | An e-mail connection name
my $id = id_example; # String | An identifier
my $body = WWW::SwaggerClient::Object::SimpleMail->new(); # SimpleMail | 

eval { 
    my $result = $api_instance->secEmailSendNameIdPost(name => $name, id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EMailApi->secEmailSendNameIdPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EMailApi()
name = name_example # String | An e-mail connection name
id = id_example # String | An identifier
body =  # SimpleMail |  (optional)

try: 
    # Send an email.
    api_response = api_instance.sec_email_send_name_id_post(name, id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EMailApi->secEmailSendNameIdPost: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
An e-mail connection name
Required
id*
String
An identifier
Required
Body parameters
Name Description
body

Responses

Status: 200 - Ok


secEmailSentItemIdGet

Get sent mail related to an item

Return all mails that have been sent related to the item with id `id`.


/sec/email/sent/item/{id}

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/email/sent/item/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EMailApi;

import java.io.File;
import java.util.*;

public class EMailApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EMailApi apiInstance = new EMailApi();
        String id = id_example; // String | An identifier
        try {
            SentMails result = apiInstance.secEmailSentItemIdGet(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSentItemIdGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EMailApi;

public class EMailApiExample {

    public static void main(String[] args) {
        EMailApi apiInstance = new EMailApi();
        String id = id_example; // String | An identifier
        try {
            SentMails result = apiInstance.secEmailSentItemIdGet(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSentItemIdGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *id = id_example; // An identifier

EMailApi *apiInstance = [[EMailApi alloc] init];

// Get sent mail related to an item
[apiInstance secEmailSentItemIdGetWith:id
              completionHandler: ^(SentMails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EMailApi()
var id = id_example; // {{String}} An identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEmailSentItemIdGet(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEmailSentItemIdGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EMailApi();
            var id = id_example;  // String | An identifier

            try
            {
                // Get sent mail related to an item
                SentMails result = apiInstance.secEmailSentItemIdGet(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EMailApi.secEmailSentItemIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEMailApi();
$id = id_example; // String | An identifier

try {
    $result = $api_instance->secEmailSentItemIdGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EMailApi->secEmailSentItemIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EMailApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EMailApi->new();
my $id = id_example; # String | An identifier

eval { 
    my $result = $api_instance->secEmailSentItemIdGet(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EMailApi->secEmailSentItemIdGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EMailApi()
id = id_example # String | An identifier

try: 
    # Get sent mail related to an item
    api_response = api_instance.sec_email_sent_item_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EMailApi->secEmailSentItemIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
An identifier
Required

Responses

Status: 200 - Ok


secEmailSentMailMailIdDelete

Delete a sent mail.

Delete a sent mail.


/sec/email/sent/mail/{mailId}

Usage and SDK Samples

curl -X DELETE -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/email/sent/mail/{mailId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EMailApi;

import java.io.File;
import java.util.*;

public class EMailApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EMailApi apiInstance = new EMailApi();
        String mailId = mailId_example; // String | The id of a sent mail.
        try {
            BasicResult result = apiInstance.secEmailSentMailMailIdDelete(mailId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSentMailMailIdDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EMailApi;

public class EMailApiExample {

    public static void main(String[] args) {
        EMailApi apiInstance = new EMailApi();
        String mailId = mailId_example; // String | The id of a sent mail.
        try {
            BasicResult result = apiInstance.secEmailSentMailMailIdDelete(mailId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSentMailMailIdDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *mailId = mailId_example; // The id of a sent mail.

EMailApi *apiInstance = [[EMailApi alloc] init];

// Delete a sent mail.
[apiInstance secEmailSentMailMailIdDeleteWith:mailId
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EMailApi()
var mailId = mailId_example; // {{String}} The id of a sent mail.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEmailSentMailMailIdDelete(mailId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEmailSentMailMailIdDeleteExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EMailApi();
            var mailId = mailId_example;  // String | The id of a sent mail.

            try
            {
                // Delete a sent mail.
                BasicResult result = apiInstance.secEmailSentMailMailIdDelete(mailId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EMailApi.secEmailSentMailMailIdDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEMailApi();
$mailId = mailId_example; // String | The id of a sent mail.

try {
    $result = $api_instance->secEmailSentMailMailIdDelete($mailId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EMailApi->secEmailSentMailMailIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EMailApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EMailApi->new();
my $mailId = mailId_example; # String | The id of a sent mail.

eval { 
    my $result = $api_instance->secEmailSentMailMailIdDelete(mailId => $mailId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EMailApi->secEmailSentMailMailIdDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EMailApi()
mailId = mailId_example # String | The id of a sent mail.

try: 
    # Delete a sent mail.
    api_response = api_instance.sec_email_sent_mail_mail_id_delete(mailId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EMailApi->secEmailSentMailMailIdDelete: %s\n" % e)

Parameters

Path parameters
Name Description
mailId*
String
The id of a sent mail.
Required

Responses

Status: 200 - Ok


secEmailSentMailMailIdGet

Get sent single mail related to an item

Return one mail with the given id.


/sec/email/sent/mail/{mailId}

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/email/sent/mail/{mailId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EMailApi;

import java.io.File;
import java.util.*;

public class EMailApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EMailApi apiInstance = new EMailApi();
        String mailId = mailId_example; // String | The id of a sent mail.
        try {
            SentMail result = apiInstance.secEmailSentMailMailIdGet(mailId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSentMailMailIdGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EMailApi;

public class EMailApiExample {

    public static void main(String[] args) {
        EMailApi apiInstance = new EMailApi();
        String mailId = mailId_example; // String | The id of a sent mail.
        try {
            SentMail result = apiInstance.secEmailSentMailMailIdGet(mailId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSentMailMailIdGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *mailId = mailId_example; // The id of a sent mail.

EMailApi *apiInstance = [[EMailApi alloc] init];

// Get sent single mail related to an item
[apiInstance secEmailSentMailMailIdGetWith:mailId
              completionHandler: ^(SentMail output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EMailApi()
var mailId = mailId_example; // {{String}} The id of a sent mail.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEmailSentMailMailIdGet(mailId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEmailSentMailMailIdGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EMailApi();
            var mailId = mailId_example;  // String | The id of a sent mail.

            try
            {
                // Get sent single mail related to an item
                SentMail result = apiInstance.secEmailSentMailMailIdGet(mailId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EMailApi.secEmailSentMailMailIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEMailApi();
$mailId = mailId_example; // String | The id of a sent mail.

try {
    $result = $api_instance->secEmailSentMailMailIdGet($mailId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EMailApi->secEmailSentMailMailIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EMailApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EMailApi->new();
my $mailId = mailId_example; # String | The id of a sent mail.

eval { 
    my $result = $api_instance->secEmailSentMailMailIdGet(mailId => $mailId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EMailApi->secEmailSentMailMailIdGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EMailApi()
mailId = mailId_example # String | The id of a sent mail.

try: 
    # Get sent single mail related to an item
    api_response = api_instance.sec_email_sent_mail_mail_id_get(mailId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EMailApi->secEmailSentMailMailIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
mailId*
String
The id of a sent mail.
Required

Responses

Status: 200 - Ok


secEmailSettingsImapGet

List email settings for current user.

List all available e-mail settings for the current user. E-Mail settings specify imap connections that can be used to retrieve e-mails. Multiple e-mail settings can be specified, they are distinguished by their `name`. The query `q` parameter does a simple substring search in the connection name.


/sec/email/settings/imap

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/email/settings/imap?q="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EMailApi;

import java.io.File;
import java.util.*;

public class EMailApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EMailApi apiInstance = new EMailApi();
        String q = q_example; // String | A query string.
        try {
            ImapSettingsList result = apiInstance.secEmailSettingsImapGet(q);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsImapGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EMailApi;

public class EMailApiExample {

    public static void main(String[] args) {
        EMailApi apiInstance = new EMailApi();
        String q = q_example; // String | A query string.
        try {
            ImapSettingsList result = apiInstance.secEmailSettingsImapGet(q);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsImapGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *q = q_example; // A query string. (optional)

EMailApi *apiInstance = [[EMailApi alloc] init];

// List email settings for current user.
[apiInstance secEmailSettingsImapGetWith:q
              completionHandler: ^(ImapSettingsList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EMailApi()
var opts = { 
  'q': q_example // {{String}} A query string.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEmailSettingsImapGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEmailSettingsImapGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EMailApi();
            var q = q_example;  // String | A query string. (optional) 

            try
            {
                // List email settings for current user.
                ImapSettingsList result = apiInstance.secEmailSettingsImapGet(q);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EMailApi.secEmailSettingsImapGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEMailApi();
$q = q_example; // String | A query string.

try {
    $result = $api_instance->secEmailSettingsImapGet($q);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EMailApi->secEmailSettingsImapGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EMailApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EMailApi->new();
my $q = q_example; # String | A query string.

eval { 
    my $result = $api_instance->secEmailSettingsImapGet(q => $q);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EMailApi->secEmailSettingsImapGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EMailApi()
q = q_example # String | A query string. (optional)

try: 
    # List email settings for current user.
    api_response = api_instance.sec_email_settings_imap_get(q=q)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EMailApi->secEmailSettingsImapGet: %s\n" % e)

Parameters

Query parameters
Name Description
q
String
A query string.

Responses

Status: 200 - Ok


secEmailSettingsImapNameDelete

Delete e-mail settings.

Deletes the e-mail settings with the specified `name`.


/sec/email/settings/imap/{name}

Usage and SDK Samples

curl -X DELETE -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/email/settings/imap/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EMailApi;

import java.io.File;
import java.util.*;

public class EMailApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EMailApi apiInstance = new EMailApi();
        String name = name_example; // String | An e-mail connection name
        try {
            BasicResult result = apiInstance.secEmailSettingsImapNameDelete(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsImapNameDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EMailApi;

public class EMailApiExample {

    public static void main(String[] args) {
        EMailApi apiInstance = new EMailApi();
        String name = name_example; // String | An e-mail connection name
        try {
            BasicResult result = apiInstance.secEmailSettingsImapNameDelete(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsImapNameDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *name = name_example; // An e-mail connection name

EMailApi *apiInstance = [[EMailApi alloc] init];

// Delete e-mail settings.
[apiInstance secEmailSettingsImapNameDeleteWith:name
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EMailApi()
var name = name_example; // {{String}} An e-mail connection name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEmailSettingsImapNameDelete(name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEmailSettingsImapNameDeleteExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EMailApi();
            var name = name_example;  // String | An e-mail connection name

            try
            {
                // Delete e-mail settings.
                BasicResult result = apiInstance.secEmailSettingsImapNameDelete(name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EMailApi.secEmailSettingsImapNameDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEMailApi();
$name = name_example; // String | An e-mail connection name

try {
    $result = $api_instance->secEmailSettingsImapNameDelete($name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EMailApi->secEmailSettingsImapNameDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EMailApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EMailApi->new();
my $name = name_example; # String | An e-mail connection name

eval { 
    my $result = $api_instance->secEmailSettingsImapNameDelete(name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EMailApi->secEmailSettingsImapNameDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EMailApi()
name = name_example # String | An e-mail connection name

try: 
    # Delete e-mail settings.
    api_response = api_instance.sec_email_settings_imap_name_delete(name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EMailApi->secEmailSettingsImapNameDelete: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
An e-mail connection name
Required

Responses

Status: 200 - Ok


secEmailSettingsImapNameGet

Return specific email settings by name.

Return the stored e-mail settings for the given connection name.


/sec/email/settings/imap/{name}

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/email/settings/imap/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EMailApi;

import java.io.File;
import java.util.*;

public class EMailApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EMailApi apiInstance = new EMailApi();
        String name = name_example; // String | An e-mail connection name
        try {
            ImapSettings result = apiInstance.secEmailSettingsImapNameGet(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsImapNameGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EMailApi;

public class EMailApiExample {

    public static void main(String[] args) {
        EMailApi apiInstance = new EMailApi();
        String name = name_example; // String | An e-mail connection name
        try {
            ImapSettings result = apiInstance.secEmailSettingsImapNameGet(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsImapNameGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *name = name_example; // An e-mail connection name

EMailApi *apiInstance = [[EMailApi alloc] init];

// Return specific email settings by name.
[apiInstance secEmailSettingsImapNameGetWith:name
              completionHandler: ^(ImapSettings output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EMailApi()
var name = name_example; // {{String}} An e-mail connection name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEmailSettingsImapNameGet(name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEmailSettingsImapNameGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EMailApi();
            var name = name_example;  // String | An e-mail connection name

            try
            {
                // Return specific email settings by name.
                ImapSettings result = apiInstance.secEmailSettingsImapNameGet(name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EMailApi.secEmailSettingsImapNameGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEMailApi();
$name = name_example; // String | An e-mail connection name

try {
    $result = $api_instance->secEmailSettingsImapNameGet($name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EMailApi->secEmailSettingsImapNameGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EMailApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EMailApi->new();
my $name = name_example; # String | An e-mail connection name

eval { 
    my $result = $api_instance->secEmailSettingsImapNameGet(name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EMailApi->secEmailSettingsImapNameGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EMailApi()
name = name_example # String | An e-mail connection name

try: 
    # Return specific email settings by name.
    api_response = api_instance.sec_email_settings_imap_name_get(name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EMailApi->secEmailSettingsImapNameGet: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
An e-mail connection name
Required

Responses

Status: 200 - Ok


secEmailSettingsImapNamePut

Change specific email settings.

Changes all settings for the connection with the given `name`.


/sec/email/settings/imap/{name}

Usage and SDK Samples

curl -X PUT -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/email/settings/imap/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EMailApi;

import java.io.File;
import java.util.*;

public class EMailApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EMailApi apiInstance = new EMailApi();
        String name = name_example; // String | An e-mail connection name
        ImapSettings body = ; // ImapSettings | 
        try {
            BasicResult result = apiInstance.secEmailSettingsImapNamePut(name, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsImapNamePut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EMailApi;

public class EMailApiExample {

    public static void main(String[] args) {
        EMailApi apiInstance = new EMailApi();
        String name = name_example; // String | An e-mail connection name
        ImapSettings body = ; // ImapSettings | 
        try {
            BasicResult result = apiInstance.secEmailSettingsImapNamePut(name, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsImapNamePut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *name = name_example; // An e-mail connection name
ImapSettings *body = ; //  (optional)

EMailApi *apiInstance = [[EMailApi alloc] init];

// Change specific email settings.
[apiInstance secEmailSettingsImapNamePutWith:name
    body:body
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EMailApi()
var name = name_example; // {{String}} An e-mail connection name
var opts = { 
  'body':  // {{ImapSettings}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEmailSettingsImapNamePut(name, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEmailSettingsImapNamePutExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EMailApi();
            var name = name_example;  // String | An e-mail connection name
            var body = new ImapSettings(); // ImapSettings |  (optional) 

            try
            {
                // Change specific email settings.
                BasicResult result = apiInstance.secEmailSettingsImapNamePut(name, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EMailApi.secEmailSettingsImapNamePut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEMailApi();
$name = name_example; // String | An e-mail connection name
$body = ; // ImapSettings | 

try {
    $result = $api_instance->secEmailSettingsImapNamePut($name, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EMailApi->secEmailSettingsImapNamePut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EMailApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EMailApi->new();
my $name = name_example; # String | An e-mail connection name
my $body = WWW::SwaggerClient::Object::ImapSettings->new(); # ImapSettings | 

eval { 
    my $result = $api_instance->secEmailSettingsImapNamePut(name => $name, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EMailApi->secEmailSettingsImapNamePut: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EMailApi()
name = name_example # String | An e-mail connection name
body =  # ImapSettings |  (optional)

try: 
    # Change specific email settings.
    api_response = api_instance.sec_email_settings_imap_name_put(name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EMailApi->secEmailSettingsImapNamePut: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
An e-mail connection name
Required
Body parameters
Name Description
body

Responses

Status: 200 - Ok


secEmailSettingsImapPost

Create new email settings

Create new e-mail settings.


/sec/email/settings/imap

Usage and SDK Samples

curl -X POST -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/email/settings/imap"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EMailApi;

import java.io.File;
import java.util.*;

public class EMailApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EMailApi apiInstance = new EMailApi();
        ImapSettings body = ; // ImapSettings | 
        try {
            BasicResult result = apiInstance.secEmailSettingsImapPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsImapPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EMailApi;

public class EMailApiExample {

    public static void main(String[] args) {
        EMailApi apiInstance = new EMailApi();
        ImapSettings body = ; // ImapSettings | 
        try {
            BasicResult result = apiInstance.secEmailSettingsImapPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsImapPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
ImapSettings *body = ; //  (optional)

EMailApi *apiInstance = [[EMailApi alloc] init];

// Create new email settings
[apiInstance secEmailSettingsImapPostWith:body
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EMailApi()
var opts = { 
  'body':  // {{ImapSettings}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEmailSettingsImapPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEmailSettingsImapPostExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EMailApi();
            var body = new ImapSettings(); // ImapSettings |  (optional) 

            try
            {
                // Create new email settings
                BasicResult result = apiInstance.secEmailSettingsImapPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EMailApi.secEmailSettingsImapPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEMailApi();
$body = ; // ImapSettings | 

try {
    $result = $api_instance->secEmailSettingsImapPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EMailApi->secEmailSettingsImapPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EMailApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EMailApi->new();
my $body = WWW::SwaggerClient::Object::ImapSettings->new(); # ImapSettings | 

eval { 
    my $result = $api_instance->secEmailSettingsImapPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EMailApi->secEmailSettingsImapPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EMailApi()
body =  # ImapSettings |  (optional)

try: 
    # Create new email settings
    api_response = api_instance.sec_email_settings_imap_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EMailApi->secEmailSettingsImapPost: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Ok


secEmailSettingsSmtpGet

List email settings for current user.

List all available e-mail settings for the current user. E-Mail settings specify smtp connections that can be used to sent e-mails. Multiple e-mail settings can be specified, they are distinguished by their `name`. The query `q` parameter does a simple substring search in the connection name.


/sec/email/settings/smtp

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/email/settings/smtp?q="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EMailApi;

import java.io.File;
import java.util.*;

public class EMailApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EMailApi apiInstance = new EMailApi();
        String q = q_example; // String | A query string.
        try {
            EmailSettingsList result = apiInstance.secEmailSettingsSmtpGet(q);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsSmtpGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EMailApi;

public class EMailApiExample {

    public static void main(String[] args) {
        EMailApi apiInstance = new EMailApi();
        String q = q_example; // String | A query string.
        try {
            EmailSettingsList result = apiInstance.secEmailSettingsSmtpGet(q);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsSmtpGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *q = q_example; // A query string. (optional)

EMailApi *apiInstance = [[EMailApi alloc] init];

// List email settings for current user.
[apiInstance secEmailSettingsSmtpGetWith:q
              completionHandler: ^(EmailSettingsList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EMailApi()
var opts = { 
  'q': q_example // {{String}} A query string.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEmailSettingsSmtpGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEmailSettingsSmtpGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EMailApi();
            var q = q_example;  // String | A query string. (optional) 

            try
            {
                // List email settings for current user.
                EmailSettingsList result = apiInstance.secEmailSettingsSmtpGet(q);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EMailApi.secEmailSettingsSmtpGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEMailApi();
$q = q_example; // String | A query string.

try {
    $result = $api_instance->secEmailSettingsSmtpGet($q);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EMailApi->secEmailSettingsSmtpGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EMailApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EMailApi->new();
my $q = q_example; # String | A query string.

eval { 
    my $result = $api_instance->secEmailSettingsSmtpGet(q => $q);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EMailApi->secEmailSettingsSmtpGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EMailApi()
q = q_example # String | A query string. (optional)

try: 
    # List email settings for current user.
    api_response = api_instance.sec_email_settings_smtp_get(q=q)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EMailApi->secEmailSettingsSmtpGet: %s\n" % e)

Parameters

Query parameters
Name Description
q
String
A query string.

Responses

Status: 200 - Ok


secEmailSettingsSmtpNameDelete

Delete e-mail settings.

Deletes the e-mail settings with the specified `name`.


/sec/email/settings/smtp/{name}

Usage and SDK Samples

curl -X DELETE -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/email/settings/smtp/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EMailApi;

import java.io.File;
import java.util.*;

public class EMailApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EMailApi apiInstance = new EMailApi();
        String name = name_example; // String | An e-mail connection name
        try {
            BasicResult result = apiInstance.secEmailSettingsSmtpNameDelete(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsSmtpNameDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EMailApi;

public class EMailApiExample {

    public static void main(String[] args) {
        EMailApi apiInstance = new EMailApi();
        String name = name_example; // String | An e-mail connection name
        try {
            BasicResult result = apiInstance.secEmailSettingsSmtpNameDelete(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsSmtpNameDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *name = name_example; // An e-mail connection name

EMailApi *apiInstance = [[EMailApi alloc] init];

// Delete e-mail settings.
[apiInstance secEmailSettingsSmtpNameDeleteWith:name
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EMailApi()
var name = name_example; // {{String}} An e-mail connection name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEmailSettingsSmtpNameDelete(name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEmailSettingsSmtpNameDeleteExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EMailApi();
            var name = name_example;  // String | An e-mail connection name

            try
            {
                // Delete e-mail settings.
                BasicResult result = apiInstance.secEmailSettingsSmtpNameDelete(name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EMailApi.secEmailSettingsSmtpNameDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEMailApi();
$name = name_example; // String | An e-mail connection name

try {
    $result = $api_instance->secEmailSettingsSmtpNameDelete($name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EMailApi->secEmailSettingsSmtpNameDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EMailApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EMailApi->new();
my $name = name_example; # String | An e-mail connection name

eval { 
    my $result = $api_instance->secEmailSettingsSmtpNameDelete(name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EMailApi->secEmailSettingsSmtpNameDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EMailApi()
name = name_example # String | An e-mail connection name

try: 
    # Delete e-mail settings.
    api_response = api_instance.sec_email_settings_smtp_name_delete(name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EMailApi->secEmailSettingsSmtpNameDelete: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
An e-mail connection name
Required

Responses

Status: 200 - Ok


secEmailSettingsSmtpNameGet

Return specific email settings by name.

Return the stored e-mail settings for the given connection name.


/sec/email/settings/smtp/{name}

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/email/settings/smtp/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EMailApi;

import java.io.File;
import java.util.*;

public class EMailApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EMailApi apiInstance = new EMailApi();
        String name = name_example; // String | An e-mail connection name
        try {
            EmailSettings result = apiInstance.secEmailSettingsSmtpNameGet(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsSmtpNameGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EMailApi;

public class EMailApiExample {

    public static void main(String[] args) {
        EMailApi apiInstance = new EMailApi();
        String name = name_example; // String | An e-mail connection name
        try {
            EmailSettings result = apiInstance.secEmailSettingsSmtpNameGet(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsSmtpNameGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *name = name_example; // An e-mail connection name

EMailApi *apiInstance = [[EMailApi alloc] init];

// Return specific email settings by name.
[apiInstance secEmailSettingsSmtpNameGetWith:name
              completionHandler: ^(EmailSettings output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EMailApi()
var name = name_example; // {{String}} An e-mail connection name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEmailSettingsSmtpNameGet(name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEmailSettingsSmtpNameGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EMailApi();
            var name = name_example;  // String | An e-mail connection name

            try
            {
                // Return specific email settings by name.
                EmailSettings result = apiInstance.secEmailSettingsSmtpNameGet(name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EMailApi.secEmailSettingsSmtpNameGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEMailApi();
$name = name_example; // String | An e-mail connection name

try {
    $result = $api_instance->secEmailSettingsSmtpNameGet($name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EMailApi->secEmailSettingsSmtpNameGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EMailApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EMailApi->new();
my $name = name_example; # String | An e-mail connection name

eval { 
    my $result = $api_instance->secEmailSettingsSmtpNameGet(name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EMailApi->secEmailSettingsSmtpNameGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EMailApi()
name = name_example # String | An e-mail connection name

try: 
    # Return specific email settings by name.
    api_response = api_instance.sec_email_settings_smtp_name_get(name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EMailApi->secEmailSettingsSmtpNameGet: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
An e-mail connection name
Required

Responses

Status: 200 - Ok


secEmailSettingsSmtpNamePut

Change specific email settings.

Changes all settings for the connection with the given `name`.


/sec/email/settings/smtp/{name}

Usage and SDK Samples

curl -X PUT -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/email/settings/smtp/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EMailApi;

import java.io.File;
import java.util.*;

public class EMailApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EMailApi apiInstance = new EMailApi();
        String name = name_example; // String | An e-mail connection name
        EmailSettings body = ; // EmailSettings | 
        try {
            BasicResult result = apiInstance.secEmailSettingsSmtpNamePut(name, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsSmtpNamePut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EMailApi;

public class EMailApiExample {

    public static void main(String[] args) {
        EMailApi apiInstance = new EMailApi();
        String name = name_example; // String | An e-mail connection name
        EmailSettings body = ; // EmailSettings | 
        try {
            BasicResult result = apiInstance.secEmailSettingsSmtpNamePut(name, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsSmtpNamePut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *name = name_example; // An e-mail connection name
EmailSettings *body = ; //  (optional)

EMailApi *apiInstance = [[EMailApi alloc] init];

// Change specific email settings.
[apiInstance secEmailSettingsSmtpNamePutWith:name
    body:body
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EMailApi()
var name = name_example; // {{String}} An e-mail connection name
var opts = { 
  'body':  // {{EmailSettings}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEmailSettingsSmtpNamePut(name, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEmailSettingsSmtpNamePutExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EMailApi();
            var name = name_example;  // String | An e-mail connection name
            var body = new EmailSettings(); // EmailSettings |  (optional) 

            try
            {
                // Change specific email settings.
                BasicResult result = apiInstance.secEmailSettingsSmtpNamePut(name, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EMailApi.secEmailSettingsSmtpNamePut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEMailApi();
$name = name_example; // String | An e-mail connection name
$body = ; // EmailSettings | 

try {
    $result = $api_instance->secEmailSettingsSmtpNamePut($name, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EMailApi->secEmailSettingsSmtpNamePut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EMailApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EMailApi->new();
my $name = name_example; # String | An e-mail connection name
my $body = WWW::SwaggerClient::Object::EmailSettings->new(); # EmailSettings | 

eval { 
    my $result = $api_instance->secEmailSettingsSmtpNamePut(name => $name, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EMailApi->secEmailSettingsSmtpNamePut: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EMailApi()
name = name_example # String | An e-mail connection name
body =  # EmailSettings |  (optional)

try: 
    # Change specific email settings.
    api_response = api_instance.sec_email_settings_smtp_name_put(name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EMailApi->secEmailSettingsSmtpNamePut: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
An e-mail connection name
Required
Body parameters
Name Description
body

Responses

Status: 200 - Ok


secEmailSettingsSmtpPost

Create new email settings

Create new e-mail settings.


/sec/email/settings/smtp

Usage and SDK Samples

curl -X POST -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/email/settings/smtp"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EMailApi;

import java.io.File;
import java.util.*;

public class EMailApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EMailApi apiInstance = new EMailApi();
        EmailSettings body = ; // EmailSettings | 
        try {
            BasicResult result = apiInstance.secEmailSettingsSmtpPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsSmtpPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EMailApi;

public class EMailApiExample {

    public static void main(String[] args) {
        EMailApi apiInstance = new EMailApi();
        EmailSettings body = ; // EmailSettings | 
        try {
            BasicResult result = apiInstance.secEmailSettingsSmtpPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EMailApi#secEmailSettingsSmtpPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
EmailSettings *body = ; //  (optional)

EMailApi *apiInstance = [[EMailApi alloc] init];

// Create new email settings
[apiInstance secEmailSettingsSmtpPostWith:body
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EMailApi()
var opts = { 
  'body':  // {{EmailSettings}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEmailSettingsSmtpPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEmailSettingsSmtpPostExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EMailApi();
            var body = new EmailSettings(); // EmailSettings |  (optional) 

            try
            {
                // Create new email settings
                BasicResult result = apiInstance.secEmailSettingsSmtpPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EMailApi.secEmailSettingsSmtpPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEMailApi();
$body = ; // EmailSettings | 

try {
    $result = $api_instance->secEmailSettingsSmtpPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EMailApi->secEmailSettingsSmtpPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EMailApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EMailApi->new();
my $body = WWW::SwaggerClient::Object::EmailSettings->new(); # EmailSettings | 

eval { 
    my $result = $api_instance->secEmailSettingsSmtpPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EMailApi->secEmailSettingsSmtpPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EMailApi()
body =  # EmailSettings |  (optional)

try: 
    # Create new email settings
    api_response = api_instance.sec_email_settings_smtp_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EMailApi->secEmailSettingsSmtpPost: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Ok


Equipment

secEquipmentGet

Get a list of equipments

Return a list of all configured equipments.


/sec/equipment

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/equipment?q="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EquipmentApi;

import java.io.File;
import java.util.*;

public class EquipmentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EquipmentApi apiInstance = new EquipmentApi();
        String q = q_example; // String | A query string.
        try {
            EquipmentList result = apiInstance.secEquipmentGet(q);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EquipmentApi#secEquipmentGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EquipmentApi;

public class EquipmentApiExample {

    public static void main(String[] args) {
        EquipmentApi apiInstance = new EquipmentApi();
        String q = q_example; // String | A query string.
        try {
            EquipmentList result = apiInstance.secEquipmentGet(q);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EquipmentApi#secEquipmentGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *q = q_example; // A query string. (optional)

EquipmentApi *apiInstance = [[EquipmentApi alloc] init];

// Get a list of equipments
[apiInstance secEquipmentGetWith:q
              completionHandler: ^(EquipmentList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EquipmentApi()
var opts = { 
  'q': q_example // {{String}} A query string.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEquipmentGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEquipmentGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EquipmentApi();
            var q = q_example;  // String | A query string. (optional) 

            try
            {
                // Get a list of equipments
                EquipmentList result = apiInstance.secEquipmentGet(q);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EquipmentApi.secEquipmentGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEquipmentApi();
$q = q_example; // String | A query string.

try {
    $result = $api_instance->secEquipmentGet($q);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EquipmentApi->secEquipmentGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EquipmentApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EquipmentApi->new();
my $q = q_example; # String | A query string.

eval { 
    my $result = $api_instance->secEquipmentGet(q => $q);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EquipmentApi->secEquipmentGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EquipmentApi()
q = q_example # String | A query string. (optional)

try: 
    # Get a list of equipments
    api_response = api_instance.sec_equipment_get(q=q)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EquipmentApi->secEquipmentGet: %s\n" % e)

Parameters

Query parameters
Name Description
q
String
A query string.

Responses

Status: 200 - Ok


secEquipmentIdDelete

Delete a equipment.

Deletes a equipment. This also removes this equipments from all items.


/sec/equipment/{id}

Usage and SDK Samples

curl -X DELETE -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/equipment/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EquipmentApi;

import java.io.File;
import java.util.*;

public class EquipmentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EquipmentApi apiInstance = new EquipmentApi();
        String id = id_example; // String | An identifier
        try {
            BasicResult result = apiInstance.secEquipmentIdDelete(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EquipmentApi#secEquipmentIdDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EquipmentApi;

public class EquipmentApiExample {

    public static void main(String[] args) {
        EquipmentApi apiInstance = new EquipmentApi();
        String id = id_example; // String | An identifier
        try {
            BasicResult result = apiInstance.secEquipmentIdDelete(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EquipmentApi#secEquipmentIdDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *id = id_example; // An identifier

EquipmentApi *apiInstance = [[EquipmentApi alloc] init];

// Delete a equipment.
[apiInstance secEquipmentIdDeleteWith:id
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EquipmentApi()
var id = id_example; // {{String}} An identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEquipmentIdDelete(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEquipmentIdDeleteExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EquipmentApi();
            var id = id_example;  // String | An identifier

            try
            {
                // Delete a equipment.
                BasicResult result = apiInstance.secEquipmentIdDelete(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EquipmentApi.secEquipmentIdDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEquipmentApi();
$id = id_example; // String | An identifier

try {
    $result = $api_instance->secEquipmentIdDelete($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EquipmentApi->secEquipmentIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EquipmentApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EquipmentApi->new();
my $id = id_example; # String | An identifier

eval { 
    my $result = $api_instance->secEquipmentIdDelete(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EquipmentApi->secEquipmentIdDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EquipmentApi()
id = id_example # String | An identifier

try: 
    # Delete a equipment.
    api_response = api_instance.sec_equipment_id_delete(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EquipmentApi->secEquipmentIdDelete: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
An identifier
Required

Responses

Status: 200 - Ok


secEquipmentPost

Create a new equipment.

Create a new equipment. If a equipment with this name already exists, an error is returned.


/sec/equipment

Usage and SDK Samples

curl -X POST -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/equipment"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EquipmentApi;

import java.io.File;
import java.util.*;

public class EquipmentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EquipmentApi apiInstance = new EquipmentApi();
        Equipment body = ; // Equipment | 
        try {
            BasicResult result = apiInstance.secEquipmentPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EquipmentApi#secEquipmentPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EquipmentApi;

public class EquipmentApiExample {

    public static void main(String[] args) {
        EquipmentApi apiInstance = new EquipmentApi();
        Equipment body = ; // Equipment | 
        try {
            BasicResult result = apiInstance.secEquipmentPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EquipmentApi#secEquipmentPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
Equipment *body = ; //  (optional)

EquipmentApi *apiInstance = [[EquipmentApi alloc] init];

// Create a new equipment.
[apiInstance secEquipmentPostWith:body
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EquipmentApi()
var opts = { 
  'body':  // {{Equipment}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEquipmentPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEquipmentPostExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EquipmentApi();
            var body = new Equipment(); // Equipment |  (optional) 

            try
            {
                // Create a new equipment.
                BasicResult result = apiInstance.secEquipmentPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EquipmentApi.secEquipmentPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEquipmentApi();
$body = ; // Equipment | 

try {
    $result = $api_instance->secEquipmentPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EquipmentApi->secEquipmentPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EquipmentApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EquipmentApi->new();
my $body = WWW::SwaggerClient::Object::Equipment->new(); # Equipment | 

eval { 
    my $result = $api_instance->secEquipmentPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EquipmentApi->secEquipmentPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EquipmentApi()
body =  # Equipment |  (optional)

try: 
    # Create a new equipment.
    api_response = api_instance.sec_equipment_post(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EquipmentApi->secEquipmentPost: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Ok


secEquipmentPut

Change an existing equipment.

Changes an existing equipment. The equipment is looked up by its id and all properties are changed as given.


/sec/equipment

Usage and SDK Samples

curl -X PUT -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/sec/equipment"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EquipmentApi;

import java.io.File;
import java.util.*;

public class EquipmentApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        EquipmentApi apiInstance = new EquipmentApi();
        Equipment body = ; // Equipment | 
        try {
            BasicResult result = apiInstance.secEquipmentPut(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EquipmentApi#secEquipmentPut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EquipmentApi;

public class EquipmentApiExample {

    public static void main(String[] args) {
        EquipmentApi apiInstance = new EquipmentApi();
        Equipment body = ; // Equipment | 
        try {
            BasicResult result = apiInstance.secEquipmentPut(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EquipmentApi#secEquipmentPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
Equipment *body = ; //  (optional)

EquipmentApi *apiInstance = [[EquipmentApi alloc] init];

// Change an existing equipment.
[apiInstance secEquipmentPutWith:body
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.EquipmentApi()
var opts = { 
  'body':  // {{Equipment}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secEquipmentPut(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secEquipmentPutExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new EquipmentApi();
            var body = new Equipment(); // Equipment |  (optional) 

            try
            {
                // Change an existing equipment.
                BasicResult result = apiInstance.secEquipmentPut(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EquipmentApi.secEquipmentPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiEquipmentApi();
$body = ; // Equipment | 

try {
    $result = $api_instance->secEquipmentPut($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EquipmentApi->secEquipmentPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EquipmentApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EquipmentApi->new();
my $body = WWW::SwaggerClient::Object::Equipment->new(); # Equipment | 

eval { 
    my $result = $api_instance->secEquipmentPut(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EquipmentApi->secEquipmentPut: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EquipmentApi()
body =  # Equipment |  (optional)

try: 
    # Change an existing equipment.
    api_response = api_instance.sec_equipment_put(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EquipmentApi->secEquipmentPut: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Ok


FullTextIndex

openFtsReIndexAllIdPost

Re-creates the full-text index.

Clears the full-text index and inserts all data from the database. This migh take a while to complete. The response returns immediately. A task is submitted that will be executed by a job executor. Note that this affects all data of all collectives. The `id` is required and refers to the key given in the config file to ensure that only admins can call this route.


/open/fts/reIndexAll/{id}

Usage and SDK Samples

curl -X POST "/api/v1/open/fts/reIndexAll/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FullTextIndexApi;

import java.io.File;
import java.util.*;

public class FullTextIndexApiExample {

    public static void main(String[] args) {
        
        FullTextIndexApi apiInstance = new FullTextIndexApi();
        String id = id_example; // String | An identifier
        try {
            BasicResult result = apiInstance.openFtsReIndexAllIdPost(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FullTextIndexApi#openFtsReIndexAllIdPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FullTextIndexApi;

public class FullTextIndexApiExample {

    public static void main(String[] args) {
        FullTextIndexApi apiInstance = new FullTextIndexApi();
        String id = id_example; // String | An identifier
        try {
            BasicResult result = apiInstance.openFtsReIndexAllIdPost(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FullTextIndexApi#openFtsReIndexAllIdPost");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // An identifier

FullTextIndexApi *apiInstance = [[FullTextIndexApi alloc] init];

// Re-creates the full-text index.
[apiInstance openFtsReIndexAllIdPostWith:id
              completionHandler: ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');

var api = new Docspell.FullTextIndexApi()
var id = id_example; // {{String}} An identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.openFtsReIndexAllIdPost(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class openFtsReIndexAllIdPostExample
    {
        public void main()
        {

            var apiInstance = new FullTextIndexApi();
            var id = id_example;  // String | An identifier

            try
            {
                // Re-creates the full-text index.
                BasicResult result = apiInstance.openFtsReIndexAllIdPost(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FullTextIndexApi.openFtsReIndexAllIdPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiFullTextIndexApi();
$id = id_example; // String | An identifier

try {
    $result = $api_instance->openFtsReIndexAllIdPost($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FullTextIndexApi->openFtsReIndexAllIdPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FullTextIndexApi;

my $api_instance = WWW::SwaggerClient::FullTextIndexApi->new();
my $id = id_example; # String | An identifier

eval { 
    my $result = $api_instance->openFtsReIndexAllIdPost(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FullTextIndexApi->openFtsReIndexAllIdPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FullTextIndexApi()
id = id_example # String | An identifier

try: 
    # Re-creates the full-text index.
    api_response = api_instance.open_fts_re_index_all_id_post(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FullTextIndexApi->openFtsReIndexAllIdPost: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
An identifier
Required

Responses

Status: 200 - Ok


secFtsReIndexPost

Re-creates the full-text index for the current collective

Clears the full-text index for all data belonging to the current collective and inserts the data from the database. The response is immediately returned and a task is submitted that will be executed by a job executor.


/sec/fts/reIndex

Usage and SDK Samples

curl -X POST "/api/v1/sec/fts/reIndex"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FullTextIndexApi;

import java.io.File;
import java.util.*;

public class FullTextIndexApiExample {

    public static void main(String[] args) {
        
        FullTextIndexApi apiInstance = new FullTextIndexApi();
        try {
            BasicResult result = apiInstance.secFtsReIndexPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FullTextIndexApi#secFtsReIndexPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FullTextIndexApi;

public class FullTextIndexApiExample {

    public static void main(String[] args) {
        FullTextIndexApi apiInstance = new FullTextIndexApi();
        try {
            BasicResult result = apiInstance.secFtsReIndexPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FullTextIndexApi#secFtsReIndexPost");
            e.printStackTrace();
        }
    }
}

FullTextIndexApi *apiInstance = [[FullTextIndexApi alloc] init];

// Re-creates the full-text index for the current collective
[apiInstance secFtsReIndexPostWithCompletionHandler: 
              ^(BasicResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');

var api = new Docspell.FullTextIndexApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.secFtsReIndexPost(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class secFtsReIndexPostExample
    {
        public void main()
        {

            var apiInstance = new FullTextIndexApi();

            try
            {
                // Re-creates the full-text index for the current collective
                BasicResult result = apiInstance.secFtsReIndexPost();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FullTextIndexApi.secFtsReIndexPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiFullTextIndexApi();

try {
    $result = $api_instance->secFtsReIndexPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FullTextIndexApi->secFtsReIndexPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FullTextIndexApi;

my $api_instance = WWW::SwaggerClient::FullTextIndexApi->new();

eval { 
    my $result = $api_instance->secFtsReIndexPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FullTextIndexApi->secFtsReIndexPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FullTextIndexApi()

try: 
    # Re-creates the full-text index for the current collective
    api_response = api_instance.sec_fts_re_index_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FullTextIndexApi->secFtsReIndexPost: %s\n" % e)

Parameters

Responses

Status: 200 - Ok


Information

apiInfoVersionGet

Get version information.

Returns information about this software.


/api/info/version

Usage and SDK Samples

curl -X GET "/api/v1/api/info/version"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InformationApi;

import java.io.File;
import java.util.*;

public class InformationApiExample {

    public static void main(String[] args) {
        
        InformationApi apiInstance = new InformationApi();
        try {
            VersionInfo result = apiInstance.apiInfoVersionGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InformationApi#apiInfoVersionGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InformationApi;

public class InformationApiExample {

    public static void main(String[] args) {
        InformationApi apiInstance = new InformationApi();
        try {
            VersionInfo result = apiInstance.apiInfoVersionGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InformationApi#apiInfoVersionGet");
            e.printStackTrace();
        }
    }
}

InformationApi *apiInstance = [[InformationApi alloc] init];

// Get version information.
[apiInstance apiInfoVersionGetWithCompletionHandler: 
              ^(VersionInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');

var api = new Docspell.InformationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiInfoVersionGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class apiInfoVersionGetExample
    {
        public void main()
        {

            var apiInstance = new InformationApi();

            try
            {
                // Get version information.
                VersionInfo result = apiInstance.apiInfoVersionGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InformationApi.apiInfoVersionGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiInformationApi();

try {
    $result = $api_instance->apiInfoVersionGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InformationApi->apiInfoVersionGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InformationApi;

my $api_instance = WWW::SwaggerClient::InformationApi->new();

eval { 
    my $result = $api_instance->apiInfoVersionGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InformationApi->apiInfoVersionGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InformationApi()

try: 
    # Get version information.
    api_response = api_instance.api_info_version_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InformationApi->apiInfoVersionGet: %s\n" % e)

Parameters

Responses

Status: 200 - Ok


IntegrationEndpoint

openIntegrationCheckfileIdChecksumGet

Check if a file is in docspell.

Checks if a file with the given SHA-256 checksum is in docspell. The `id` is the *collective name*. This route only exists, if it is enabled in the configuration file. The result shows all items that contains a file with the given checksum.


/open/integration/checkfile/{id}/{checksum}

Usage and SDK Samples

curl -X GET -H "X-Docspell-Auth: [[apiKey]]" "/api/v1/open/integration/checkfile/{id}/{checksum}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IntegrationEndpointApi;

import java.io.File;
import java.util.*;

public class IntegrationEndpointApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: authTokenHeader
        ApiKeyAuth authTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("authTokenHeader");
        authTokenHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //authTokenHeader.setApiKeyPrefix("Token");

        IntegrationEndpointApi apiInstance = new IntegrationEndpointApi();
        String id = id_example; // String | An identifier
        String checksum = checksum_example; // String | A SHA-256 checksum
        try {
            CheckFileResult result = apiInstance.openIntegrationCheckfileIdChecksumGet(id, checksum);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationEndpointApi#openIntegrationCheckfileIdChecksumGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IntegrationEndpointApi;

public class IntegrationEndpointApiExample {

    public static void main(String[] args) {
        IntegrationEndpointApi apiInstance = new IntegrationEndpointApi();
        String id = id_example; // String | An identifier
        String checksum = checksum_example; // String | A SHA-256 checksum
        try {
            CheckFileResult result = apiInstance.openIntegrationCheckfileIdChecksumGet(id, checksum);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationEndpointApi#openIntegrationCheckfileIdChecksumGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: authTokenHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Docspell-Auth"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Docspell-Auth"];
String *id = id_example; // An identifier
String *checksum = checksum_example; // A SHA-256 checksum

IntegrationEndpointApi *apiInstance = [[IntegrationEndpointApi alloc] init];

// Check if a file is in docspell.
[apiInstance openIntegrationCheckfileIdChecksumGetWith:id
    checksum:checksum
              completionHandler: ^(CheckFileResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Docspell = require('docspell');
var defaultClient = Docspell.ApiClient.instance;

// Configure API key authorization: authTokenHeader
var authTokenHeader = defaultClient.authentications['authTokenHeader'];
authTokenHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authTokenHeader.apiKeyPrefix['X-Docspell-Auth'] = "Token"

var api = new Docspell.IntegrationEndpointApi()
var id = id_example; // {{String}} An identifier
var checksum = checksum_example; // {{String}} A SHA-256 checksum

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.openIntegrationCheckfileIdChecksumGet(id, checksum, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class openIntegrationCheckfileIdChecksumGetExample
    {
        public void main()
        {

            // Configure API key authorization: authTokenHeader
            Configuration.Default.ApiKey.Add("X-Docspell-Auth", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Docspell-Auth", "Bearer");

            var apiInstance = new IntegrationEndpointApi();
            var id = id_example;  // String | An identifier
            var checksum = checksum_example;  // String | A SHA-256 checksum

            try
            {
                // Check if a file is in docspell.
                CheckFileResult result = apiInstance.openIntegrationCheckfileIdChecksumGet(id, checksum);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IntegrationEndpointApi.openIntegrationCheckfileIdChecksumGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: authTokenHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Docspell-Auth', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Docspell-Auth', 'Bearer');

$api_instance = new Swagger\Client\ApiIntegrationEndpointApi();
$id = id_example; // String | An identifier
$checksum = checksum_example; // String | A SHA-256 checksum

try {
    $result = $api_instance->openIntegrationCheckfileIdChecksumGet($id, $checksum);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationEndpointApi->openIntegrationCheckfileIdChecksumGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IntegrationEndpointApi;

# Configure API key authorization: authTokenHeader
$WWW::SwaggerClient::Configuration::api_key->{'X-Docspell-Auth'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Docspell-Auth'} = "Bearer";

my $api_instance = WWW::SwaggerClient::IntegrationEndpointApi->new();
my $id = id_example; # String | An identifier
my $checksum = checksum_example; # String | A SHA-256 checksum

eval { 
    my $result = $api_instance->openIntegrationCheckfileIdChecksumGet(id => $id, checksum => $checksum);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IntegrationEndpointApi->openIntegrationCheckfileIdChecksumGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: authTokenHeader
swagger_client.configuration.api_key['X-Docspell-Auth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Docspell-Auth'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.IntegrationEndpointApi()
id = id_example # String | An identifier
checksum = checksum_example # String | A SHA-256 checksum

try: 
    # Check if a file is in docspell.
    api_response = api_instance.open_integration_checkfile_id_checksum_get(id, checksum)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationEndpointApi->openIntegrationCheckfileIdChecksumGet: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
An identifier
Required
checksum*