archiveExport
Exports an archive of all blocks for one or more boards. If board_id is provided then only that board will be exported, otherwise all boards in the workspace are exported.
/api/v1/workspaces/{workspaceID}/archive/export
Usage and SDK Samples
curl -X GET \
-H "Authorization: [[apiKey]]" \
-H "Accept: application/json" \
"http://localhost/api/v1/api/v1/workspaces/{workspaceID}/archive/export"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: BearerAuth
ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
BearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.setApiKeyPrefix("Token");
// Create an instance of the API class
DefaultApi apiInstance = new DefaultApi();
String workspaceID = workspaceID_example; // String | Workspace ID
String boardId = boardId_example; // String | Id of board to to export
try {
apiInstance.archiveExport(workspaceID, boardId);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#archiveExport");
e.printStackTrace();
}
}
}
import org.openapitools.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
String workspaceID = workspaceID_example; // String | Workspace ID
String boardId = boardId_example; // String | Id of board to to export
try {
apiInstance.archiveExport(workspaceID, boardId);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#archiveExport");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *workspaceID = workspaceID_example; // Workspace ID (default to null)
String *boardId = boardId_example; // Id of board to to export (default to null)
[apiInstance archiveExportWith:workspaceID
boardId:boardId
completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
}];
var FocalboardServer = require('focalboard_server');
var defaultClient = FocalboardServer.ApiClient.instance;
// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
// Create an instance of the API class
var api = new FocalboardServer.DefaultApi()
var workspaceID = workspaceID_example; // {String} Workspace ID
var boardId = boardId_example; // {String} Id of board to to export
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.archiveExport(workspaceID, boardId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;
namespace Example
{
public class archiveExportExample
{
public void main()
{
// Configure API key authorization: BearerAuth
Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
// Create an instance of the API class
var apiInstance = new DefaultApi();
var workspaceID = workspaceID_example; // String | Workspace ID (default to null)
var boardId = boardId_example; // String | Id of board to to export (default to null)
try {
apiInstance.archiveExport(workspaceID, boardId);
} catch (Exception e) {
Debug.Print("Exception when calling DefaultApi.archiveExport: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$workspaceID = workspaceID_example; // String | Workspace ID
$boardId = boardId_example; // String | Id of board to to export
try {
$api_instance->archiveExport($workspaceID, $boardId);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->archiveExport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;
# Configure API key authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $workspaceID = workspaceID_example; # String | Workspace ID
my $boardId = boardId_example; # String | Id of board to to export
eval {
$api_instance->archiveExport(workspaceID => $workspaceID, boardId => $boardId);
};
if ($@) {
warn "Exception when calling DefaultApi->archiveExport: $@\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: BearerAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
workspaceID = workspaceID_example # String | Workspace ID (default to null)
boardId = boardId_example # String | Id of board to to export (default to null)
try:
api_instance.archive_export(workspaceID, boardId)
except ApiException as e:
print("Exception when calling DefaultApi->archiveExport: %s\n" % e)
extern crate DefaultApi;
pub fn main() {
let workspaceID = workspaceID_example; // String
let boardId = boardId_example; // String
let mut context = DefaultApi::Context::default();
let result = client.archiveExport(workspaceID, boardId, &context).wait();
println!("{:?}", result);
}
Scopes
Parameters
Name | Description |
---|---|
workspaceID* |
String
Workspace ID
Required
|
board_id* |
String
Id of board to to export
Required
|