Skip to main content

DocumentationResponseView

Detailed information about a documentation entry

identifierstringrequired

Unique identifier of the documentation

Example: 123e4567-e89b-12d3-a456-426614174000
organizationCodestringrequired

Organization code that owns this documentation

Example: ORG123
assetIdentifierstringrequired

Identifier of the asset this documentation belongs to

Example: 3e6e000-919b-8762-108d-deb9f1595dr
documentationTemplateReferencestring | nullnullable

Reference to the documentation template if applicable

Example: 2d6e099-910b-4668-902c-deb9f15984ec
documentationTemplateAttachmentTypestring | nullnullable

Type of attachment for the documentation template

Example: ASSET
names object[]required

Set of localized names for this documentation

  • Array [
    • namestringrequired

    The name in the specified language

    Example: Root folder
    localestringrequired

    Language code (ISO 639-1)

    Example: en-US
  • ]
    • rootFolder objectrequireddeprecated

    Root folder (backward-compatible alias of rootTemplate — will be removed in a future release)

    identifierstringrequired
    documentationTemplateFolderReferencestring | nullnullable
    names object[]required
  • Array [
    • namestringrequired

    The name in the specified language

    Example: Root folder
    localestringrequired

    Language code (ISO 639-1)

    Example: en-US
  • ]
    • folders object[]required
  • Array [
    • 0
    1
    2
    3
    4
    5
    6
    7
    8
    9
  • ]
    • rootTemplate objectrequired

    Root template folder (canonical durable projection sourced from documentationtemplatefolders)

    identifierstringrequired
    names object[]required
  • Array [
    • namestringrequired

    The name in the specified language

    Example: Root folder
    localestringrequired

    Language code (ISO 639-1)

    Example: en-US
  • ]
    • folders object[]required
  • Array [
    • 0
    1
    2
    3
    4
    5
    6
    7
    8
    9
  • ]
    • DocumentationResponseView
    {
      "identifier": "123e4567-e89b-12d3-a456-426614174000",
      "organizationCode": "ORG123",
      "assetIdentifier": "3e6e000-919b-8762-108d-deb9f1595dr",
      "documentationTemplateReference": "2d6e099-910b-4668-902c-deb9f15984ec",
      "documentationTemplateAttachmentType": "ASSET",
      "names": [
        {
          "name": "Documentation 1",
          "locale": "en-US"
        }
      ],
      "rootTemplate": {
        "identifier": "string",
        "names": [
          {
            "name": "Root folder",
            "locale": "en-US"
          }
        ],
        "folders": [
          {}
        ]
      }
    }