Project Management API

Introduction

The Project Management API enables Bloomreach Content developers to manage projects in a running Bloomreach Content environment. A single REST endpoint is provided, via which project operations such as create, update, get, delete, rebase, and merge can be performed.

The Project Management API enables project operations mostly related to automation of project workflows. These operations only work in the context of developer projects.

API Base URL

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

Authorization

The Project 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 project 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

Development Aids

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

Public Environment

In case you don't yet have access to a Bloomreach Content environment, you can Log in to the Public Developer Environment. Follow the instructions to retrieve an authentication token and explore the APIs.

Run in Postman

Easily import the Project Management API collection and try the endpoints in Postman . The advantage is that in Postman we offer many examples of how the endpoints can be used.

Run in PostmanRun in Postman

The only thing needed to use the Postman collection is to setup the environment variables:

  • brxHost: the URL of your Bloomreach Content environment
  • x-auth-token: the Authentication token