Downloading an Asset Package

Function

This API can be used to obtain the asset package generated by an executed export job. The asset package can be downloaded only once.
You can compress the files, save them to the database, download them, and delete them.

URI

GET /v2/{project_id}/instances/{instance_id}/assets/archives/{archive_id}

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Instance ID. Minimum: 0 Maximum: 64
project_id	Yes	String	Project ID. Minimum: 0 Maximum: 64
archive_id	Yes	String	Field entities.archive_id returned after a job is executed. Minimum: 0 Maximum: 64

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum: 1 Maximum: 100000

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
apps	String	Application name. Characters allowed: letters, digits, hyphens (-), underscores (_), periods (.), spaces, and parentheses. Constraints: The value must be unique in an instance.
tasks	Array<Object>	Tasks.

**Table 4** AppName
Parameter	Type	Description

**Table 5** tasks
Parameter	Type	Description
task_id	String	Task ID.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum: 1 Maximum: 128
error_msg	String	Error message. Minimum: 1 Maximum: 128
error_details	String	Error information. Minimum: 1 Maximum: 128
request_id	String	Request ID. Minimum: 1 Maximum: 128

Example Requests

None

Example Responses

Status code: 403

Forbidden

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}