Documents

document_get_site_summary

document_get_site_description

get/pimcore-studio/api/documents/site/{documentId}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/documents/site/{documentId}
  • Auth: none declared

Path parameters

documentIdinteger required
Example:83

DocumentId of the document

Response

document_get_site_success_response

additionalAttributesobject

AdditionalAttributes

idinteger required

ID

creationDateinteger nullable required

Creation Date

modificationDateinteger nullable required

Modification Date

mainDomainstring required

Main domain

domainsstring[] required

Domains

localizedErrorDocumentsobject required

Localized error documents mapped by locale

redirectToMainDomainboolean required

Redirect to main domain

Example response

{
  "creationDate": 1712345678,
  "modificationDate": 1712345678,
  "mainDomain": "main_site",
  "domains": [
    "other_domain"
  ],
  "errorDocument": {
    "id": 83,
    "type": "object",
    "subtype": "Product",
    "fullPath": "/path/to/element",
    "isPublished": true
  },
  "localizedErrorDocuments": {
    "en": {
      "id": 123,
      "type": "document",
      "subtype": "page",
      "fullPath": "en/error-page",
      "isPublished": true
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.