Compositions & Component/Composition Patterns

Upserts a composition

Upserts a composition

put/api/v1/canvas

Request

  • Base URL: https://uniform.app
  • URL: https://uniform.app/api/v1/canvas
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Headers

X-If-Unmodified-Sincestring
Example:2024-01-15T10:30:45.123Z

Optional concurrency control header. If provided, the server will check that the composition has not been modified since this timestamp. If the timestamp doesn't match the current modified timestamp, a 409 Conflict response will be returned.

Request body

projectIdstring uuid required

The project ID to upsert the composition to

statenumber required

The publishing state to upsert into. 0 = draft, 64 = published

patternboolean

Indicates if the composition is a pattern that can be referenced in other compositions

createdstring

This field is ignored if present

modifiedstring

This field is ignored if present

categoryIdstring uuid nullable

Reference to the category this component definition belongs to

descriptionstring nullable

A description of the component definition

previewImageUrlstring nullable

A preview image URL of the component definition

releaseIdstring uuid

The release this composition belongs to. If not set, it belongs to the base

workflowIdstring uuid

The workflow ID assigned to this composition, if any

workflowStageIdstring uuid

The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow

editionIdstring uuid

The edition ID. When set, this is a child edition of the composition in _id.

editionNamestring

The name of the composition or edition as shown in the editions listing. Describes the purpose of an edition.

editionPriorityinteger

The priority of the edition or composition. Higher numbers are higher priority. When multiple editions enable the same locale, the highest priority edition is used.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.