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.

Field properties​

  • name: The field name as configured in AtlantisWeb.
  • value: The raw field value, which may contain HTML markup.
  • textContent: The plain text content with all HTML tags stripped out. This is useful when you need to display or process the field value without HTML formatting, for example in search result previews or accessibility contexts.

Note: The textContent property is available in a minor release after 5.26.1.

File properties​

  • iiifImageUri: A direct URL to the image via the IIIF Image API. This is useful for integrating with IIIF-compatible viewers or when you need standardized image access without using the built-in media viewer.

Note: The iiifImageUri property is available in a minor release after 5.26.1.

{
  "data": {
    "id": 0,
    "isModerated": true,
    "isPublic": true,
    "viewCount": 0,
    "fields": [
      {
        "name": "string",
        "value": "string",
        "isLocation": true,
        "textContent": "string"
      }
    ],
    "files": [
      {
        "id": "string",
        "order": 0,
        "fileName": "string",
        "fileSize": "string",
        "moderated": true,
        "iconUri": "string",
        "downloadUri": "string",
        "viewerUri": "string",
        "iiifImageUri": "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"
      }
    ]
  }
}