Skip to main content

Document

The Documentation APIs retrieve detailed information about records found using the search APIs. These APIs can be used when creating specific detail pages for records.

Get document by id​

Endpoint: /publicapi/documents/{id}

Method: GET

Content-Type: application/json

Response​

Use this api to get the document of a specific id. All objects inside the property data.
Fields are configurable from the backend 'AtlantisWeb'.
The field with name cmdetail should always be available and used for presentation on a detail-page.

{
  "data": {
    "id": 0,
    "isModerated": true,
    "isPublic": true,
    "viewCount": 0,
    "fields": [
      {
        "name": "string",
        "value": "string",
        "isLocation": true
      }
    ],
    "files": [
      {
        "id": "string",
        "order": 0,
        "fileName": "string",
        "fileSize": "string",
        "moderated": true,
        "iconUri": "string",
        "downloadUri": "string",
        "viewerUri": "string",
        "copyrightProtected": true,
        "mediaType": "string",
        "title": "string",
        "description": "string",
        "copyright": "string",
        "copyrights": [
          {
            "name": "string"
          }
        ]
      }
    ],
    "module": "string",
    "metamodel": "string",
    "descriptionGroups": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "copyrights": [
      {
        "name": "string"
      }
    ]
  }
}