DOCBOX® XML API

Archive

archivestructureV1

Archive structure

Retrieves the folder structure of the DOCBOX®.


/archivestructure

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/xml" \
 "http://localhost/docbox.webapp/api/archivestructure?parent-folder-id=56"
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 HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // 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.

        try {
            docboxArchive result = apiInstance.archivestructureV1(parentFolderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArchiveApi#archivestructureV1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer parentFolderId = new Integer(); // Integer | Parent folder id. If omitted the whole archive is returned.

try {
    final result = await api_instance.archivestructureV1(parentFolderId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->archivestructureV1: $e\n');
}

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.

        try {
            docboxArchive result = apiInstance.archivestructureV1(parentFolderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArchiveApi#archivestructureV1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// 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)

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

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// 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 DocboxXmlApi.ArchiveApi()
var opts = {
  'parentFolderId': 56 // {Integer} Parent folder id. If omitted the whole archive is returned.
};

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

namespace Example
{
    public class archivestructureV1Example
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // 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)

            try {
                // Archive structure
                docboxArchive result = apiInstance.archivestructureV1(parentFolderId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArchiveApi.archivestructureV1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// 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.

try {
    $result = $api_instance->archivestructureV1($parentFolderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArchiveApi->archivestructureV1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArchiveApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# 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.

eval {
    my $result = $api_instance->archivestructureV1(parentFolderId => $parentFolderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArchiveApi->archivestructureV1: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# 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)

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

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

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

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

Scopes

Parameters

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

Responses


Document

documentDataV1

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


/document/{id}/data

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/xml" \
 "http://localhost/docbox.webapp/api/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 HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // 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 {
            documentDataV1_200_response result = apiInstance.documentDataV1(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentDataV1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long id = new Long(); // Long | Document id

try {
    final result = await api_instance.documentDataV1(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->documentDataV1: $e\n');
}

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 {
            documentDataV1_200_response result = apiInstance.documentDataV1(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentDataV1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// 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 documentDataV1With:id
              completionHandler: ^(documentDataV1_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var DocboxXmlApi = require('docbox_xml_api');
var defaultClient = DocboxXmlApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// 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 DocboxXmlApi.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.documentDataV1(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class documentDataV1Example
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // 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 {
                documentDataV1_200_response result = apiInstance.documentDataV1(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocumentApi.documentDataV1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// 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->documentDataV1($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->documentDataV1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DocumentApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# 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->documentDataV1(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentApi->documentDataV1: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# 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_v1(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentApi->documentDataV1: %s\n" % e)
extern crate DocumentApi;

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

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

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

Scopes

Parameters

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

Responses


documentListV1

Document list

Lists the documents within a specific folder.


/document/list

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/xml" \
 "http://localhost/docbox.webapp/api/document/list?folder-id=56&included-metadata-keys=includedMetadataKeys_example&excluded-matadata-keys=excludedMatadataKeys_example&autoexport-status=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 HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // 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 autoexportStatus = true; // Boolean | 

        try {
            array[document] result = apiInstance.documentListV1(folderId, includedMetadataKeys, excludedMatadataKeys, autoexportStatus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentListV1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer folderId = new Integer(); // Integer | 
final String includedMetadataKeys = new String(); // String | 
final String excludedMatadataKeys = new String(); // String | 
final Boolean autoexportStatus = new Boolean(); // Boolean | 

try {
    final result = await api_instance.documentListV1(folderId, includedMetadataKeys, excludedMatadataKeys, autoexportStatus);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->documentListV1: $e\n');
}

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 autoexportStatus = true; // Boolean | 

        try {
            array[document] result = apiInstance.documentListV1(folderId, includedMetadataKeys, excludedMatadataKeys, autoexportStatus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentListV1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// 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 *autoexportStatus = true; //  (optional) (default to null)

// Document list
[apiInstance documentListV1With:folderId
    includedMetadataKeys:includedMetadataKeys
    excludedMatadataKeys:excludedMatadataKeys
    autoexportStatus:autoexportStatus
              completionHandler: ^(array[document] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var DocboxXmlApi = require('docbox_xml_api');
var defaultClient = DocboxXmlApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// 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 DocboxXmlApi.DocumentApi()
var folderId = 56; // {Integer} 
var opts = {
  'includedMetadataKeys': includedMetadataKeys_example, // {String} 
  'excludedMatadataKeys': excludedMatadataKeys_example, // {String} 
  'autoexportStatus': true // {Boolean} 
};

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

namespace Example
{
    public class documentListV1Example
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // 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 autoexportStatus = true;  // Boolean |  (optional)  (default to null)

            try {
                // Document list
                array[document] result = apiInstance.documentListV1(folderId, includedMetadataKeys, excludedMatadataKeys, autoexportStatus);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocumentApi.documentListV1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// 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 | 
$autoexportStatus = true; // Boolean | 

try {
    $result = $api_instance->documentListV1($folderId, $includedMetadataKeys, $excludedMatadataKeys, $autoexportStatus);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->documentListV1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DocumentApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# 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 $autoexportStatus = true; # Boolean | 

eval {
    my $result = $api_instance->documentListV1(folderId => $folderId, includedMetadataKeys => $includedMetadataKeys, excludedMatadataKeys => $excludedMatadataKeys, autoexportStatus => $autoexportStatus);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentApi->documentListV1: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# 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)
autoexportStatus = true # Boolean |  (optional) (default to null)

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

pub fn main() {
    let folderId = 56; // Integer
    let includedMetadataKeys = includedMetadataKeys_example; // String
    let excludedMatadataKeys = excludedMatadataKeys_example; // String
    let autoexportStatus = true; // Boolean

    let mut context = DocumentApi::Context::default();
    let result = client.documentListV1(folderId, includedMetadataKeys, excludedMatadataKeys, autoexportStatus, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
folder-id*
Integer
Required
included-metadata-keys
String
excluded-matadata-keys
String
autoexport-status
Boolean

Responses


documentListV1POST

Document list

Lists the documents within a specific folder.


/document/list

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/xml" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 "http://localhost/docbox.webapp/api/document/list"
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 HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // 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 withExternalMetadataKeys = withExternalMetadataKeys_example; // String | 
        String withoutExternalMetadataKeys = withoutExternalMetadataKeys_example; // String | 
        Boolean withAutoexportStatus = true; // Boolean | 

        try {
            array[document] result = apiInstance.documentListV1POST(folderId, withExternalMetadataKeys, withoutExternalMetadataKeys, withAutoexportStatus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentListV1POST");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer folderId = new Integer(); // Integer | 
final String withExternalMetadataKeys = new String(); // String | 
final String withoutExternalMetadataKeys = new String(); // String | 
final Boolean withAutoexportStatus = new Boolean(); // Boolean | 

try {
    final result = await api_instance.documentListV1POST(folderId, withExternalMetadataKeys, withoutExternalMetadataKeys, withAutoexportStatus);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->documentListV1POST: $e\n');
}

import org.openapitools.client.api.DocumentApi;

public class DocumentApiExample {
    public static void main(String[] args) {
        DocumentApi apiInstance = new DocumentApi();
        Integer folderId = 56; // Integer | 
        String withExternalMetadataKeys = withExternalMetadataKeys_example; // String | 
        String withoutExternalMetadataKeys = withoutExternalMetadataKeys_example; // String | 
        Boolean withAutoexportStatus = true; // Boolean | 

        try {
            array[document] result = apiInstance.documentListV1POST(folderId, withExternalMetadataKeys, withoutExternalMetadataKeys, withAutoexportStatus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentListV1POST");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// 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 *withExternalMetadataKeys = withExternalMetadataKeys_example; //  (optional) (default to null)
String *withoutExternalMetadataKeys = withoutExternalMetadataKeys_example; //  (optional) (default to null)
Boolean *withAutoexportStatus = true; //  (optional) (default to null)

// Document list
[apiInstance documentListV1POSTWith:folderId
    withExternalMetadataKeys:withExternalMetadataKeys
    withoutExternalMetadataKeys:withoutExternalMetadataKeys
    withAutoexportStatus:withAutoexportStatus
              completionHandler: ^(array[document] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var DocboxXmlApi = require('docbox_xml_api');
var defaultClient = DocboxXmlApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// 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 DocboxXmlApi.DocumentApi()
var folderId = 56; // {Integer} 
var opts = {
  'withExternalMetadataKeys': withExternalMetadataKeys_example, // {String} 
  'withoutExternalMetadataKeys': withoutExternalMetadataKeys_example, // {String} 
  'withAutoexportStatus': true // {Boolean} 
};

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

namespace Example
{
    public class documentListV1POSTExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // 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 withExternalMetadataKeys = withExternalMetadataKeys_example;  // String |  (optional)  (default to null)
            var withoutExternalMetadataKeys = withoutExternalMetadataKeys_example;  // String |  (optional)  (default to null)
            var withAutoexportStatus = true;  // Boolean |  (optional)  (default to null)

            try {
                // Document list
                array[document] result = apiInstance.documentListV1POST(folderId, withExternalMetadataKeys, withoutExternalMetadataKeys, withAutoexportStatus);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocumentApi.documentListV1POST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// 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 | 
$withExternalMetadataKeys = withExternalMetadataKeys_example; // String | 
$withoutExternalMetadataKeys = withoutExternalMetadataKeys_example; // String | 
$withAutoexportStatus = true; // Boolean | 

try {
    $result = $api_instance->documentListV1POST($folderId, $withExternalMetadataKeys, $withoutExternalMetadataKeys, $withAutoexportStatus);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->documentListV1POST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DocumentApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# 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 $withExternalMetadataKeys = withExternalMetadataKeys_example; # String | 
my $withoutExternalMetadataKeys = withoutExternalMetadataKeys_example; # String | 
my $withAutoexportStatus = true; # Boolean | 

eval {
    my $result = $api_instance->documentListV1POST(folderId => $folderId, withExternalMetadataKeys => $withExternalMetadataKeys, withoutExternalMetadataKeys => $withoutExternalMetadataKeys, withAutoexportStatus => $withAutoexportStatus);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentApi->documentListV1POST: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# 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)
withExternalMetadataKeys = withExternalMetadataKeys_example # String |  (optional) (default to null)
withoutExternalMetadataKeys = withoutExternalMetadataKeys_example # String |  (optional) (default to null)
withAutoexportStatus = true # Boolean |  (optional) (default to null)

try:
    # Document list
    api_response = api_instance.document_list_v1_post(folderId, withExternalMetadataKeys=withExternalMetadataKeys, withoutExternalMetadataKeys=withoutExternalMetadataKeys, withAutoexportStatus=withAutoexportStatus)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentApi->documentListV1POST: %s\n" % e)
extern crate DocumentApi;

pub fn main() {
    let folderId = 56; // Integer
    let withExternalMetadataKeys = withExternalMetadataKeys_example; // String
    let withoutExternalMetadataKeys = withoutExternalMetadataKeys_example; // String
    let withAutoexportStatus = true; // Boolean

    let mut context = DocumentApi::Context::default();
    let result = client.documentListV1POST(folderId, withExternalMetadataKeys, withoutExternalMetadataKeys, withAutoexportStatus, &context).wait();

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

Scopes

Parameters

Form parameters
Name Description
folder-id*
Integer
Required
with-external-metadata-keys
String
without-external-metadata-keys
String
with-autoexport-status
Boolean

Responses


documentReplace

Replaces a document in Inbox.


/document/{id}/replace

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "API-Key: [[apiKey]]" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost/docbox.webapp/api/document/{id}/replace?keywords=keywords_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 HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // 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
        String keywords = keywords_example; // String | Comma separated list of keywords to set for the new document. Commas can be escaped by prepending \\.
        File uploadData = BINARY_DATA_HERE; // File | The file to upload. Either this or `upload-data-base64` is required.
        byte[] uploadDataBase64 = BYTE_ARRAY_DATA_HERE; // byte[] | Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required.

        try {
            apiInstance.documentReplace(id, keywords, uploadData, uploadDataBase64);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentReplace");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long id = new Long(); // Long | Document id
final String keywords = new String(); // String | Comma separated list of keywords to set for the new document. Commas can be escaped by prepending \\.
final File uploadData = new File(); // File | The file to upload. Either this or `upload-data-base64` is required.
final byte[] uploadDataBase64 = new byte[](); // byte[] | Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required.

try {
    final result = await api_instance.documentReplace(id, keywords, uploadData, uploadDataBase64);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->documentReplace: $e\n');
}

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
        String keywords = keywords_example; // String | Comma separated list of keywords to set for the new document. Commas can be escaped by prepending \\.
        File uploadData = BINARY_DATA_HERE; // File | The file to upload. Either this or `upload-data-base64` is required.
        byte[] uploadDataBase64 = BYTE_ARRAY_DATA_HERE; // byte[] | Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required.

        try {
            apiInstance.documentReplace(id, keywords, uploadData, uploadDataBase64);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentApi#documentReplace");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// 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)
String *keywords = keywords_example; // Comma separated list of keywords to set for the new document. Commas can be escaped by prepending \\. (optional) (default to null)
File *uploadData = BINARY_DATA_HERE; // The file to upload. Either this or `upload-data-base64` is required. (optional) (default to null)
byte[] *uploadDataBase64 = BYTE_ARRAY_DATA_HERE; // Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required. (optional) (default to null)

// Replaces a document in Inbox.
[apiInstance documentReplaceWith:id
    keywords:keywords
    uploadData:uploadData
    uploadDataBase64:uploadDataBase64
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var DocboxXmlApi = require('docbox_xml_api');
var defaultClient = DocboxXmlApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// 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 DocboxXmlApi.DocumentApi()
var id = 789; // {Long} Document id
var opts = {
  'keywords': keywords_example, // {String} Comma separated list of keywords to set for the new document. Commas can be escaped by prepending \\.
  'uploadData': BINARY_DATA_HERE, // {File} The file to upload. Either this or `upload-data-base64` is required.
  'uploadDataBase64': BYTE_ARRAY_DATA_HERE // {byte[]} Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required.
};

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

namespace Example
{
    public class documentReplaceExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // 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 keywords = keywords_example;  // String | Comma separated list of keywords to set for the new document. Commas can be escaped by prepending \\. (optional)  (default to null)
            var uploadData = BINARY_DATA_HERE;  // File | The file to upload. Either this or `upload-data-base64` is required. (optional)  (default to null)
            var uploadDataBase64 = BYTE_ARRAY_DATA_HERE;  // byte[] | Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required. (optional)  (default to null)

            try {
                // Replaces a document in Inbox.
                apiInstance.documentReplace(id, keywords, uploadData, uploadDataBase64);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocumentApi.documentReplace: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// 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
$keywords = keywords_example; // String | Comma separated list of keywords to set for the new document. Commas can be escaped by prepending \\.
$uploadData = BINARY_DATA_HERE; // File | The file to upload. Either this or `upload-data-base64` is required.
$uploadDataBase64 = BYTE_ARRAY_DATA_HERE; // byte[] | Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required.

try {
    $api_instance->documentReplace($id, $keywords, $uploadData, $uploadDataBase64);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->documentReplace: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DocumentApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# 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 $keywords = keywords_example; # String | Comma separated list of keywords to set for the new document. Commas can be escaped by prepending \\.
my $uploadData = BINARY_DATA_HERE; # File | The file to upload. Either this or `upload-data-base64` is required.
my $uploadDataBase64 = BYTE_ARRAY_DATA_HERE; # byte[] | Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required.

eval {
    $api_instance->documentReplace(id => $id, keywords => $keywords, uploadData => $uploadData, uploadDataBase64 => $uploadDataBase64);
};
if ($@) {
    warn "Exception when calling DocumentApi->documentReplace: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# 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)
keywords = keywords_example # String | Comma separated list of keywords to set for the new document. Commas can be escaped by prepending \\. (optional) (default to null)
uploadData = BINARY_DATA_HERE # File | The file to upload. Either this or `upload-data-base64` is required. (optional) (default to null)
uploadDataBase64 = BYTE_ARRAY_DATA_HERE # byte[] | Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required. (optional) (default to null)

try:
    # Replaces a document in Inbox.
    api_instance.document_replace(id, keywords=keywords, uploadData=uploadData, uploadDataBase64=uploadDataBase64)
except ApiException as e:
    print("Exception when calling DocumentApi->documentReplace: %s\n" % e)
extern crate DocumentApi;

pub fn main() {
    let id = 789; // Long
    let keywords = keywords_example; // String
    let uploadData = BINARY_DATA_HERE; // File
    let uploadDataBase64 = BYTE_ARRAY_DATA_HERE; // byte[]

    let mut context = DocumentApi::Context::default();
    let result = client.documentReplace(id, keywords, uploadData, uploadDataBase64, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Document id
Required
Form parameters
Name Description
upload-data
File (binary)
The file to upload. Either this or `upload-data-base64` is required.
upload-data-base64
byte[] (byte)
Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required.
Query parameters
Name Description
keywords
String
Comma separated list of keywords to set for the new document. Commas can be escaped by prepending \\.

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 "Authorization: Basic [[basicHash]]" \
-H "API-Key: [[apiKey]]" \
 -H "Accept: text/plain" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost/docbox.webapp/api/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 HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // 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();
        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 | 
        File uploadData = BINARY_DATA_HERE; // File | The file to upload. Either this or `upload-data-base64` is required.
        byte[] uploadDataBase64 = BYTE_ARRAY_DATA_HERE; // byte[] | Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required.
        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 \\. Ignores values where no document-type was found.
        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(targetMandatorName, targetFolderPath, targetFolderId, targetDocumentName, uploadData, uploadDataBase64, keywords, documentTypes, externalId, externalMetadatas, emailImportOrder, forceNewDocument);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileUploadApi#fileUpload");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String targetMandatorName = new String(); // String | Name of the mandator where the document should be archived
final String targetFolderPath = new String(); // String | Path to the target folder starting at the mandator. Either this or `target-folder-id` is required. Example: "/Eingangsrechnungen/2018/"
final Long targetFolderId = new Long(); // Long | Id of the target folder. Either this or `target-folder-path` is required.
final String targetDocumentName = new String(); // String | 
final File uploadData = new File(); // File | The file to upload. Either this or `upload-data-base64` is required.
final byte[] uploadDataBase64 = new byte[](); // byte[] | Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required.
final String keywords = new String(); // String | Comma separated list of keywords. Commas can be escaped by prepending \\.
final String documentTypes = new String(); // String | Comma separated list of document types (or their alias). Commas can be escaped by prepending \\. Ignores values where no document-type was found.
final String externalId = new String(); // String | 
final String externalMetadatas = new String(); // String | Comma separated list of key=value pairs. Comma and equals signs can be escaped by prepending \\.
final String emailImportOrder = new String(); // String | 
final Boolean forceNewDocument = new Boolean(); // Boolean | 

try {
    final result = await api_instance.fileUpload(targetMandatorName, targetFolderPath, targetFolderId, targetDocumentName, uploadData, uploadDataBase64, keywords, documentTypes, externalId, externalMetadatas, emailImportOrder, forceNewDocument);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->fileUpload: $e\n');
}

import org.openapitools.client.api.FileUploadApi;

public class FileUploadApiExample {
    public static void main(String[] args) {
        FileUploadApi apiInstance = new FileUploadApi();
        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 | 
        File uploadData = BINARY_DATA_HERE; // File | The file to upload. Either this or `upload-data-base64` is required.
        byte[] uploadDataBase64 = BYTE_ARRAY_DATA_HERE; // byte[] | Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required.
        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 \\. Ignores values where no document-type was found.
        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(targetMandatorName, targetFolderPath, targetFolderId, targetDocumentName, uploadData, uploadDataBase64, 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 HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// 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];
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)
File *uploadData = BINARY_DATA_HERE; // The file to upload. Either this or `upload-data-base64` is required. (optional) (default to null)
byte[] *uploadDataBase64 = BYTE_ARRAY_DATA_HERE; // Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required. (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 \\. Ignores values where no document-type was found. (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:targetMandatorName
    targetFolderPath:targetFolderPath
    targetFolderId:targetFolderId
    targetDocumentName:targetDocumentName
    uploadData:uploadData
    uploadDataBase64:uploadDataBase64
    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 DocboxXmlApi = require('docbox_xml_api');
var defaultClient = DocboxXmlApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// 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 DocboxXmlApi.FileUploadApi()
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} 
  'uploadData': BINARY_DATA_HERE, // {File} The file to upload. Either this or `upload-data-base64` is required.
  'uploadDataBase64': BYTE_ARRAY_DATA_HERE, // {byte[]} Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required.
  '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 \\. Ignores values where no document-type was found.
  '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(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 HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // 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 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 uploadData = BINARY_DATA_HERE;  // File | The file to upload. Either this or `upload-data-base64` is required. (optional)  (default to null)
            var uploadDataBase64 = BYTE_ARRAY_DATA_HERE;  // byte[] | Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required. (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 \\. Ignores values where no document-type was found. (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(targetMandatorName, targetFolderPath, targetFolderId, targetDocumentName, uploadData, uploadDataBase64, 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 HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// 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();
$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 | 
$uploadData = BINARY_DATA_HERE; // File | The file to upload. Either this or `upload-data-base64` is required.
$uploadDataBase64 = BYTE_ARRAY_DATA_HERE; // byte[] | Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required.
$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 \\. Ignores values where no document-type was found.
$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($targetMandatorName, $targetFolderPath, $targetFolderId, $targetDocumentName, $uploadData, $uploadDataBase64, $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 HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# 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 $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 $uploadData = BINARY_DATA_HERE; # File | The file to upload. Either this or `upload-data-base64` is required.
my $uploadDataBase64 = BYTE_ARRAY_DATA_HERE; # byte[] | Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required.
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 \\. Ignores values where no document-type was found.
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(targetMandatorName => $targetMandatorName, targetFolderPath => $targetFolderPath, targetFolderId => $targetFolderId, targetDocumentName => $targetDocumentName, uploadData => $uploadData, uploadDataBase64 => $uploadDataBase64, 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 HTTP basic authorization: basicAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# 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()
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)
uploadData = BINARY_DATA_HERE # File | The file to upload. Either this or `upload-data-base64` is required. (optional) (default to null)
uploadDataBase64 = BYTE_ARRAY_DATA_HERE # byte[] | Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is required. (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 \\. Ignores values where no document-type was found. (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(targetMandatorName=targetMandatorName, targetFolderPath=targetFolderPath, targetFolderId=targetFolderId, targetDocumentName=targetDocumentName, uploadData=uploadData, uploadDataBase64=uploadDataBase64, 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 targetMandatorName = targetMandatorName_example; // String
    let targetFolderPath = targetFolderPath_example; // String
    let targetFolderId = 789; // Long
    let targetDocumentName = targetDocumentName_example; // String
    let uploadData = BINARY_DATA_HERE; // File
    let uploadDataBase64 = BYTE_ARRAY_DATA_HERE; // byte[]
    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(targetMandatorName, targetFolderPath, targetFolderId, targetDocumentName, uploadData, uploadDataBase64, 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)
The file to upload. Either this or `upload-data-base64` is required.
upload-data-base64
byte[] (byte)
Base64 encoded content of the upload-data. When using this parameter `target-document-name` is required. Either this or `upload-data` is 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 \\. Ignores values where no document-type was found.
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

folderCreateV1

Create folder

Create a new folder


/folder/create

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/xml" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 "http://localhost/docbox.webapp/api/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 HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // 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.folderCreateV1(parentFolderId, folderName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FolderApi#folderCreateV1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long parentFolderId = new Long(); // Long | 
final String folderName = new String(); // String | 

try {
    final result = await api_instance.folderCreateV1(parentFolderId, folderName);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->folderCreateV1: $e\n');
}

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.folderCreateV1(parentFolderId, folderName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FolderApi#folderCreateV1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// 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 folderCreateV1With:parentFolderId
    folderName:folderName
              completionHandler: ^(folderCreate output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var DocboxXmlApi = require('docbox_xml_api');
var defaultClient = DocboxXmlApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// 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 DocboxXmlApi.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.folderCreateV1(parentFolderId, folderName, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class folderCreateV1Example
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // 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.folderCreateV1(parentFolderId, folderName);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FolderApi.folderCreateV1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// 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->folderCreateV1($parentFolderId, $folderName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FolderApi->folderCreateV1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FolderApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# 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->folderCreateV1(parentFolderId => $parentFolderId, folderName => $folderName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FolderApi->folderCreateV1: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# 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_v1(parentFolderId, folderName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FolderApi->folderCreateV1: %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.folderCreateV1(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 "Authorization: Basic [[basicHash]]" \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/xml" \
 "http://localhost/docbox.webapp/api/inboxes"
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 HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // 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();

        try {
            inboxStructure result = apiInstance.inboxList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboxApi#inboxList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.inboxList();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->inboxList: $e\n');
}

import org.openapitools.client.api.InboxApi;

public class InboxApiExample {
    public static void main(String[] args) {
        InboxApi apiInstance = new InboxApi();

        try {
            inboxStructure result = apiInstance.inboxList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboxApi#inboxList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// 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];

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

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// 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 DocboxXmlApi.InboxApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.inboxList(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 HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // 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();

            try {
                // Inbox list
                inboxStructure result = apiInstance.inboxList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InboxApi.inboxList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// 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();

try {
    $result = $api_instance->inboxList();
    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 HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# 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();

eval {
    my $result = $api_instance->inboxList();
    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 HTTP basic authorization: basicAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# 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()

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

pub fn main() {

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

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

Scopes

Parameters

Responses


Page

pagePreview

Page preview

Shows a page preview


/page/{id}/preview

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "API-Key: [[apiKey]]" \
 -H "Accept: image/jpeg" \
 "http://localhost/docbox.webapp/api/page/{id}/preview?bbox-width=56&bbox-height=56"
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 HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // 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 | 
        Integer bboxWidth = 56; // Integer | 
        Integer bboxHeight = 56; // Integer | 

        try {
            File result = apiInstance.pagePreview(id, bboxWidth, bboxHeight);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageApi#pagePreview");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long id = new Long(); // Long | 
final Integer bboxWidth = new Integer(); // Integer | 
final Integer bboxHeight = new Integer(); // Integer | 

try {
    final result = await api_instance.pagePreview(id, bboxWidth, bboxHeight);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pagePreview: $e\n');
}

import org.openapitools.client.api.PageApi;

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

        try {
            File result = apiInstance.pagePreview(id, bboxWidth, bboxHeight);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageApi#pagePreview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// 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; //  (default to null)
Integer *bboxWidth = 56; //  (optional) (default to null)
Integer *bboxHeight = 56; //  (optional) (default to null)

// Page preview
[apiInstance pagePreviewWith:id
    bboxWidth:bboxWidth
    bboxHeight:bboxHeight
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var DocboxXmlApi = require('docbox_xml_api');
var defaultClient = DocboxXmlApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// 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 DocboxXmlApi.PageApi()
var id = 789; // {Long} 
var opts = {
  'bboxWidth': 56, // {Integer} 
  'bboxHeight': 56 // {Integer} 
};

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

namespace Example
{
    public class pagePreviewExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // 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 |  (default to null)
            var bboxWidth = 56;  // Integer |  (optional)  (default to null)
            var bboxHeight = 56;  // Integer |  (optional)  (default to null)

            try {
                // Page preview
                File result = apiInstance.pagePreview(id, bboxWidth, bboxHeight);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PageApi.pagePreview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// 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 | 
$bboxWidth = 56; // Integer | 
$bboxHeight = 56; // Integer | 

try {
    $result = $api_instance->pagePreview($id, $bboxWidth, $bboxHeight);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PageApi->pagePreview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PageApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# 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 | 
my $bboxWidth = 56; # Integer | 
my $bboxHeight = 56; # Integer | 

eval {
    my $result = $api_instance->pagePreview(id => $id, bboxWidth => $bboxWidth, bboxHeight => $bboxHeight);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PageApi->pagePreview: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# 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 |  (default to null)
bboxWidth = 56 # Integer |  (optional) (default to null)
bboxHeight = 56 # Integer |  (optional) (default to null)

try:
    # Page preview
    api_response = api_instance.page_preview(id, bboxWidth=bboxWidth, bboxHeight=bboxHeight)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PageApi->pagePreview: %s\n" % e)
extern crate PageApi;

pub fn main() {
    let id = 789; // Long
    let bboxWidth = 56; // Integer
    let bboxHeight = 56; // Integer

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
Query parameters
Name Description
bbox-width
Integer
bbox-height
Integer

Responses