Skip to main content

DocumentLocationView

Location information of a document within a 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
  • ]
  • DocumentLocationView
    {
    "documentationIdentifier": "doc-123e4567-e89b-12d3-a456-426614174000",
    "path": [
    {
    "identifier": "folder-123e4567-e89b-12d3-a456-426614174000",
    "names": {
    "en": "Invoices",
    "fr": "Factures"
    }
    }
    ]
    }