Aller au contenu principal

DocumentDetailResponse

A single document's detail response. identity and file are always present; every other section is present only when requested via the include query parameter.

identity objectrequired

Core document identity — always present

identifierstringrequired
Example: 43065ec3-04d7-4613-b22a-a9b851eb1616
organizationCodestring | nullnullable
Example: DEMO
namestringrequired
Example: DPE_2017 (1).pdf
fileIdentifierstringrequired
Example: fa692f4d-93e7-415a-86d3-12f2f1d7131e
file objectrequired

File information — always present. size/contentType may be absent if that information can't be resolved.

size(integer | null)<int64>nullable
Example: 1088229
contentType object
oneOf
mediaTypestringrequired
Example: application/pdf
charsetstring | nullnullable
classification object
oneOf

Classification information — present when requested via include=classification or include=all

classificationStatusstring | nullnullable
documentClass object
oneOf
identifierstringrequired
codestringrequired
names objectrequired
property name*string
predictedDocumentClass object
oneOf
predictedDocumentClassIdentifierstringrequired
predictedDocumentClassCodestringrequired
predictedDocumentClassNames objectrequired
property name*string
confidenceIndex(number | null)<double>nullable
predictedFolder object
oneOf
identifierstringrequired
names objectrequired
property name*string
docsUsedToClassify object[]required
  • Array [
    • fileResourceUidstringrequired
    documentUidstringrequired
    cosineSimilaritystringrequired
    namestringrequired
  • ]
    • tags object
    oneOf

    Tags — present when requested via include=tags or include=all

    documentationTags object[]required
  • Array [
    • identifierinteger<int32>required
    documentationIdentifierstringrequired
    namestringrequired
    colorstring | nullnullable
  • ]
    • tagsstring[]required
    metadata object[]
  • Array [
    • codestringrequired
    valuestring | nullnullable
    suggestedValuestring | nullnullable

    Raw AI-suggested value for this field, independent of value's own resolution — compare against value to tell whether it is still AI-extracted or has been human-validated/edited

    metadataType object
    oneOf
    identifierstringrequired
    names objectrequired
    property name*string
    formatstringrequired
    unitstring | nullnullable
    descriptionstring | nullnullable
  • ]
    • linkedAssets object
    oneOf

    Assets linked to the document (uid → name) — present when requested via include=linkedAssets or include=all

    names objectrequired
    property name*string
    stakeholders object
    oneOf

    Stakeholders on the document (uid → name) — present when requested via include=stakeholders or include=all

    names objectrequired
    property name*string
    lifecycle object
    oneOf

    Lifecycle timestamps — present when requested via include=lifecycle or include=all

    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    uploadedBystring | nullnullable
    deletedAt(string | null)<date-time>nullable
    deletedBystring | nullnullable
    references object[]
  • Array [
    • asset object
    oneOf

    name/type/externalIdentifier are null when the referenced asset can't be resolved; identifier is always present

    identifierstringrequired
    namestring | nullnullable
    typestring | nullnullable
    externalIdentifierstring | nullnullable

    The asset's identifier in an external system (e.g. an ERP), when known

    documentation object
    oneOf
    identifierstringrequired
    names objectrequired
    property name*string
    folder object
    oneOf
    identifierstringrequired
    names objectrequired
    property name*string
    manuallyValidatedbooleanrequired
  • ]
    • DocumentDetailResponse
    {
      "identity": {
        "identifier": "43065ec3-04d7-4613-b22a-a9b851eb1616",
        "organizationCode": "DEMO",
        "name": "DPE_2017 (1).pdf",
        "fileIdentifier": "fa692f4d-93e7-415a-86d3-12f2f1d7131e"
      },
      "file": {
        "size": 1088229,
        "contentType": {
          "mediaType": "application/pdf",
          "charset": "string"
        }
      },
      "classification": {
        "classificationStatus": "string",
        "documentClass": {
          "identifier": "string",
          "code": "string",
          "names": {}
        },
        "predictedDocumentClass": {
          "predictedDocumentClassIdentifier": "string",
          "predictedDocumentClassCode": "string",
          "predictedDocumentClassNames": {},
          "confidenceIndex": 0
        },
        "predictedFolder": {
          "identifier": "string",
          "names": {}
        },
        "docsUsedToClassify": [
          {
            "fileResourceUid": "string",
            "documentUid": "string",
            "cosineSimilarity": "string",
            "name": "string"
          }
        ]
      },
      "tags": {
        "documentationTags": [
          {
            "identifier": 0,
            "documentationIdentifier": "string",
            "name": "string",
            "color": "string"
          }
        ],
        "tags": [
          "string"
        ]
      },
      "metadata": "Unknown Type: array,null",
      "linkedAssets": {
        "names": {}
      },
      "stakeholders": {
        "names": {}
      },
      "lifecycle": {
        "createdAt": "2024-07-29T15:51:28.071Z",
        "updatedAt": "2024-07-29T15:51:28.071Z",
        "uploadedBy": "string",
        "deletedAt": "2024-07-29T15:51:28.071Z",
        "deletedBy": "string"
      },
      "references": "Unknown Type: array,null"
    }