POST Agents/Archive/ExportArchive

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Archive/ExportArchive

Exports the target archive to a downloadable format.

Query String Parameters

Parameter Name Type Description
$select string 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. 
POST /api/v1/Agents/Archive/ExportArchive?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

ProviderName, Context, DesiredEntities, Columns, SortOrder, Restrictions, ExportType, SelectedRowIds, EstimatedRowCount

Property Name Type Description
ProviderName String
Context String
DesiredEntities Array
Columns Array
SortOrder Array
Restrictions Array
ExportType String
SelectedRowIds Array
EstimatedRowCount Integer

Response:

OK

Response Description
200 OK

Response body: ExportArchiveResult

Property Name Type Description
BatchTaskId int32 Id of the BatchTask created. <=0 if no BatchTask was created.
FileName string The path to the output file created, if it exists. Will be an empty string if no file was created.
Message string Descriptive messages; errors, etc.
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Archive/ExportArchive
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "ProviderName": "McClure Group",
  "Context": "velit",
  "DesiredEntities": [
    "non",
    "quidem"
  ],
  "Columns": [
    "ea",
    "voluptatem"
  ],
  "SortOrder": [
    {
      "Name": "Price, Reynolds and Gutkowski",
      "Direction": "ASC"
    },
    {
      "Name": "Price, Reynolds and Gutkowski",
      "Direction": "ASC"
    }
  ],
  "Restrictions": [
    {
      "Name": "Morissette Inc and Sons",
      "Operator": "dolores",
      "Values": [
        "et",
        "laboriosam"
      ],
      "DisplayValues": [
        "impedit",
        "voluptas"
      ],
      "ColumnInfo": null,
      "IsActive": false,
      "SubRestrictions": [
        {},
        {}
      ],
      "InterParenthesis": 139,
      "InterOperator": "And",
      "UniqueHash": 66
    }
  ],
  "ExportType": "atque",
  "SelectedRowIds": [
    "sit",
    "nobis"
  ],
  "EstimatedRowCount": 807
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "BatchTaskId": 445,
  "FileName": "Schimmel-Gottlieb",
  "Message": "iste",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 418
    }
  }
}