Skip to main content

DocumentReferenceView

Reference to an entity related to the document

referencedEntityTypestring

Type of the referenced entity

Example: ASSET
entityIdentifierstring

Identifier of the referenced entity

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

Identifier of the documentation

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

Folder information if the document is filed in a 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

    Location information of the document in the documentation structure

    documentationIdentifierstring

    Identifier of the documentation

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

    Path to the document in the folder structure

  • Array [
    • identifierstring

    Identifier of the path node

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

    Localized names of the path node mapped by language code

    property name*string
  • ]
    • templateFolder object

    Identifier of the 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
  • ]
    • 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": "template-folder-123e4567-e89b-12d3-a456-426614174000"
    }