Function putDocument

Create or update a document in a specific project.
The document will be created with state unpublished. To make changes available on the live website, it's necessary to merge the project.

Example

putPage(environment, xAuthToken, 'vA1b2', 'reference-spa', 'pages/home', pageData)
  .then(response => console.log(response.data))
  .catch(error => console.error(error));
  • putDocument(environment, xAuthToken, projectId, path, documentData, xResourceVersion?): AxiosPromise

  • Parameters

    • environment: string

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

    • xAuthToken: string

      BrX API Token

    • projectId: string

      Specifies the project content is added to

    • path: string

      Relative path of page. It is appended to the content root path of the given channel. Folders appearing in this path need to preexist

    • documentData: Document
    • OptionalxResourceVersion: string

      Resource's version, as obtained when GETting the resource. The first time a resource is created, a empty value is expected (omit the header). Must be used in any subsequent update requests of this resource

    Returns AxiosPromise

Settings

Member Visibility