Documents Endpoint - Bloomreach Experience - The Headless Digital Experience Platform Built for Commerce

Documents Endpoint

GET /channels/{channel_id}/documents/{document_identifier}

Get the JSON representation of a document in a Bloomreach Content channel including all the documents it references.

See Document JSON Representation for a full walkthrough of the response format.

Parameters

Name Description

Authorization

string

(header)

When the Experience manager requests the preview channel for the first time, it appends the external frontend application's URL with a 'query' request parameter containing a JSON Web Token. In order to access the preview channel data through a Page Delivery API request, the frontend application must include this token in the Authorization header using the Bearer schema. See Delivery API Preview Authentication for more details.

Mandatory in Experience manager channel preview context only

Example:

Authorization: Bearer xxxxx.yyyyy.zzzzz

channel_id *

string

(path)

Channel id

document_identifier

string

(path)

The <document-identifier> can be any of the following elements:

  • The uuid of a document: /delivery/site/v1/channels/brxsaas/documents/9a3f1f5c-5302-43c4-9bec-584e810ffa2f
  • A same uuid in the format used within the Delivery APIs: /delivery/site/v1/channels/brxsaas/documents/u9a3f1f5c530243c49bec584e810ffa2f
  • The absolute path of the document in the repository: /delivery/site/v1/channels/brxsaas/documents/content/documents/brxsaas/articles/highlighted
  • The relative path to the document for the current channel (only valid if the content is a descendant of the root content folder of the current channel): /delivery/site/v1/channels/brxsaas/documents/articles/highlighted

Response

Code Description
200

OK

Media type: application/json

Example:

{
   "meta":{   
      "product": "brx",
      "version":"1.0",
      "branch":"master"
   },
   "document":{
      "$ref":"/page/u10811792bf4b42c4bbf1ab303fc5ebcf"
   },
   "content":{
      "u10811792bf4b42c4bbf1ab303fc5ebcf":{
         "type":"document",
         ...
         ]
      },
      ...
      ...
      ...
      "u6b031ebfe46f46cd9ecdf430fa952f34":{
         "type":"document",
         ...
      }
   }
}
404 Not Found

 

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?