Export Archive
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Archive/ExportArchive");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"ProviderName\": \"<string>\",\n \"Context\": \"<string>\",\n \"DesiredEntities\": [\n \"<string>\"\n ],\n \"Columns\": [\n \"<string>\"\n ],\n \"SortOrder\": [\n {\n \"Name\": \"<string>\"\n }\n ],\n \"Restrictions\": [\n {\n \"Name\": \"<string>\",\n \"Operator\": \"<string>\",\n \"Values\": [\n \"<string>\"\n ],\n \"DisplayValues\": [\n \"<string>\"\n ],\n \"ColumnInfo\": {\n \"DisplayName\": \"<string>\",\n \"DisplayTooltip\": \"<string>\",\n \"DisplayType\": \"<string>\",\n \"CanOrderBy\": true,\n \"Name\": \"<string>\",\n \"CanRestrictBy\": true,\n \"RestrictionType\": \"<string>\",\n \"RestrictionListName\": \"<string>\",\n \"IsVisible\": true,\n \"ExtraInfo\": \"<string>\",\n \"Width\": \"<string>\",\n \"IconHint\": \"<string>\",\n \"HeadingIconHint\": \"<string>\"\n },\n \"IsActive\": true,\n \"SubRestrictions\": \"<array>\",\n \"InterParenthesis\": 123,\n \"UniqueHash\": 123\n }\n ],\n \"ExportType\": \"<string>\",\n \"SelectedRowIds\": [\n \"<string>\"\n ],\n \"EstimatedRowCount\": 123\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ProviderName: '<string>',
Context: '<string>',
DesiredEntities: ['<string>'],
Columns: ['<string>'],
SortOrder: [{Name: '<string>'}],
Restrictions: [
{
Name: '<string>',
Operator: '<string>',
Values: ['<string>'],
DisplayValues: ['<string>'],
ColumnInfo: {
DisplayName: '<string>',
DisplayTooltip: '<string>',
DisplayType: '<string>',
CanOrderBy: true,
Name: '<string>',
CanRestrictBy: true,
RestrictionType: '<string>',
RestrictionListName: '<string>',
IsVisible: true,
ExtraInfo: '<string>',
Width: '<string>',
IconHint: '<string>',
HeadingIconHint: '<string>'
},
IsActive: true,
SubRestrictions: '<array>',
InterParenthesis: 123,
UniqueHash: 123
}
],
ExportType: '<string>',
SelectedRowIds: ['<string>'],
EstimatedRowCount: 123
})
};
fetch('http://localhost:56350/api/v1/Agents/Archive/ExportArchive', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Archive/ExportArchive",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ProviderName' => '<string>',
'Context' => '<string>',
'DesiredEntities' => [
'<string>'
],
'Columns' => [
'<string>'
],
'SortOrder' => [
[
'Name' => '<string>'
]
],
'Restrictions' => [
[
'Name' => '<string>',
'Operator' => '<string>',
'Values' => [
'<string>'
],
'DisplayValues' => [
'<string>'
],
'ColumnInfo' => [
'DisplayName' => '<string>',
'DisplayTooltip' => '<string>',
'DisplayType' => '<string>',
'CanOrderBy' => true,
'Name' => '<string>',
'CanRestrictBy' => true,
'RestrictionType' => '<string>',
'RestrictionListName' => '<string>',
'IsVisible' => true,
'ExtraInfo' => '<string>',
'Width' => '<string>',
'IconHint' => '<string>',
'HeadingIconHint' => '<string>'
],
'IsActive' => true,
'SubRestrictions' => '<array>',
'InterParenthesis' => 123,
'UniqueHash' => 123
]
],
'ExportType' => '<string>',
'SelectedRowIds' => [
'<string>'
],
'EstimatedRowCount' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/Archive/ExportArchive"
payload = {
"ProviderName": "<string>",
"Context": "<string>",
"DesiredEntities": ["<string>"],
"Columns": ["<string>"],
"SortOrder": [{ "Name": "<string>" }],
"Restrictions": [
{
"Name": "<string>",
"Operator": "<string>",
"Values": ["<string>"],
"DisplayValues": ["<string>"],
"ColumnInfo": {
"DisplayName": "<string>",
"DisplayTooltip": "<string>",
"DisplayType": "<string>",
"CanOrderBy": True,
"Name": "<string>",
"CanRestrictBy": True,
"RestrictionType": "<string>",
"RestrictionListName": "<string>",
"IsVisible": True,
"ExtraInfo": "<string>",
"Width": "<string>",
"IconHint": "<string>",
"HeadingIconHint": "<string>"
},
"IsActive": True,
"SubRestrictions": "<array>",
"InterParenthesis": 123,
"UniqueHash": 123
}
],
"ExportType": "<string>",
"SelectedRowIds": ["<string>"],
"EstimatedRowCount": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ProviderName: '<string>',
Context: '<string>',
DesiredEntities: ['<string>'],
Columns: ['<string>'],
SortOrder: [{Name: '<string>'}],
Restrictions: [
{
Name: '<string>',
Operator: '<string>',
Values: ['<string>'],
DisplayValues: ['<string>'],
ColumnInfo: {
DisplayName: '<string>',
DisplayTooltip: '<string>',
DisplayType: '<string>',
CanOrderBy: true,
Name: '<string>',
CanRestrictBy: true,
RestrictionType: '<string>',
RestrictionListName: '<string>',
IsVisible: true,
ExtraInfo: '<string>',
Width: '<string>',
IconHint: '<string>',
HeadingIconHint: '<string>'
},
IsActive: true,
SubRestrictions: '<array>',
InterParenthesis: 123,
UniqueHash: 123
}
],
ExportType: '<string>',
SelectedRowIds: ['<string>'],
EstimatedRowCount: 123
})
};
fetch('http://localhost:56350/api/v1/Agents/Archive/ExportArchive', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"BatchTaskId": 123,
"FileName": "<string>",
"Message": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Exports the target archive to a downloadable format.
NsApiSlow threshold: 5000 ms.
Export Archive
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Archive/ExportArchive");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"ProviderName\": \"<string>\",\n \"Context\": \"<string>\",\n \"DesiredEntities\": [\n \"<string>\"\n ],\n \"Columns\": [\n \"<string>\"\n ],\n \"SortOrder\": [\n {\n \"Name\": \"<string>\"\n }\n ],\n \"Restrictions\": [\n {\n \"Name\": \"<string>\",\n \"Operator\": \"<string>\",\n \"Values\": [\n \"<string>\"\n ],\n \"DisplayValues\": [\n \"<string>\"\n ],\n \"ColumnInfo\": {\n \"DisplayName\": \"<string>\",\n \"DisplayTooltip\": \"<string>\",\n \"DisplayType\": \"<string>\",\n \"CanOrderBy\": true,\n \"Name\": \"<string>\",\n \"CanRestrictBy\": true,\n \"RestrictionType\": \"<string>\",\n \"RestrictionListName\": \"<string>\",\n \"IsVisible\": true,\n \"ExtraInfo\": \"<string>\",\n \"Width\": \"<string>\",\n \"IconHint\": \"<string>\",\n \"HeadingIconHint\": \"<string>\"\n },\n \"IsActive\": true,\n \"SubRestrictions\": \"<array>\",\n \"InterParenthesis\": 123,\n \"UniqueHash\": 123\n }\n ],\n \"ExportType\": \"<string>\",\n \"SelectedRowIds\": [\n \"<string>\"\n ],\n \"EstimatedRowCount\": 123\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ProviderName: '<string>',
Context: '<string>',
DesiredEntities: ['<string>'],
Columns: ['<string>'],
SortOrder: [{Name: '<string>'}],
Restrictions: [
{
Name: '<string>',
Operator: '<string>',
Values: ['<string>'],
DisplayValues: ['<string>'],
ColumnInfo: {
DisplayName: '<string>',
DisplayTooltip: '<string>',
DisplayType: '<string>',
CanOrderBy: true,
Name: '<string>',
CanRestrictBy: true,
RestrictionType: '<string>',
RestrictionListName: '<string>',
IsVisible: true,
ExtraInfo: '<string>',
Width: '<string>',
IconHint: '<string>',
HeadingIconHint: '<string>'
},
IsActive: true,
SubRestrictions: '<array>',
InterParenthesis: 123,
UniqueHash: 123
}
],
ExportType: '<string>',
SelectedRowIds: ['<string>'],
EstimatedRowCount: 123
})
};
fetch('http://localhost:56350/api/v1/Agents/Archive/ExportArchive', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Archive/ExportArchive",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ProviderName' => '<string>',
'Context' => '<string>',
'DesiredEntities' => [
'<string>'
],
'Columns' => [
'<string>'
],
'SortOrder' => [
[
'Name' => '<string>'
]
],
'Restrictions' => [
[
'Name' => '<string>',
'Operator' => '<string>',
'Values' => [
'<string>'
],
'DisplayValues' => [
'<string>'
],
'ColumnInfo' => [
'DisplayName' => '<string>',
'DisplayTooltip' => '<string>',
'DisplayType' => '<string>',
'CanOrderBy' => true,
'Name' => '<string>',
'CanRestrictBy' => true,
'RestrictionType' => '<string>',
'RestrictionListName' => '<string>',
'IsVisible' => true,
'ExtraInfo' => '<string>',
'Width' => '<string>',
'IconHint' => '<string>',
'HeadingIconHint' => '<string>'
],
'IsActive' => true,
'SubRestrictions' => '<array>',
'InterParenthesis' => 123,
'UniqueHash' => 123
]
],
'ExportType' => '<string>',
'SelectedRowIds' => [
'<string>'
],
'EstimatedRowCount' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/Archive/ExportArchive"
payload = {
"ProviderName": "<string>",
"Context": "<string>",
"DesiredEntities": ["<string>"],
"Columns": ["<string>"],
"SortOrder": [{ "Name": "<string>" }],
"Restrictions": [
{
"Name": "<string>",
"Operator": "<string>",
"Values": ["<string>"],
"DisplayValues": ["<string>"],
"ColumnInfo": {
"DisplayName": "<string>",
"DisplayTooltip": "<string>",
"DisplayType": "<string>",
"CanOrderBy": True,
"Name": "<string>",
"CanRestrictBy": True,
"RestrictionType": "<string>",
"RestrictionListName": "<string>",
"IsVisible": True,
"ExtraInfo": "<string>",
"Width": "<string>",
"IconHint": "<string>",
"HeadingIconHint": "<string>"
},
"IsActive": True,
"SubRestrictions": "<array>",
"InterParenthesis": 123,
"UniqueHash": 123
}
],
"ExportType": "<string>",
"SelectedRowIds": ["<string>"],
"EstimatedRowCount": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ProviderName: '<string>',
Context: '<string>',
DesiredEntities: ['<string>'],
Columns: ['<string>'],
SortOrder: [{Name: '<string>'}],
Restrictions: [
{
Name: '<string>',
Operator: '<string>',
Values: ['<string>'],
DisplayValues: ['<string>'],
ColumnInfo: {
DisplayName: '<string>',
DisplayTooltip: '<string>',
DisplayType: '<string>',
CanOrderBy: true,
Name: '<string>',
CanRestrictBy: true,
RestrictionType: '<string>',
RestrictionListName: '<string>',
IsVisible: true,
ExtraInfo: '<string>',
Width: '<string>',
IconHint: '<string>',
HeadingIconHint: '<string>'
},
IsActive: true,
SubRestrictions: '<array>',
InterParenthesis: 123,
UniqueHash: 123
}
],
ExportType: '<string>',
SelectedRowIds: ['<string>'],
EstimatedRowCount: 123
})
};
fetch('http://localhost:56350/api/v1/Agents/Archive/ExportArchive', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"BatchTaskId": 123,
"FileName": "<string>",
"Message": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/json-patch+jsonapplication/merge-patch+json
ProviderName, Context, DesiredEntities, Columns, SortOrder, Restrictions, ExportType, SelectedRowIds, EstimatedRowCount
Response
OK
Carrier object for ExportArchiveResult. Services for the ExportArchiveResult Carrier is available from the Archive Agent.
Id of the BatchTask created. <=0 if no BatchTask was created.
The path to the output file created, if it exists. Will be an empty string if no file was created.
Descriptive messages; errors, etc.
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Show child attributes
Show child attributes
Field property dictionary mapping field names to field access rights.
Show child attributes
Show child attributes
Related topics
NSExportArchiveResultExport section tabsNSArchiveAgentExport and import of typical searchExport selectionExport Selection Members⌘I