Skip to main content

DocumentationSimplifiedView

Response containing a set of documentation entries for an asset

result object[]required

Collection of documentation entries

  • Array [
    • 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

    Reference to the documentation template if applicable

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

    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 objectrequired

    Root folder containing the documentation structure

    identifierstringrequired

    Unique identifier of the folder

    Example: 123e4567-e89b-12d3-a456-426614174001
    documentationTemplateFolderReferencestring

    Reference to the template folder if applicable

    Example: 2d6e099-910b-4668-902c-deb9f15984ec
    names object[]required

    Set of localized names for this folder

  • Array [
    • namestringrequired

    The name in the specified language

    Example: Root folder
    localestringrequired

    Language code (ISO 639-1)

    Example: en-US
  • ]
    • foldersundefined[]required

    List of subfolders contained within this folder

    Example: []
  • ]
    • DocumentationSimplifiedView
    {
      "result": [
        {
          "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"
            }
          ],
          "rootFolder": {
            "identifier": "123e4567-e89b-12d3-a456-426614174001",
            "documentationTemplateFolderReference": "2d6e099-910b-4668-902c-deb9f15984ec",
            "names": [
              {
                "name": "Root folder",
                "locale": "en-US"
              }
            ],
            "folders": []
          }
        }
      ]
    }