documentRenderJob

Requires permission documents:template:update.

A bulk print's state and, once done, its link.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query DocumentRenderJob($id: ID!) {
  documentRenderJob(id: $id) {
    id
    status
    documentCount
    error
    url
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query DocumentRenderJob($id: ID!) {\n  documentRenderJob(id: $id) {\n    id\n    status\n    documentCount\n    error\n    url\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "documentRenderJob": {
      "id": "id",
      "status": "string",
      "documentCount": 0,
      "error": "string",
      "url": "string"
    }
  }
}

documentRenderJob(
  id: ID!
): DocumentRenderJob!

Arguments

documentRenderJob.id ● ID! non-null scalar

The job id renderDocuments returned.

Type

DocumentRenderJob object

A bulk print: up to 50 documents merged into one PDF.