Create Profile

Create a new Profile to be used when creating flows with the matching metadata.

Services MUST reject requests that would update an existing Profile as this would mean it no longer matches flows that have already been created using it. If a change to a Profile is required then a new Profile should be created with the updated information and new flows reference this new Profile.

Attempting to update an existing profiles should return a 400 error.

Tags can be created at the Profile level to hold information about the Profile itself.
These do not form part of the flow that is created.
These are tag/value format and could be used for tasks such as version tracking or holding encoding parameters.

Request body

idstring required

A Universally Unique Identifier (UUID) as defined in RFC9562

labelstring

Freeform string label for the Profile.

descriptionstring

Freeform text describing the Profile.

created_bystring

A string identifier for the entity that created the Profile. Implementations SHOULD set suitable default values for created_by based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.

createdstring date-time

The date-time the Profile was created in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally.

tagsTags

Key is a freeform string. Value is a freeform string, or an array of freeform strings.

Response

The Profile has been created.