DOCBOX® API

Archive

archivestructure

Archive structure

Retrieves the folder structure of the DOCBOX®.


/archivestructure

Usage and SDK Samples

curl -X GET \
-H "Cloud-ID: [[apiKey]]" \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://localhost:8081/api/v2/archivestructure?parent-folder-id=56&lazy=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArchiveApi;

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

public class ArchiveApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cloudId
        ApiKeyAuth cloudId = (ApiKeyAuth) defaultClient.getAuthentication("cloudId");
        cloudId.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cloudId.setApiKeyPrefix("Token");
        
        // Configure API key authorization: apiKeyAuth
        ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
        apiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ArchiveApi apiInstance = new ArchiveApi();
        Integer parentFolderId = 56; // Integer | Parent folder id. If omitted the whole archive is returned.
        Boolean lazy = true; // Boolean | 

        try {
            docboxArchive result = apiInstance.archivestructure(parentFolderId, lazy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArchiveApi#archivestructure");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ArchiveApi;

public class ArchiveApiExample {
    public static void main(String[] args) {
        ArchiveApi apiInstance = new ArchiveApi();
        Integer parentFolderId = 56; // Integer | Parent folder id. If omitted the whole archive is returned.
        Boolean lazy = true; // Boolean | 

        try {
            docboxArchive result = apiInstance.archivestructure(parentFolderId, lazy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArchiveApi#archivestructure");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: cloudId)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Cloud-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Cloud-ID"];

// Configure API key authorization: (authentication scheme: apiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"API-Key"];


// Create an instance of the API class
ArchiveApi *apiInstance = [[ArchiveApi alloc] init];
Integer *parentFolderId = 56; // Parent folder id. If omitted the whole archive is returned. (optional) (default to null)
Boolean *lazy = true; //  (optional) (default to false)

// Archive structure
[apiInstance archivestructureWith:parentFolderId
    lazy:lazy
              completionHandler: ^(docboxArchive output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var DocboxApi = require('docbox_api');
var defaultClient = DocboxApi.ApiClient.instance;

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

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

// Create an instance of the API class
var api = new DocboxApi.ArchiveApi()
var opts = {
  'parentFolderId': 56, // {Integer} Parent folder id. If omitted the whole archive is returned.
  'lazy': true // {Boolean} 
};

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

namespace Example
{
    public class archivestructureExample
    {
        public void main()
        {
            // Configure API key authorization: cloudId
            Configuration.Default.ApiKey.Add("Cloud-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Cloud-ID", "Bearer");
            // Configure API key authorization: apiKeyAuth
            Configuration.Default.ApiKey.Add("API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ArchiveApi();
            var parentFolderId = 56;  // Integer | Parent folder id. If omitted the whole archive is returned. (optional)  (default to null)
            var lazy = true;  // Boolean |  (optional)  (default to false)

            try {
                // Archive structure
                docboxArchive result = apiInstance.archivestructure(parentFolderId, lazy);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArchiveApi.archivestructure: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cloudId
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Cloud-ID', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cloud-ID', 'Bearer');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArchiveApi();
$parentFolderId = 56; // Integer | Parent folder id. If omitted the whole archive is returned.
$lazy = true; // Boolean | 

try {
    $result = $api_instance->archivestructure($parentFolderId, $lazy);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArchiveApi->archivestructure: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArchiveApi;

# Configure API key authorization: cloudId
$WWW::OPenAPIClient::Configuration::api_key->{'Cloud-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Cloud-ID'} = "Bearer";

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArchiveApi->new();
my $parentFolderId = 56; # Integer | Parent folder id. If omitted the whole archive is returned.
my $lazy = true; # Boolean | 

eval {
    my $result = $api_instance->archivestructure(parentFolderId => $parentFolderId, lazy => $lazy);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArchiveApi->archivestructure: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: cloudId
openapi_client.configuration.api_key['Cloud-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Cloud-ID'] = 'Bearer'

# Configure API key authorization: apiKeyAuth
openapi_client.configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ArchiveApi()
parentFolderId = 56 # Integer | Parent folder id. If omitted the whole archive is returned. (optional) (default to null)
lazy = true # Boolean |  (optional) (default to false)

try:
    # Archive structure
    api_response = api_instance.archivestructure(parentFolderId=parentFolderId, lazy=lazy)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArchiveApi->archivestructure: %s\n" % e)
extern crate ArchiveApi;

pub fn main() {
    let parentFolderId = 56; // Integer
    let lazy = true; // Boolean

    let mut context = ArchiveApi::Context::default();
    let result = client.archivestructure(parentFolderId, lazy, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
parent-folder-id
Integer
Parent folder id. If omitted the whole archive is returned.
lazy
Boolean

Responses


Document

documentArchive

Archives a INBOX-document


/document/{id}/archive

Usage and SDK Samples

curl -X POST \
-H "Cloud-ID: [[apiKey]]" \
-H "API-Key: [[apiKey]]" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 "https://localhost:8081/api/v2/document/{id}/archive"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocumentApi;

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

public class DocumentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cloudId
        ApiKeyAuth cloudId = (ApiKeyAuth) defaultClient.getAuthentication("cloudId");
        cloudId.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cloudId.setApiKeyPrefix("Token");
        
        // Configure API key authorization: apiKeyAuth
        ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
        apiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DocumentApi apiInstance = new DocumentApi();
        Long id = 789; // Long | Document id
        Long targetFolderId = 789; // Long | Id of the target folder. Either this or `target-folder-path` is required.
        String targetMandatorName = targetMandatorName_example; // String | Name of the mandator where the document should be archived
        String targetFolderPath = targetFolderPath_example; // String | Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/"
        String targetDocumentName = targetDocumentName_example; // String | Name of the new created archive-document. If not present, the current name of the document is used.
        String keywords = keywords_example; // String | Comma separated list of keywords, which get added to the document.

        try {
            apiInstance.documentArchive(id, targetFolderId, targetMandatorName, targetFolderPath, targetDocumentName, keywords);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentArchive");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocumentApi;

public class DocumentApiExample {
    public static void main(String[] args) {
        DocumentApi apiInstance = new DocumentApi();
        Long id = 789; // Long | Document id
        Long targetFolderId = 789; // Long | Id of the target folder. Either this or `target-folder-path` is required.
        String targetMandatorName = targetMandatorName_example; // String | Name of the mandator where the document should be archived
        String targetFolderPath = targetFolderPath_example; // String | Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/"
        String targetDocumentName = targetDocumentName_example; // String | Name of the new created archive-document. If not present, the current name of the document is used.
        String keywords = keywords_example; // String | Comma separated list of keywords, which get added to the document.

        try {
            apiInstance.documentArchive(id, targetFolderId, targetMandatorName, targetFolderPath, targetDocumentName, keywords);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: cloudId)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Cloud-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Cloud-ID"];

// Configure API key authorization: (authentication scheme: apiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"API-Key"];


// Create an instance of the API class
DocumentApi *apiInstance = [[DocumentApi alloc] init];
Long *id = 789; // Document id (default to null)
Long *targetFolderId = 789; // Id of the target folder. Either this or `target-folder-path` is required. (optional) (default to null)
String *targetMandatorName = targetMandatorName_example; // Name of the mandator where the document should be archived (optional) (default to null)
String *targetFolderPath = targetFolderPath_example; // Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/" (optional) (default to null)
String *targetDocumentName = targetDocumentName_example; // Name of the new created archive-document. If not present, the current name of the document is used. (optional) (default to null)
String *keywords = keywords_example; // Comma separated list of keywords, which get added to the document. (optional) (default to null)

// Archives a INBOX-document
[apiInstance documentArchiveWith:id
    targetFolderId:targetFolderId
    targetMandatorName:targetMandatorName
    targetFolderPath:targetFolderPath
    targetDocumentName:targetDocumentName
    keywords:keywords
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var DocboxApi = require('docbox_api');
var defaultClient = DocboxApi.ApiClient.instance;

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

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

// Create an instance of the API class
var api = new DocboxApi.DocumentApi()
var id = 789; // {Long} Document id
var opts = {
  'targetFolderId': 789, // {Long} Id of the target folder. Either this or `target-folder-path` is required.
  'targetMandatorName': targetMandatorName_example, // {String} Name of the mandator where the document should be archived
  'targetFolderPath': targetFolderPath_example, // {String} Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/"
  'targetDocumentName': targetDocumentName_example, // {String} Name of the new created archive-document. If not present, the current name of the document is used.
  'keywords': keywords_example // {String} Comma separated list of keywords, which get added to the document.
};

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

namespace Example
{
    public class documentArchiveExample
    {
        public void main()
        {
            // Configure API key authorization: cloudId
            Configuration.Default.ApiKey.Add("Cloud-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Cloud-ID", "Bearer");
            // Configure API key authorization: apiKeyAuth
            Configuration.Default.ApiKey.Add("API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DocumentApi();
            var id = 789;  // Long | Document id (default to null)
            var targetFolderId = 789;  // Long | Id of the target folder. Either this or `target-folder-path` is required. (optional)  (default to null)
            var targetMandatorName = targetMandatorName_example;  // String | Name of the mandator where the document should be archived (optional)  (default to null)
            var targetFolderPath = targetFolderPath_example;  // String | Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/" (optional)  (default to null)
            var targetDocumentName = targetDocumentName_example;  // String | Name of the new created archive-document. If not present, the current name of the document is used. (optional)  (default to null)
            var keywords = keywords_example;  // String | Comma separated list of keywords, which get added to the document. (optional)  (default to null)

            try {
                // Archives a INBOX-document
                apiInstance.documentArchive(id, targetFolderId, targetMandatorName, targetFolderPath, targetDocumentName, keywords);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocumentApi.documentArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cloudId
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Cloud-ID', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cloud-ID', 'Bearer');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocumentApi();
$id = 789; // Long | Document id
$targetFolderId = 789; // Long | Id of the target folder. Either this or `target-folder-path` is required.
$targetMandatorName = targetMandatorName_example; // String | Name of the mandator where the document should be archived
$targetFolderPath = targetFolderPath_example; // String | Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/"
$targetDocumentName = targetDocumentName_example; // String | Name of the new created archive-document. If not present, the current name of the document is used.
$keywords = keywords_example; // String | Comma separated list of keywords, which get added to the document.

try {
    $api_instance->documentArchive($id, $targetFolderId, $targetMandatorName, $targetFolderPath, $targetDocumentName, $keywords);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->documentArchive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DocumentApi;

# Configure API key authorization: cloudId
$WWW::OPenAPIClient::Configuration::api_key->{'Cloud-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Cloud-ID'} = "Bearer";

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocumentApi->new();
my $id = 789; # Long | Document id
my $targetFolderId = 789; # Long | Id of the target folder. Either this or `target-folder-path` is required.
my $targetMandatorName = targetMandatorName_example; # String | Name of the mandator where the document should be archived
my $targetFolderPath = targetFolderPath_example; # String | Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/"
my $targetDocumentName = targetDocumentName_example; # String | Name of the new created archive-document. If not present, the current name of the document is used.
my $keywords = keywords_example; # String | Comma separated list of keywords, which get added to the document.

eval {
    $api_instance->documentArchive(id => $id, targetFolderId => $targetFolderId, targetMandatorName => $targetMandatorName, targetFolderPath => $targetFolderPath, targetDocumentName => $targetDocumentName, keywords => $keywords);
};
if ($@) {
    warn "Exception when calling DocumentApi->documentArchive: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: cloudId
openapi_client.configuration.api_key['Cloud-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Cloud-ID'] = 'Bearer'

# Configure API key authorization: apiKeyAuth
openapi_client.configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DocumentApi()
id = 789 # Long | Document id (default to null)
targetFolderId = 789 # Long | Id of the target folder. Either this or `target-folder-path` is required. (optional) (default to null)
targetMandatorName = targetMandatorName_example # String | Name of the mandator where the document should be archived (optional) (default to null)
targetFolderPath = targetFolderPath_example # String | Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/" (optional) (default to null)
targetDocumentName = targetDocumentName_example # String | Name of the new created archive-document. If not present, the current name of the document is used. (optional) (default to null)
keywords = keywords_example # String | Comma separated list of keywords, which get added to the document. (optional) (default to null)

try:
    # Archives a INBOX-document
    api_instance.document_archive(id, targetFolderId=targetFolderId, targetMandatorName=targetMandatorName, targetFolderPath=targetFolderPath, targetDocumentName=targetDocumentName, keywords=keywords)
except ApiException as e:
    print("Exception when calling DocumentApi->documentArchive: %s\n" % e)
extern crate DocumentApi;

pub fn main() {
    let id = 789; // Long
    let targetFolderId = 789; // Long
    let targetMandatorName = targetMandatorName_example; // String
    let targetFolderPath = targetFolderPath_example; // String
    let targetDocumentName = targetDocumentName_example; // String
    let keywords = keywords_example; // String

    let mut context = DocumentApi::Context::default();
    let result = client.documentArchive(id, targetFolderId, targetMandatorName, targetFolderPath, targetDocumentName, keywords, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Document id
Required
Form parameters
Name Description
target-folder-id
Long (int64)
Id of the target folder. Either this or `target-folder-path` is required.
target-mandator-name
String
Name of the mandator where the document should be archived
target-folder-path
String
Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/"
target-document-name
String
Name of the new created archive-document. If not present, the current name of the document is used.
keywords
String
Comma separated list of keywords, which get added to the document.

Responses


documentAutoExportStatus

Set auto export status

Sets the auto export status for a document.


/document/auto_export_status/set

Usage and SDK Samples

curl -X POST \
-H "Cloud-ID: [[apiKey]]" \
-H "API-Key: [[apiKey]]" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 "https://localhost:8081/api/v2/document/auto_export_status/set"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocumentApi;

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

public class DocumentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cloudId
        ApiKeyAuth cloudId = (ApiKeyAuth) defaultClient.getAuthentication("cloudId");
        cloudId.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cloudId.setApiKeyPrefix("Token");
        
        // Configure API key authorization: apiKeyAuth
        ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
        apiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DocumentApi apiInstance = new DocumentApi();
        Long documentId = 789; // Long | 
        Boolean autoexportStatus = true; // Boolean | 

        try {
            apiInstance.documentAutoExportStatus(documentId, autoexportStatus);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentAutoExportStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocumentApi;

public class DocumentApiExample {
    public static void main(String[] args) {
        DocumentApi apiInstance = new DocumentApi();
        Long documentId = 789; // Long | 
        Boolean autoexportStatus = true; // Boolean | 

        try {
            apiInstance.documentAutoExportStatus(documentId, autoexportStatus);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentAutoExportStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: cloudId)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Cloud-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Cloud-ID"];

// Configure API key authorization: (authentication scheme: apiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"API-Key"];


// Create an instance of the API class
DocumentApi *apiInstance = [[DocumentApi alloc] init];
Long *documentId = 789; //  (default to null)
Boolean *autoexportStatus = true; //  (default to null)

// Set auto export status
[apiInstance documentAutoExportStatusWith:documentId
    autoexportStatus:autoexportStatus
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var DocboxApi = require('docbox_api');
var defaultClient = DocboxApi.ApiClient.instance;

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

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

// Create an instance of the API class
var api = new DocboxApi.DocumentApi()
var documentId = 789; // {Long} 
var autoexportStatus = true; // {Boolean} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.documentAutoExportStatus(documentId, autoexportStatus, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class documentAutoExportStatusExample
    {
        public void main()
        {
            // Configure API key authorization: cloudId
            Configuration.Default.ApiKey.Add("Cloud-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Cloud-ID", "Bearer");
            // Configure API key authorization: apiKeyAuth
            Configuration.Default.ApiKey.Add("API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DocumentApi();
            var documentId = 789;  // Long |  (default to null)
            var autoexportStatus = true;  // Boolean |  (default to null)

            try {
                // Set auto export status
                apiInstance.documentAutoExportStatus(documentId, autoexportStatus);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocumentApi.documentAutoExportStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cloudId
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Cloud-ID', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cloud-ID', 'Bearer');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocumentApi();
$documentId = 789; // Long | 
$autoexportStatus = true; // Boolean | 

try {
    $api_instance->documentAutoExportStatus($documentId, $autoexportStatus);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->documentAutoExportStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DocumentApi;

# Configure API key authorization: cloudId
$WWW::OPenAPIClient::Configuration::api_key->{'Cloud-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Cloud-ID'} = "Bearer";

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocumentApi->new();
my $documentId = 789; # Long | 
my $autoexportStatus = true; # Boolean | 

eval {
    $api_instance->documentAutoExportStatus(documentId => $documentId, autoexportStatus => $autoexportStatus);
};
if ($@) {
    warn "Exception when calling DocumentApi->documentAutoExportStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: cloudId
openapi_client.configuration.api_key['Cloud-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Cloud-ID'] = 'Bearer'

# Configure API key authorization: apiKeyAuth
openapi_client.configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DocumentApi()
documentId = 789 # Long |  (default to null)
autoexportStatus = true # Boolean |  (default to null)

try:
    # Set auto export status
    api_instance.document_auto_export_status(documentId, autoexportStatus)
except ApiException as e:
    print("Exception when calling DocumentApi->documentAutoExportStatus: %s\n" % e)
extern crate DocumentApi;

pub fn main() {
    let documentId = 789; // Long
    let autoexportStatus = true; // Boolean

    let mut context = DocumentApi::Context::default();
    let result = client.documentAutoExportStatus(documentId, autoexportStatus, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Form parameters
Name Description
document-id*
Long (int64)
Required
autoexport-status*
Boolean
Required

Responses


documentData

Returns data of a document. e.g. pages and annotations


/document/{id}/data

Usage and SDK Samples

curl -X GET \
-H "Cloud-ID: [[apiKey]]" \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://localhost:8081/api/v2/document/{id}/data"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocumentApi;

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

public class DocumentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cloudId
        ApiKeyAuth cloudId = (ApiKeyAuth) defaultClient.getAuthentication("cloudId");
        cloudId.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cloudId.setApiKeyPrefix("Token");
        
        // Configure API key authorization: apiKeyAuth
        ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
        apiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DocumentApi apiInstance = new DocumentApi();
        Long id = 789; // Long | Document id

        try {
            extendedDocument result = apiInstance.documentData(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocumentApi;

public class DocumentApiExample {
    public static void main(String[] args) {
        DocumentApi apiInstance = new DocumentApi();
        Long id = 789; // Long | Document id

        try {
            extendedDocument result = apiInstance.documentData(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: cloudId)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Cloud-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Cloud-ID"];

// Configure API key authorization: (authentication scheme: apiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"API-Key"];


// Create an instance of the API class
DocumentApi *apiInstance = [[DocumentApi alloc] init];
Long *id = 789; // Document id (default to null)

[apiInstance documentDataWith:id
              completionHandler: ^(extendedDocument output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var DocboxApi = require('docbox_api');
var defaultClient = DocboxApi.ApiClient.instance;

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

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

// Create an instance of the API class
var api = new DocboxApi.DocumentApi()
var id = 789; // {Long} Document id

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

namespace Example
{
    public class documentDataExample
    {
        public void main()
        {
            // Configure API key authorization: cloudId
            Configuration.Default.ApiKey.Add("Cloud-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Cloud-ID", "Bearer");
            // Configure API key authorization: apiKeyAuth
            Configuration.Default.ApiKey.Add("API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DocumentApi();
            var id = 789;  // Long | Document id (default to null)

            try {
                extendedDocument result = apiInstance.documentData(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocumentApi.documentData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cloudId
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Cloud-ID', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cloud-ID', 'Bearer');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocumentApi();
$id = 789; // Long | Document id

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

# Configure API key authorization: cloudId
$WWW::OPenAPIClient::Configuration::api_key->{'Cloud-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Cloud-ID'} = "Bearer";

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocumentApi->new();
my $id = 789; # Long | Document id

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

# Configure API key authorization: cloudId
openapi_client.configuration.api_key['Cloud-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Cloud-ID'] = 'Bearer'

# Configure API key authorization: apiKeyAuth
openapi_client.configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DocumentApi()
id = 789 # Long | Document id (default to null)

try:
    api_response = api_instance.document_data(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentApi->documentData: %s\n" % e)
extern crate DocumentApi;

pub fn main() {
    let id = 789; // Long

    let mut context = DocumentApi::Context::default();
    let result = client.documentData(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Document id
Required

Responses


documentList

Document list

Lists the documents within a specific folder.


/document/list

Usage and SDK Samples

curl -X GET \
-H "Cloud-ID: [[apiKey]]" \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://localhost:8081/api/v2/document/list?folder-id=56&included-metadata-keys=includedMetadataKeys_example&excluded-matadata-keys=excludedMatadataKeys_example&with-autoexport-status=true&filter-date-created-after=2013-10-20&subfolders-recursive=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocumentApi;

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

public class DocumentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cloudId
        ApiKeyAuth cloudId = (ApiKeyAuth) defaultClient.getAuthentication("cloudId");
        cloudId.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cloudId.setApiKeyPrefix("Token");
        
        // Configure API key authorization: apiKeyAuth
        ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
        apiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DocumentApi apiInstance = new DocumentApi();
        Integer folderId = 56; // Integer | 
        String includedMetadataKeys = includedMetadataKeys_example; // String | 
        String excludedMatadataKeys = excludedMatadataKeys_example; // String | 
        Boolean withAutoexportStatus = true; // Boolean | 
        date filterDateCreatedAfter = 2013-10-20; // date | 
        Boolean subfoldersRecursive = true; // Boolean | 

        try {
            array[document] result = apiInstance.documentList(folderId, includedMetadataKeys, excludedMatadataKeys, withAutoexportStatus, filterDateCreatedAfter, subfoldersRecursive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocumentApi;

public class DocumentApiExample {
    public static void main(String[] args) {
        DocumentApi apiInstance = new DocumentApi();
        Integer folderId = 56; // Integer | 
        String includedMetadataKeys = includedMetadataKeys_example; // String | 
        String excludedMatadataKeys = excludedMatadataKeys_example; // String | 
        Boolean withAutoexportStatus = true; // Boolean | 
        date filterDateCreatedAfter = 2013-10-20; // date | 
        Boolean subfoldersRecursive = true; // Boolean | 

        try {
            array[document] result = apiInstance.documentList(folderId, includedMetadataKeys, excludedMatadataKeys, withAutoexportStatus, filterDateCreatedAfter, subfoldersRecursive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: cloudId)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Cloud-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Cloud-ID"];

// Configure API key authorization: (authentication scheme: apiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"API-Key"];


// Create an instance of the API class
DocumentApi *apiInstance = [[DocumentApi alloc] init];
Integer *folderId = 56; //  (default to null)
String *includedMetadataKeys = includedMetadataKeys_example; //  (optional) (default to null)
String *excludedMatadataKeys = excludedMatadataKeys_example; //  (optional) (default to null)
Boolean *withAutoexportStatus = true; //  (optional) (default to null)
date *filterDateCreatedAfter = 2013-10-20; //  (optional) (default to null)
Boolean *subfoldersRecursive = true; //  (optional) (default to false)

// Document list
[apiInstance documentListWith:folderId
    includedMetadataKeys:includedMetadataKeys
    excludedMatadataKeys:excludedMatadataKeys
    withAutoexportStatus:withAutoexportStatus
    filterDateCreatedAfter:filterDateCreatedAfter
    subfoldersRecursive:subfoldersRecursive
              completionHandler: ^(array[document] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var DocboxApi = require('docbox_api');
var defaultClient = DocboxApi.ApiClient.instance;

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

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

// Create an instance of the API class
var api = new DocboxApi.DocumentApi()
var folderId = 56; // {Integer} 
var opts = {
  'includedMetadataKeys': includedMetadataKeys_example, // {String} 
  'excludedMatadataKeys': excludedMatadataKeys_example, // {String} 
  'withAutoexportStatus': true, // {Boolean} 
  'filterDateCreatedAfter': 2013-10-20, // {date} 
  'subfoldersRecursive': true // {Boolean} 
};

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

namespace Example
{
    public class documentListExample
    {
        public void main()
        {
            // Configure API key authorization: cloudId
            Configuration.Default.ApiKey.Add("Cloud-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Cloud-ID", "Bearer");
            // Configure API key authorization: apiKeyAuth
            Configuration.Default.ApiKey.Add("API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DocumentApi();
            var folderId = 56;  // Integer |  (default to null)
            var includedMetadataKeys = includedMetadataKeys_example;  // String |  (optional)  (default to null)
            var excludedMatadataKeys = excludedMatadataKeys_example;  // String |  (optional)  (default to null)
            var withAutoexportStatus = true;  // Boolean |  (optional)  (default to null)
            var filterDateCreatedAfter = 2013-10-20;  // date |  (optional)  (default to null)
            var subfoldersRecursive = true;  // Boolean |  (optional)  (default to false)

            try {
                // Document list
                array[document] result = apiInstance.documentList(folderId, includedMetadataKeys, excludedMatadataKeys, withAutoexportStatus, filterDateCreatedAfter, subfoldersRecursive);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocumentApi.documentList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cloudId
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Cloud-ID', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cloud-ID', 'Bearer');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocumentApi();
$folderId = 56; // Integer | 
$includedMetadataKeys = includedMetadataKeys_example; // String | 
$excludedMatadataKeys = excludedMatadataKeys_example; // String | 
$withAutoexportStatus = true; // Boolean | 
$filterDateCreatedAfter = 2013-10-20; // date | 
$subfoldersRecursive = true; // Boolean | 

try {
    $result = $api_instance->documentList($folderId, $includedMetadataKeys, $excludedMatadataKeys, $withAutoexportStatus, $filterDateCreatedAfter, $subfoldersRecursive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->documentList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DocumentApi;

# Configure API key authorization: cloudId
$WWW::OPenAPIClient::Configuration::api_key->{'Cloud-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Cloud-ID'} = "Bearer";

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocumentApi->new();
my $folderId = 56; # Integer | 
my $includedMetadataKeys = includedMetadataKeys_example; # String | 
my $excludedMatadataKeys = excludedMatadataKeys_example; # String | 
my $withAutoexportStatus = true; # Boolean | 
my $filterDateCreatedAfter = 2013-10-20; # date | 
my $subfoldersRecursive = true; # Boolean | 

eval {
    my $result = $api_instance->documentList(folderId => $folderId, includedMetadataKeys => $includedMetadataKeys, excludedMatadataKeys => $excludedMatadataKeys, withAutoexportStatus => $withAutoexportStatus, filterDateCreatedAfter => $filterDateCreatedAfter, subfoldersRecursive => $subfoldersRecursive);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentApi->documentList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: cloudId
openapi_client.configuration.api_key['Cloud-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Cloud-ID'] = 'Bearer'

# Configure API key authorization: apiKeyAuth
openapi_client.configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DocumentApi()
folderId = 56 # Integer |  (default to null)
includedMetadataKeys = includedMetadataKeys_example # String |  (optional) (default to null)
excludedMatadataKeys = excludedMatadataKeys_example # String |  (optional) (default to null)
withAutoexportStatus = true # Boolean |  (optional) (default to null)
filterDateCreatedAfter = 2013-10-20 # date |  (optional) (default to null)
subfoldersRecursive = true # Boolean |  (optional) (default to false)

try:
    # Document list
    api_response = api_instance.document_list(folderId, includedMetadataKeys=includedMetadataKeys, excludedMatadataKeys=excludedMatadataKeys, withAutoexportStatus=withAutoexportStatus, filterDateCreatedAfter=filterDateCreatedAfter, subfoldersRecursive=subfoldersRecursive)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentApi->documentList: %s\n" % e)
extern crate DocumentApi;

pub fn main() {
    let folderId = 56; // Integer
    let includedMetadataKeys = includedMetadataKeys_example; // String
    let excludedMatadataKeys = excludedMatadataKeys_example; // String
    let withAutoexportStatus = true; // Boolean
    let filterDateCreatedAfter = 2013-10-20; // date
    let subfoldersRecursive = true; // Boolean

    let mut context = DocumentApi::Context::default();
    let result = client.documentList(folderId, includedMetadataKeys, excludedMatadataKeys, withAutoexportStatus, filterDateCreatedAfter, subfoldersRecursive, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
folder-id*
Integer
Required
included-metadata-keys
String
excluded-matadata-keys
String
with-autoexport-status
Boolean
filter-date-created-after
date (date)
subfolders-recursive
Boolean

Responses


documentOcrResult

Returns the OCR-result of a document

The OCR-result is encoded as UTF-8. The OCR-texts of the individual pages are separated by Form-Feed Characters (0xFF).


/document/{id}/ocr-result

Usage and SDK Samples

curl -X GET \
-H "Cloud-ID: [[apiKey]]" \
-H "API-Key: [[apiKey]]" \
 -H "Accept: text/plain" \
 "https://localhost:8081/api/v2/document/{id}/ocr-result"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocumentApi;

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

public class DocumentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cloudId
        ApiKeyAuth cloudId = (ApiKeyAuth) defaultClient.getAuthentication("cloudId");
        cloudId.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cloudId.setApiKeyPrefix("Token");
        
        // Configure API key authorization: apiKeyAuth
        ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
        apiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DocumentApi apiInstance = new DocumentApi();
        Long id = 789; // Long | Document id

        try {
            'String' result = apiInstance.documentOcrResult(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentOcrResult");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocumentApi;

public class DocumentApiExample {
    public static void main(String[] args) {
        DocumentApi apiInstance = new DocumentApi();
        Long id = 789; // Long | Document id

        try {
            'String' result = apiInstance.documentOcrResult(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentOcrResult");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: cloudId)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Cloud-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Cloud-ID"];

// Configure API key authorization: (authentication scheme: apiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"API-Key"];


// Create an instance of the API class
DocumentApi *apiInstance = [[DocumentApi alloc] init];
Long *id = 789; // Document id (default to null)

// Returns the OCR-result of a document
[apiInstance documentOcrResultWith:id
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var DocboxApi = require('docbox_api');
var defaultClient = DocboxApi.ApiClient.instance;

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

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

// Create an instance of the API class
var api = new DocboxApi.DocumentApi()
var id = 789; // {Long} Document id

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

namespace Example
{
    public class documentOcrResultExample
    {
        public void main()
        {
            // Configure API key authorization: cloudId
            Configuration.Default.ApiKey.Add("Cloud-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Cloud-ID", "Bearer");
            // Configure API key authorization: apiKeyAuth
            Configuration.Default.ApiKey.Add("API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DocumentApi();
            var id = 789;  // Long | Document id (default to null)

            try {
                // Returns the OCR-result of a document
                'String' result = apiInstance.documentOcrResult(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocumentApi.documentOcrResult: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cloudId
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Cloud-ID', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cloud-ID', 'Bearer');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocumentApi();
$id = 789; // Long | Document id

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

# Configure API key authorization: cloudId
$WWW::OPenAPIClient::Configuration::api_key->{'Cloud-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Cloud-ID'} = "Bearer";

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocumentApi->new();
my $id = 789; # Long | Document id

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

# Configure API key authorization: cloudId
openapi_client.configuration.api_key['Cloud-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Cloud-ID'] = 'Bearer'

# Configure API key authorization: apiKeyAuth
openapi_client.configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DocumentApi()
id = 789 # Long | Document id (default to null)

try:
    # Returns the OCR-result of a document
    api_response = api_instance.document_ocr_result(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentApi->documentOcrResult: %s\n" % e)
extern crate DocumentApi;

pub fn main() {
    let id = 789; // Long

    let mut context = DocumentApi::Context::default();
    let result = client.documentOcrResult(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Document id
Required

Responses


documentPdf

Document

Gets the current version of a document as a PDF.


/document/{id}/pdf

Usage and SDK Samples

curl -X GET \
-H "Cloud-ID: [[apiKey]]" \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/pdf,application/octet-stream" \
 "https://localhost:8081/api/v2/document/{id}/pdf?original=true&annotations=annotations_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocumentApi;

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

public class DocumentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cloudId
        ApiKeyAuth cloudId = (ApiKeyAuth) defaultClient.getAuthentication("cloudId");
        cloudId.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cloudId.setApiKeyPrefix("Token");
        
        // Configure API key authorization: apiKeyAuth
        ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
        apiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DocumentApi apiInstance = new DocumentApi();
        Integer id = 56; // Integer | Document id
        Boolean original = true; // Boolean | 
        String annotations = annotations_example; // String | 

        try {
            File result = apiInstance.documentPdf(id, original, annotations);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentPdf");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocumentApi;

public class DocumentApiExample {
    public static void main(String[] args) {
        DocumentApi apiInstance = new DocumentApi();
        Integer id = 56; // Integer | Document id
        Boolean original = true; // Boolean | 
        String annotations = annotations_example; // String | 

        try {
            File result = apiInstance.documentPdf(id, original, annotations);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentPdf");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: cloudId)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Cloud-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Cloud-ID"];

// Configure API key authorization: (authentication scheme: apiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"API-Key"];


// Create an instance of the API class
DocumentApi *apiInstance = [[DocumentApi alloc] init];
Integer *id = 56; // Document id (default to null)
Boolean *original = true; //  (optional) (default to false)
String *annotations = annotations_example; //  (optional) (default to null)

// Document
[apiInstance documentPdfWith:id
    original:original
    annotations:annotations
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var DocboxApi = require('docbox_api');
var defaultClient = DocboxApi.ApiClient.instance;

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

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

// Create an instance of the API class
var api = new DocboxApi.DocumentApi()
var id = 56; // {Integer} Document id
var opts = {
  'original': true, // {Boolean} 
  'annotations': annotations_example // {String} 
};

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

namespace Example
{
    public class documentPdfExample
    {
        public void main()
        {
            // Configure API key authorization: cloudId
            Configuration.Default.ApiKey.Add("Cloud-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Cloud-ID", "Bearer");
            // Configure API key authorization: apiKeyAuth
            Configuration.Default.ApiKey.Add("API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DocumentApi();
            var id = 56;  // Integer | Document id (default to null)
            var original = true;  // Boolean |  (optional)  (default to false)
            var annotations = annotations_example;  // String |  (optional)  (default to null)

            try {
                // Document
                File result = apiInstance.documentPdf(id, original, annotations);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocumentApi.documentPdf: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cloudId
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Cloud-ID', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cloud-ID', 'Bearer');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocumentApi();
$id = 56; // Integer | Document id
$original = true; // Boolean | 
$annotations = annotations_example; // String | 

try {
    $result = $api_instance->documentPdf($id, $original, $annotations);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->documentPdf: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DocumentApi;

# Configure API key authorization: cloudId
$WWW::OPenAPIClient::Configuration::api_key->{'Cloud-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Cloud-ID'} = "Bearer";

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocumentApi->new();
my $id = 56; # Integer | Document id
my $original = true; # Boolean | 
my $annotations = annotations_example; # String | 

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

# Configure API key authorization: cloudId
openapi_client.configuration.api_key['Cloud-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Cloud-ID'] = 'Bearer'

# Configure API key authorization: apiKeyAuth
openapi_client.configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DocumentApi()
id = 56 # Integer | Document id (default to null)
original = true # Boolean |  (optional) (default to false)
annotations = annotations_example # String |  (optional) (default to null)

try:
    # Document
    api_response = api_instance.document_pdf(id, original=original, annotations=annotations)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentApi->documentPdf: %s\n" % e)
extern crate DocumentApi;

pub fn main() {
    let id = 56; // Integer
    let original = true; // Boolean
    let annotations = annotations_example; // String

    let mut context = DocumentApi::Context::default();
    let result = client.documentPdf(id, original, annotations, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Document id
Required
Query parameters
Name Description
original
Boolean
annotations
String

Responses


FileUpload

fileUpload

File upload

Archives a file in the DOCBOX® or places it in an input tray. **INFO:** Bitte beachten Sie, dass * bei einer Splittarchivierung aus dem Eingangsfach in das Archiv mehrere Dokumenten-ID's entstehen. Beispiel: Es liegt ein 5-seitiges Dokument mit der Dokumenten ID 1036 im Eingangsfach. Nun archivieren man Seite 1-2 und am Schluss Seite 3-5. Die Seiten 3-5 behalten die Dokumenten-ID 1036, die Seiten 1-2 erhalten eine neue Dokumenten-ID. * Wenn Sie ein Dokument im Eingangsfach in Einzelseiten auftrennen (Symbol Schere) entstehen neue Dokumenten-ID's und die ursprüngliche ID wird verworfen.


/file-upload

Usage and SDK Samples

curl -X POST \
-H "Cloud-ID: [[apiKey]]" \
-H "API-Key: [[apiKey]]" \
 -H "Accept: text/plain" \
 -H "Content-Type: multipart/form-data" \
 "https://localhost:8081/api/v2/file-upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FileUploadApi;

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

public class FileUploadApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cloudId
        ApiKeyAuth cloudId = (ApiKeyAuth) defaultClient.getAuthentication("cloudId");
        cloudId.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cloudId.setApiKeyPrefix("Token");
        
        // Configure API key authorization: apiKeyAuth
        ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
        apiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FileUploadApi apiInstance = new FileUploadApi();
        File uploadData = BINARY_DATA_HERE; // File | 
        String targetMandatorName = targetMandatorName_example; // String | Name of the mandator where the document should be archived
        String targetFolderPath = targetFolderPath_example; // String | Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/"
        Long targetFolderId = 789; // Long | Id of the target folder. Either this or `target-folder-path` is required.
        String targetDocumentName = targetDocumentName_example; // String | 
        String keywords = keywords_example; // String | Comma separated list of keywords. Commas can be escaped by prepending \\.
        String documentTypes = documentTypes_example; // String | Comma separated list of document types (or their alias). Commas can be escaped by prepending \\.
        String externalId = externalId_example; // String | 
        String externalMetadatas = externalMetadatas_example; // String | Comma separated list of key=value pairs. Comma and equals signs can be escaped by prepending \\.
        String emailImportOrder = emailImportOrder_example; // String | 
        Boolean forceNewDocument = true; // Boolean | 

        try {
            Long result = apiInstance.fileUpload(uploadData, targetMandatorName, targetFolderPath, targetFolderId, targetDocumentName, keywords, documentTypes, externalId, externalMetadatas, emailImportOrder, forceNewDocument);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileUploadApi#fileUpload");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FileUploadApi;

public class FileUploadApiExample {
    public static void main(String[] args) {
        FileUploadApi apiInstance = new FileUploadApi();
        File uploadData = BINARY_DATA_HERE; // File | 
        String targetMandatorName = targetMandatorName_example; // String | Name of the mandator where the document should be archived
        String targetFolderPath = targetFolderPath_example; // String | Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/"
        Long targetFolderId = 789; // Long | Id of the target folder. Either this or `target-folder-path` is required.
        String targetDocumentName = targetDocumentName_example; // String | 
        String keywords = keywords_example; // String | Comma separated list of keywords. Commas can be escaped by prepending \\.
        String documentTypes = documentTypes_example; // String | Comma separated list of document types (or their alias). Commas can be escaped by prepending \\.
        String externalId = externalId_example; // String | 
        String externalMetadatas = externalMetadatas_example; // String | Comma separated list of key=value pairs. Comma and equals signs can be escaped by prepending \\.
        String emailImportOrder = emailImportOrder_example; // String | 
        Boolean forceNewDocument = true; // Boolean | 

        try {
            Long result = apiInstance.fileUpload(uploadData, targetMandatorName, targetFolderPath, targetFolderId, targetDocumentName, keywords, documentTypes, externalId, externalMetadatas, emailImportOrder, forceNewDocument);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileUploadApi#fileUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: cloudId)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Cloud-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Cloud-ID"];

// Configure API key authorization: (authentication scheme: apiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"API-Key"];


// Create an instance of the API class
FileUploadApi *apiInstance = [[FileUploadApi alloc] init];
File *uploadData = BINARY_DATA_HERE; //  (default to null)
String *targetMandatorName = targetMandatorName_example; // Name of the mandator where the document should be archived (optional) (default to null)
String *targetFolderPath = targetFolderPath_example; // Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/" (optional) (default to null)
Long *targetFolderId = 789; // Id of the target folder. Either this or `target-folder-path` is required. (optional) (default to null)
String *targetDocumentName = targetDocumentName_example; //  (optional) (default to null)
String *keywords = keywords_example; // Comma separated list of keywords. Commas can be escaped by prepending \\. (optional) (default to null)
String *documentTypes = documentTypes_example; // Comma separated list of document types (or their alias). Commas can be escaped by prepending \\. (optional) (default to null)
String *externalId = externalId_example; //  (optional) (default to null)
String *externalMetadatas = externalMetadatas_example; // Comma separated list of key=value pairs. Comma and equals signs can be escaped by prepending \\. (optional) (default to null)
String *emailImportOrder = emailImportOrder_example; //  (optional) (default to null)
Boolean *forceNewDocument = true; //  (optional) (default to null)

// File upload
[apiInstance fileUploadWith:uploadData
    targetMandatorName:targetMandatorName
    targetFolderPath:targetFolderPath
    targetFolderId:targetFolderId
    targetDocumentName:targetDocumentName
    keywords:keywords
    documentTypes:documentTypes
    externalId:externalId
    externalMetadatas:externalMetadatas
    emailImportOrder:emailImportOrder
    forceNewDocument:forceNewDocument
              completionHandler: ^(Long output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var DocboxApi = require('docbox_api');
var defaultClient = DocboxApi.ApiClient.instance;

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

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

// Create an instance of the API class
var api = new DocboxApi.FileUploadApi()
var uploadData = BINARY_DATA_HERE; // {File} 
var opts = {
  'targetMandatorName': targetMandatorName_example, // {String} Name of the mandator where the document should be archived
  'targetFolderPath': targetFolderPath_example, // {String} Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/"
  'targetFolderId': 789, // {Long} Id of the target folder. Either this or `target-folder-path` is required.
  'targetDocumentName': targetDocumentName_example, // {String} 
  'keywords': keywords_example, // {String} Comma separated list of keywords. Commas can be escaped by prepending \\.
  'documentTypes': documentTypes_example, // {String} Comma separated list of document types (or their alias). Commas can be escaped by prepending \\.
  'externalId': externalId_example, // {String} 
  'externalMetadatas': externalMetadatas_example, // {String} Comma separated list of key=value pairs. Comma and equals signs can be escaped by prepending \\.
  'emailImportOrder': emailImportOrder_example, // {String} 
  'forceNewDocument': true // {Boolean} 
};

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

namespace Example
{
    public class fileUploadExample
    {
        public void main()
        {
            // Configure API key authorization: cloudId
            Configuration.Default.ApiKey.Add("Cloud-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Cloud-ID", "Bearer");
            // Configure API key authorization: apiKeyAuth
            Configuration.Default.ApiKey.Add("API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FileUploadApi();
            var uploadData = BINARY_DATA_HERE;  // File |  (default to null)
            var targetMandatorName = targetMandatorName_example;  // String | Name of the mandator where the document should be archived (optional)  (default to null)
            var targetFolderPath = targetFolderPath_example;  // String | Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/" (optional)  (default to null)
            var targetFolderId = 789;  // Long | Id of the target folder. Either this or `target-folder-path` is required. (optional)  (default to null)
            var targetDocumentName = targetDocumentName_example;  // String |  (optional)  (default to null)
            var keywords = keywords_example;  // String | Comma separated list of keywords. Commas can be escaped by prepending \\. (optional)  (default to null)
            var documentTypes = documentTypes_example;  // String | Comma separated list of document types (or their alias). Commas can be escaped by prepending \\. (optional)  (default to null)
            var externalId = externalId_example;  // String |  (optional)  (default to null)
            var externalMetadatas = externalMetadatas_example;  // String | Comma separated list of key=value pairs. Comma and equals signs can be escaped by prepending \\. (optional)  (default to null)
            var emailImportOrder = emailImportOrder_example;  // String |  (optional)  (default to null)
            var forceNewDocument = true;  // Boolean |  (optional)  (default to null)

            try {
                // File upload
                Long result = apiInstance.fileUpload(uploadData, targetMandatorName, targetFolderPath, targetFolderId, targetDocumentName, keywords, documentTypes, externalId, externalMetadatas, emailImportOrder, forceNewDocument);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FileUploadApi.fileUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cloudId
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Cloud-ID', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cloud-ID', 'Bearer');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FileUploadApi();
$uploadData = BINARY_DATA_HERE; // File | 
$targetMandatorName = targetMandatorName_example; // String | Name of the mandator where the document should be archived
$targetFolderPath = targetFolderPath_example; // String | Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/"
$targetFolderId = 789; // Long | Id of the target folder. Either this or `target-folder-path` is required.
$targetDocumentName = targetDocumentName_example; // String | 
$keywords = keywords_example; // String | Comma separated list of keywords. Commas can be escaped by prepending \\.
$documentTypes = documentTypes_example; // String | Comma separated list of document types (or their alias). Commas can be escaped by prepending \\.
$externalId = externalId_example; // String | 
$externalMetadatas = externalMetadatas_example; // String | Comma separated list of key=value pairs. Comma and equals signs can be escaped by prepending \\.
$emailImportOrder = emailImportOrder_example; // String | 
$forceNewDocument = true; // Boolean | 

try {
    $result = $api_instance->fileUpload($uploadData, $targetMandatorName, $targetFolderPath, $targetFolderId, $targetDocumentName, $keywords, $documentTypes, $externalId, $externalMetadatas, $emailImportOrder, $forceNewDocument);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FileUploadApi->fileUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FileUploadApi;

# Configure API key authorization: cloudId
$WWW::OPenAPIClient::Configuration::api_key->{'Cloud-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Cloud-ID'} = "Bearer";

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FileUploadApi->new();
my $uploadData = BINARY_DATA_HERE; # File | 
my $targetMandatorName = targetMandatorName_example; # String | Name of the mandator where the document should be archived
my $targetFolderPath = targetFolderPath_example; # String | Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/"
my $targetFolderId = 789; # Long | Id of the target folder. Either this or `target-folder-path` is required.
my $targetDocumentName = targetDocumentName_example; # String | 
my $keywords = keywords_example; # String | Comma separated list of keywords. Commas can be escaped by prepending \\.
my $documentTypes = documentTypes_example; # String | Comma separated list of document types (or their alias). Commas can be escaped by prepending \\.
my $externalId = externalId_example; # String | 
my $externalMetadatas = externalMetadatas_example; # String | Comma separated list of key=value pairs. Comma and equals signs can be escaped by prepending \\.
my $emailImportOrder = emailImportOrder_example; # String | 
my $forceNewDocument = true; # Boolean | 

eval {
    my $result = $api_instance->fileUpload(uploadData => $uploadData, targetMandatorName => $targetMandatorName, targetFolderPath => $targetFolderPath, targetFolderId => $targetFolderId, targetDocumentName => $targetDocumentName, keywords => $keywords, documentTypes => $documentTypes, externalId => $externalId, externalMetadatas => $externalMetadatas, emailImportOrder => $emailImportOrder, forceNewDocument => $forceNewDocument);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FileUploadApi->fileUpload: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: cloudId
openapi_client.configuration.api_key['Cloud-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Cloud-ID'] = 'Bearer'

# Configure API key authorization: apiKeyAuth
openapi_client.configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.FileUploadApi()
uploadData = BINARY_DATA_HERE # File |  (default to null)
targetMandatorName = targetMandatorName_example # String | Name of the mandator where the document should be archived (optional) (default to null)
targetFolderPath = targetFolderPath_example # String | Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/" (optional) (default to null)
targetFolderId = 789 # Long | Id of the target folder. Either this or `target-folder-path` is required. (optional) (default to null)
targetDocumentName = targetDocumentName_example # String |  (optional) (default to null)
keywords = keywords_example # String | Comma separated list of keywords. Commas can be escaped by prepending \\. (optional) (default to null)
documentTypes = documentTypes_example # String | Comma separated list of document types (or their alias). Commas can be escaped by prepending \\. (optional) (default to null)
externalId = externalId_example # String |  (optional) (default to null)
externalMetadatas = externalMetadatas_example # String | Comma separated list of key=value pairs. Comma and equals signs can be escaped by prepending \\. (optional) (default to null)
emailImportOrder = emailImportOrder_example # String |  (optional) (default to null)
forceNewDocument = true # Boolean |  (optional) (default to null)

try:
    # File upload
    api_response = api_instance.file_upload(uploadData, targetMandatorName=targetMandatorName, targetFolderPath=targetFolderPath, targetFolderId=targetFolderId, targetDocumentName=targetDocumentName, keywords=keywords, documentTypes=documentTypes, externalId=externalId, externalMetadatas=externalMetadatas, emailImportOrder=emailImportOrder, forceNewDocument=forceNewDocument)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FileUploadApi->fileUpload: %s\n" % e)
extern crate FileUploadApi;

pub fn main() {
    let uploadData = BINARY_DATA_HERE; // File
    let targetMandatorName = targetMandatorName_example; // String
    let targetFolderPath = targetFolderPath_example; // String
    let targetFolderId = 789; // Long
    let targetDocumentName = targetDocumentName_example; // String
    let keywords = keywords_example; // String
    let documentTypes = documentTypes_example; // String
    let externalId = externalId_example; // String
    let externalMetadatas = externalMetadatas_example; // String
    let emailImportOrder = emailImportOrder_example; // String
    let forceNewDocument = true; // Boolean

    let mut context = FileUploadApi::Context::default();
    let result = client.fileUpload(uploadData, targetMandatorName, targetFolderPath, targetFolderId, targetDocumentName, keywords, documentTypes, externalId, externalMetadatas, emailImportOrder, forceNewDocument, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Form parameters
Name Description
target-mandator-name
String
Name of the mandator where the document should be archived
target-folder-path
String
Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/"
target-folder-id
Long (int64)
Id of the target folder. Either this or `target-folder-path` is required.
target-document-name
String
upload-data*
File (binary)
Required
keywords
String
Comma separated list of keywords. Commas can be escaped by prepending \\.
document-types
String
Comma separated list of document types (or their alias). Commas can be escaped by prepending \\.
external-id
String
external-metadatas
String
Comma separated list of key=value pairs. Comma and equals signs can be escaped by prepending \\.
email-import-order
String
Enum: EMAIL_THEN_ATTACHMENTS, ATTACHMENTS_THEN_EMAIL, EMAIL_ONLY, ATTACHMENTS_ONLY
force-new-document
Boolean

Responses


Folder

folderCreate

Create folder

Create a new folder


/folder/create

Usage and SDK Samples

curl -X POST \
-H "Cloud-ID: [[apiKey]]" \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 "https://localhost:8081/api/v2/folder/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FolderApi;

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

public class FolderApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cloudId
        ApiKeyAuth cloudId = (ApiKeyAuth) defaultClient.getAuthentication("cloudId");
        cloudId.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cloudId.setApiKeyPrefix("Token");
        
        // Configure API key authorization: apiKeyAuth
        ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
        apiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FolderApi apiInstance = new FolderApi();
        Long parentFolderId = 789; // Long | 
        String folderName = folderName_example; // String | 

        try {
            folderCreate result = apiInstance.folderCreate(parentFolderId, folderName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FolderApi#folderCreate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FolderApi;

public class FolderApiExample {
    public static void main(String[] args) {
        FolderApi apiInstance = new FolderApi();
        Long parentFolderId = 789; // Long | 
        String folderName = folderName_example; // String | 

        try {
            folderCreate result = apiInstance.folderCreate(parentFolderId, folderName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FolderApi#folderCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: cloudId)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Cloud-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Cloud-ID"];

// Configure API key authorization: (authentication scheme: apiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"API-Key"];


// Create an instance of the API class
FolderApi *apiInstance = [[FolderApi alloc] init];
Long *parentFolderId = 789; //  (default to null)
String *folderName = folderName_example; //  (default to null)

// Create folder
[apiInstance folderCreateWith:parentFolderId
    folderName:folderName
              completionHandler: ^(folderCreate output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var DocboxApi = require('docbox_api');
var defaultClient = DocboxApi.ApiClient.instance;

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

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

// Create an instance of the API class
var api = new DocboxApi.FolderApi()
var parentFolderId = 789; // {Long} 
var folderName = folderName_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.folderCreate(parentFolderId, folderName, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class folderCreateExample
    {
        public void main()
        {
            // Configure API key authorization: cloudId
            Configuration.Default.ApiKey.Add("Cloud-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Cloud-ID", "Bearer");
            // Configure API key authorization: apiKeyAuth
            Configuration.Default.ApiKey.Add("API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FolderApi();
            var parentFolderId = 789;  // Long |  (default to null)
            var folderName = folderName_example;  // String |  (default to null)

            try {
                // Create folder
                folderCreate result = apiInstance.folderCreate(parentFolderId, folderName);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FolderApi.folderCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cloudId
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Cloud-ID', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cloud-ID', 'Bearer');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FolderApi();
$parentFolderId = 789; // Long | 
$folderName = folderName_example; // String | 

try {
    $result = $api_instance->folderCreate($parentFolderId, $folderName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FolderApi->folderCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FolderApi;

# Configure API key authorization: cloudId
$WWW::OPenAPIClient::Configuration::api_key->{'Cloud-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Cloud-ID'} = "Bearer";

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FolderApi->new();
my $parentFolderId = 789; # Long | 
my $folderName = folderName_example; # String | 

eval {
    my $result = $api_instance->folderCreate(parentFolderId => $parentFolderId, folderName => $folderName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FolderApi->folderCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: cloudId
openapi_client.configuration.api_key['Cloud-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Cloud-ID'] = 'Bearer'

# Configure API key authorization: apiKeyAuth
openapi_client.configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.FolderApi()
parentFolderId = 789 # Long |  (default to null)
folderName = folderName_example # String |  (default to null)

try:
    # Create folder
    api_response = api_instance.folder_create(parentFolderId, folderName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FolderApi->folderCreate: %s\n" % e)
extern crate FolderApi;

pub fn main() {
    let parentFolderId = 789; // Long
    let folderName = folderName_example; // String

    let mut context = FolderApi::Context::default();
    let result = client.folderCreate(parentFolderId, folderName, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Form parameters
Name Description
parent-folder-id*
Long (int64)
Required
folder-name*
String
Required

Responses


Inbox

inboxList

Inbox list

Returns the inbox folders


/inboxes

Usage and SDK Samples

curl -X GET \
-H "Cloud-ID: [[apiKey]]" \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://localhost:8081/api/v2/inboxes?lazy=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InboxApi;

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

public class InboxApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cloudId
        ApiKeyAuth cloudId = (ApiKeyAuth) defaultClient.getAuthentication("cloudId");
        cloudId.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cloudId.setApiKeyPrefix("Token");
        
        // Configure API key authorization: apiKeyAuth
        ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
        apiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        InboxApi apiInstance = new InboxApi();
        Boolean lazy = true; // Boolean | 

        try {
            inboxStructure result = apiInstance.inboxList(lazy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboxApi#inboxList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.InboxApi;

public class InboxApiExample {
    public static void main(String[] args) {
        InboxApi apiInstance = new InboxApi();
        Boolean lazy = true; // Boolean | 

        try {
            inboxStructure result = apiInstance.inboxList(lazy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboxApi#inboxList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: cloudId)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Cloud-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Cloud-ID"];

// Configure API key authorization: (authentication scheme: apiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"API-Key"];


// Create an instance of the API class
InboxApi *apiInstance = [[InboxApi alloc] init];
Boolean *lazy = true; //  (optional) (default to false)

// Inbox list
[apiInstance inboxListWith:lazy
              completionHandler: ^(inboxStructure output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var DocboxApi = require('docbox_api');
var defaultClient = DocboxApi.ApiClient.instance;

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

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

// Create an instance of the API class
var api = new DocboxApi.InboxApi()
var opts = {
  'lazy': true // {Boolean} 
};

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

namespace Example
{
    public class inboxListExample
    {
        public void main()
        {
            // Configure API key authorization: cloudId
            Configuration.Default.ApiKey.Add("Cloud-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Cloud-ID", "Bearer");
            // Configure API key authorization: apiKeyAuth
            Configuration.Default.ApiKey.Add("API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new InboxApi();
            var lazy = true;  // Boolean |  (optional)  (default to false)

            try {
                // Inbox list
                inboxStructure result = apiInstance.inboxList(lazy);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InboxApi.inboxList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cloudId
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Cloud-ID', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cloud-ID', 'Bearer');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InboxApi();
$lazy = true; // Boolean | 

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

# Configure API key authorization: cloudId
$WWW::OPenAPIClient::Configuration::api_key->{'Cloud-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Cloud-ID'} = "Bearer";

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InboxApi->new();
my $lazy = true; # Boolean | 

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

# Configure API key authorization: cloudId
openapi_client.configuration.api_key['Cloud-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Cloud-ID'] = 'Bearer'

# Configure API key authorization: apiKeyAuth
openapi_client.configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.InboxApi()
lazy = true # Boolean |  (optional) (default to false)

try:
    # Inbox list
    api_response = api_instance.inbox_list(lazy=lazy)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboxApi->inboxList: %s\n" % e)
extern crate InboxApi;

pub fn main() {
    let lazy = true; // Boolean

    let mut context = InboxApi::Context::default();
    let result = client.inboxList(lazy, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
lazy
Boolean

Responses


Page

pageOcrResult

Returns the OCR-result of a page

Returns the OCR-result for a specific page encoded as UTF-8.


/page/{id}/ocr-result

Usage and SDK Samples

curl -X GET \
-H "Cloud-ID: [[apiKey]]" \
-H "API-Key: [[apiKey]]" \
 -H "Accept: text/plain" \
 "https://localhost:8081/api/v2/page/{id}/ocr-result"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PageApi;

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

public class PageApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cloudId
        ApiKeyAuth cloudId = (ApiKeyAuth) defaultClient.getAuthentication("cloudId");
        cloudId.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cloudId.setApiKeyPrefix("Token");
        
        // Configure API key authorization: apiKeyAuth
        ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
        apiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PageApi apiInstance = new PageApi();
        Long id = 789; // Long | Page id

        try {
            'String' result = apiInstance.pageOcrResult(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageApi#pageOcrResult");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PageApi;

public class PageApiExample {
    public static void main(String[] args) {
        PageApi apiInstance = new PageApi();
        Long id = 789; // Long | Page id

        try {
            'String' result = apiInstance.pageOcrResult(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageApi#pageOcrResult");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: cloudId)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Cloud-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Cloud-ID"];

// Configure API key authorization: (authentication scheme: apiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"API-Key"];


// Create an instance of the API class
PageApi *apiInstance = [[PageApi alloc] init];
Long *id = 789; // Page id (default to null)

// Returns the OCR-result of a page
[apiInstance pageOcrResultWith:id
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var DocboxApi = require('docbox_api');
var defaultClient = DocboxApi.ApiClient.instance;

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

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

// Create an instance of the API class
var api = new DocboxApi.PageApi()
var id = 789; // {Long} Page id

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

namespace Example
{
    public class pageOcrResultExample
    {
        public void main()
        {
            // Configure API key authorization: cloudId
            Configuration.Default.ApiKey.Add("Cloud-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Cloud-ID", "Bearer");
            // Configure API key authorization: apiKeyAuth
            Configuration.Default.ApiKey.Add("API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PageApi();
            var id = 789;  // Long | Page id (default to null)

            try {
                // Returns the OCR-result of a page
                'String' result = apiInstance.pageOcrResult(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PageApi.pageOcrResult: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: cloudId
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Cloud-ID', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cloud-ID', 'Bearer');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PageApi();
$id = 789; // Long | Page id

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

# Configure API key authorization: cloudId
$WWW::OPenAPIClient::Configuration::api_key->{'Cloud-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Cloud-ID'} = "Bearer";

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PageApi->new();
my $id = 789; # Long | Page id

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

# Configure API key authorization: cloudId
openapi_client.configuration.api_key['Cloud-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Cloud-ID'] = 'Bearer'

# Configure API key authorization: apiKeyAuth
openapi_client.configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PageApi()
id = 789 # Long | Page id (default to null)

try:
    # Returns the OCR-result of a page
    api_response = api_instance.page_ocr_result(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PageApi->pageOcrResult: %s\n" % e)
extern crate PageApi;

pub fn main() {
    let id = 789; // Long

    let mut context = PageApi::Context::default();
    let result = client.pageOcrResult(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Page id
Required

Responses