Exports

Request resource export

requests the creation of a resource export that will be assembled in background

POST /v1/{accountUrl}/projects/{projectUrl}/exports

PARAMETERS

accountUrl* required (path)- Account url. It is derived from the name of the organization

projectUrl* required (path) - Project url. It is derived from the project's title.

RESPONSES DESCRIPTION

OK: Returns the just created resource export

RESPONSE

{
 "id": "string",
 "status": "string",
 "resourceExports": [
  {
   "filePath": "string",
   "iso2Slug": "string",
   "status": "string",
   "downloadUrl": "string"
  }
 ],
 "errorDetails": "string",
 "filePath": "string",
 "downloadUrl": "string",
 "triggerType": "string",
 "createdAt": "string"
}

Request information about a resource export

The information about a resource export. Can be used to wait for SUCCESS status of a running resource export that can be downloaded then.

GET /v1/{accountUrl}/projects/{projectUrl}/exports/{id}

PARAMETERS

accountUrl* required (path) - Account url. It is derived from the name of the organization

projectUrl* required (path) - Project url. It is derived from the project's title.

id* required (path) - the id of an existing resource export

RESPONSES DESCRIPTION

OK: Returns the resource export according to the given id

RESPONSE

{
 "id": "string",
 "status": "string",
 "resourceExports": [
  {
   "filePath": "string",
   "iso2Slug": "string",
   "status": "string",
   "downloadUrl": "string"
  }
 ],
 "errorDetails": "string",
 "filePath": "string",
 "downloadUrl": "string",
 "triggerType": "string",
 "createdAt": "string"
}