archivestructure
Archive structure
Retrieves the folder structure of the DOCBOX®.
/archivestructure
Usage and SDK Samples
curl -X GET \
-H "API-Key: [[apiKey]]" \
-H "Authorization: Basic [[basicHash]]" \
-H "Accept: application/json" \
"/api/v2/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 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");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
// 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.archivestructure(parentFolderId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArchiveApi#archivestructure");
e.printStackTrace();
}
}
}
import org.openapitools.client.api.ArchiveApi;
public class ArchiveApiExample {
public static void main(String[] args) {
ArchiveApi apiInstance = new ArchiveApi();
Integer parentFolderId = 56; // Integer | Parent folder id. If omitted the whole archive is returned.
try {
docboxArchive result = apiInstance.archivestructure(parentFolderId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ArchiveApi#archivestructure");
e.printStackTrace();
}
}
}Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: 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"];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// 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 archivestructureWith:parentFolderId
completionHandler: ^(docboxArchive output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var DocboxApi = require('docbox_api');
var defaultClient = DocboxApi.ApiClient.instance;
// Configure API key authorization: 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";
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';
// Create an instance of the API class
var api = new DocboxApi.ArchiveApi()
var opts = {
'parentFolderId': 56 // {Integer} Parent folder id. If omitted the whole archive is returned.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.archivestructure(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;
namespace Example
{
public class archivestructureExample
{
public void main()
{
// Configure API key authorization: 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");
// Configure HTTP basic authorization: basicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
// 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.archivestructure(parentFolderId);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling ArchiveApi.archivestructure: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: 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');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// 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->archivestructure($parentFolderId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ArchiveApi->archivestructure: ', $e->getMessage(), PHP_EOL;
}
?>use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArchiveApi;
# Configure API key authorization: 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";
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';
# 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->archivestructure(parentFolderId => $parentFolderId);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ArchiveApi->archivestructure: $@\n";
}from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: 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'
# Configure HTTP basic authorization: basicAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'
# 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(parentFolderId=parentFolderId)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchiveApi->archivestructure: %s\n" % e)extern crate ArchiveApi;
pub fn main() {
let parentFolderId = 56; // Integer
let mut context = ArchiveApi::Context::default();
let result = client.archivestructure(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.
|