Function getDocument

Get a document from a specific project. Documents with state unpublished will be retrieved.
Only documents that have been previously added to a project will show on the response. Check how to make changes to channels and content in a Project.
A document in core may be have changes that aren't yet published, these are stored in a separate variant of the document (the 'unpublished' variant). When requesting a document for core, the 'published' variant is retrieved, unless there is none (the page has never been published yet), in which case the unpublished variant is fetched.

Example

getPage(environment, xAuthToken, 'vA1b2', 'pages/home', 'reference-spa')
  .then(response => console.log(response.data))
  .catch(error => console.error(error));
  • getDocument(environment, xAuthToken, path, projectId): AxiosPromise

  • Parameters

    • environment: string

      Environment name: https://{{environment}}.bloomreach.io

    • xAuthToken: string

      BrX API Token

    • path: string

      Path of a document. This is the absolute path to the document, including the document name

    • projectId: string

      Specifies the project content is fetched from

    Returns AxiosPromise

Settings

Member Visibility