Skip to main content

DocumentReferenceView

Reference to an entity related to the document

referencedEntityTypestring | nullnullable

Type of the referenced entity

Example: ASSET
entityIdentifierstring | nullnullable

Identifier of the referenced entity

Example: asset-123e4567-e89b-12d3-a456-426614174000
documentationIdentifierstring | nullnullable

Identifier of the documentation

Example: doc-123e4567-e89b-12d3-a456-426614174000
folder object
oneOf

Information about a document folder

identifierstringrequired

Unique identifier of the folder

Example: folder-123e4567-e89b-12d3-a456-426614174000
names object[]required

Localized names of the folder in different languages

  • Array [
    • namestringrequired

    The name in the specified language

    Example: Root folder
    localestringrequired

    Language code (ISO 639-1)

    Example: en-US
  • ]
    • documentLocationView object
    oneOf

    Location information of a document within a documentation structure

    documentationIdentifierstring | nullnullable

    Identifier of the documentation

    Example: doc-123e4567-e89b-12d3-a456-426614174000
    path object[]required

    Path to the document in the folder structure

  • Array [
    • identifierstring | nullnullable

    Identifier of the path node

    Example: folder-123e4567-e89b-12d3-a456-426614174000
    names object | null

    Localized names of the path node mapped by language code

    property name*string
  • ]
    • templateFolder object
    oneOf

    Information about a document template folder

    identifierstringrequired

    Unique identifier of the template folder

    Example: template-folder-123e4567-e89b-12d3-a456-426614174000
    names object[]

    Localized names of the template folder in different languages

  • Array [
    • namestringrequired

    The name in the specified language

    Example: Root folder
    localestringrequired

    Language code (ISO 639-1)

    Example: en-US
  • ]
    • manuallyValidatedbooleanrequired

    Whether this specific reference was manually validated by a user

    Example: false
    DocumentReferenceView
    {
      "referencedEntityType": "ASSET",
      "entityIdentifier": "asset-123e4567-e89b-12d3-a456-426614174000",
      "documentationIdentifier": "doc-123e4567-e89b-12d3-a456-426614174000",
      "folder": {
        "identifier": "folder-123e4567-e89b-12d3-a456-426614174000",
        "names": [
          {
            "name": "Root folder",
            "locale": "en-US"
          }
        ]
      },
      "documentLocationView": {
        "documentationIdentifier": "doc-123e4567-e89b-12d3-a456-426614174000",
        "path": [
          {
            "identifier": "folder-123e4567-e89b-12d3-a456-426614174000",
            "names": {
              "en": "Invoices",
              "fr": "Factures"
            }
          }
        ]
      },
      "templateFolder": {
        "identifier": "template-folder-123e4567-e89b-12d3-a456-426614174000",
        "names": "Unknown Type: array,null"
      },
      "manuallyValidated": false
    }