Sign in

v1

latestOpenAPI 3.0.32026-07-24198357534.7 KB
Document

Provide a single resource - Document

Retrieves a Document resource.

get/documents/{id}

Path parameters

idstring required

Resource identifier

Headers

X-Quable-Localestring

Response

Document resource

activeboolean
attributesobject
completenessesobject
mainAssetThumbnailUrlstring nullable
dateCreatedstring date-time nullable

This is an ISO datetime

dateModifiedstring date-time nullable

This is an ISO datetime

idstring

This is the unique identifier of the resource

legacyIdinteger

Example response

{
  "documentType": {
    "id": "identifier_example"
  },
  "attributeSet": {
    "id": "identifier_example"
  },
  "classifications": [
    {
      "id": "identifier_example"
    }
  ],
  "documentLinks": [
    {
      "linkType": {
        "id": "identifier_example"
      },
      "id": "identifier_example"
    }
  ],
  "assetLinks": [
    {
      "linkType": {
        "id": "identifier_example"
      },
      "id": "identifier_example"
    }
  ],
  "workflows": [
    {
      "steps": [
        {
          "id": "identifier_example",
          "name": {
            "fr-FR": "fr-FR translation",
            "en-US": "en-US translation",
            "<*>": "..."
          },
          "description": {
            "fr-FR": "fr-FR translation",
            "en-US": "en-US translation",
            "<*>": "..."
          },
          "color": "#4DABF7"
        }
      ],
      "transitions": [
        {
          "id": "identifier_example",
          "name": {
            "fr-FR": "fr-FR translation",
            "en-US": "en-US translation",
            "<*>": "..."
          },
          "originStepId": "origin_step_identifier",
          "targetStepId": "target_step_identifier",
          "permissionFeatures": [
            "permission_feature_identifier_1",
            "permission_feature_identifier_2"
          ]
        }
      ],
      "id": "identifier_example"
    }
  ],
  "tags": [
    {
      "id": "identifier_example"
    }
  ],
  "variants": [
    {
      "id": "identifier_example"
    }
  ],
  "id": "identifier_example"
}