Skip to content
Developers
Back to Steward

Export several applications as one combined file

POST
/api/v1/applications/bulk/export

Queues an async job that renders the selected applications, plus the child applications they cascade in, into a single PDF/CSV/XML/JSON artifact.

Authorizations

Section titled “ Authorizations ”

Request Bodyrequired

Section titled “ Request Bodyrequired ”
Media type application/json
object
applicationIds
required

The SELECTED applications. Child applications are cascaded in server-side and must not be sent.

Array<string>
<= 100 items
format
required
string
Allowed values: pdf json xml csv
template

XML only; rejected for any other format

string
Allowed values: full crs
sections
required
object
screening

Include screening results section

boolean
risk

Include risk score section

boolean
documents

Include documents section

boolean
audit

Include audit log section

boolean
Example 
{
  "applicationIds": [
    "68f2c1a9d4b1f2a3c4d5e6fa",
    "68f2c1a9d4b1f2a3c4d5e6fb"
  ],
  "format": "xml",
  "template": "full",
  "sections": {
    "screening": false,
    "risk": false,
    "documents": false,
    "audit": false
  }
}

Responses

Section titled “ Responses ”

200

Section titled “ 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
}