Introduction
The Content Type Management API enables Bloomreach Content developers to manage content types in a running Bloomreach Content environment. A single REST endpoint is provided, via which a project’s content 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 main (core) project or a development project that includes content type changes. Create and update requests can only happen in the context of a development project. Please see Content Modeling.
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 site configuration resource, you must include the entire resource including all its existing unchanged properties. It's not possible to update only a subset of properties. Read more about how to handle updates and conflict prevention.
API Reference
- Content Type Operations
- Schemas
- Content Types
- Content Type Fields
- Open API Specification (JSON) (Open in Swagger)
Delivery API Reserved Names
When working with content types, please be aware of the reserved names in the Delivery API and avoid using these names in your content types!
Development Aids
To aid developers in working with the Content Type Management API, the following tools and resources are provided:
Public Environment
If you don't have access to a Bloomreach Content environment yet, you can use the Public Developer Environment. Follow the instructions to retrieve an authentication token and explore the APIs.
Run in Postman
Import the Content Type Management API collection and try the endpoints in Postman. The collection provides many examples of how the endpoints can be used.
The only thing needed to use the Postman collection is to set up the environment variables:
- brxHost: the URL of your Bloomreach Content environment
- x-auth-token: the Authentication token