Progress of a bulk export

GET

/api/v1/applications/bulk/export/{jobId}

Authorizations

• apiKey

Parameters

Path Parameters

jobId

required

string

Responses

200

Media type application/json

object

id

required

string

status

required

string

Allowed values: PENDING PROCESSING COMPLETED FAILED

totalCount

required

Applications in the file, including selected parents and their cascaded children

number

completedCount

required

Applications rendered so far

number

failedApplicationIds

required

Applications whose own render failed; the batch completes without them

Array<string>

filename

Set once the artifact exists

string

nullable

errorMessage

string

nullable

Examples

{
  "id": "6a0c4e7b2d9f1a3b5c8e0d42",
  "status": "PENDING",
  "totalCount": 2,
  "completedCount": 0,
  "failedApplicationIds": [],
  "filename": null,
  "errorMessage": null
}

{
  "id": "6a0c4e7b2d9f1a3b5c8e0d42",
  "status": "PENDING",
  "totalCount": 0,
  "completedCount": 0,
  "failedApplicationIds": [
    "68f2c1a9d4b1f2a3c4d5e6fb"
  ],
  "filename": null,
  "errorMessage": null
}