Exports

Request resource export

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

REQUEST

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

PARAMETERS

• workspaceUrl required (path) - Workspace URL

• projectUrl required (path) - Project URL

RESPONSE

OK: Returns information about the created resource export

{
  "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.

If the end status SUCCESS has been reached, the resourceExports.downloadUrl per file can be used to download the exported resource file.

REQUEST

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

PARAMETERS

• workspaceUrl required (path) - Workspace URL

• projectUrl required (path) - Project URL

• id required - the id of an existing resource export

RESPONSE

OK: Returns the resource export according to the given id

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