Content Type Management API - Bloomreach Experience - The Headless Digital Experience Platform Built for Commerce

Content Type Management API

Introduction

The Content Type Management API enables brX developers to manage content types in a running Bloomreach Content environment. A single REST endpoint is provided, via which a project’s document and compound types can be created and updated.

The Content Type Management API provides seamless integration with the developer projects feature and the content type editor GUI. This API enables automation of use cases related to setting up a new site or extending one with new content. Fetching and updating content types happens in the context of either the master (core) project or a development project that includes document types. Create and update requests can only happen in the context of a development project. Please see Content Modelling.

API Base URL

https://<your_brx_host>.bloomreach.io/management/contenttypes/v1

Authorization

The Content Type Management API is a protected management API and requires authorization using a token. See API Authorization for instructions on how to obtain and use a token.

Updates and conflict prevention

When updating an existing content type resource, you must include the entire resource including all its existing unchanged properties. It's not possible to update only a subset of properties.

Additionally, you must specify the resource's current version using the X-Resource-Version HTTP header. This version is compared with the current version to prevent a client from overwriting a resource that has been updated since the specified version was retrieved. If the version doesn't match, the update will be rejected.

To prevent any unexpected changes or conflicts, always update resources in the following order:

  1. Fetch the current resource along with its current version number.
  2. Update the resource by passing the changed resource along with its current version number.

Reference

Development Aids

To aid developers in working with the Content Type Management API, the following tools and resources are provided:

Swagger UI

Your brX environment provides an interactive Swagger UI for exploring and trying out the Content Type Management API at the following URL:

https://<your_brx_host>.bloomreach.io/management/contenttypes/v1/api-docs

Postman Collection

Bloomreach provides a Postman collection for the Content Type Management API in order to make working with the API easier for developers.

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?