Skip to Content
ReferenceAPICatalogueCreate an item

Catalogue API

Create a catalogue item

Create a product or service in the current workspace catalogue.

POST/v1/catalogue/items
capability catalogue.items.create · v1operational dataserver-scoped workspace

Request

Path, query, and JSON body fields accepted by this operation.

  • kind"product" | "service"required
    body
  • handlestring
    bodymin length 1max length 120
  • namestringrequired
    bodymin length 1max length 160
  • descriptionstring | null
    bodydefault nullmax length 5000
  • referencestring | null
    bodydefault nullmin length 1max length 120
  • serviceDurationMinutesinteger | null
    bodydefault nullmin 5max 1440
  • status"draft" | "active" | "archived"
    bodydefault "draft"

Response

Successful responses use Dawn's data envelope.

  • dataCatalogueItemrequired
    • idstring<uuid>required
    • workspaceIdstring<uuid>required
    • kind"product" | "service"required
    • handlestringrequired
      min length 1max length 120
    • namestringrequired
      min length 1max length 160
    • descriptionstring | nullrequired
      max length 5000
    • referencestring | nullrequired
      min length 1max length 120
    • serviceDurationMinutesinteger | nullrequired
      min 5max 1440
    • status"draft" | "active" | "archived"required
    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
  • metaobject

Errors

Error responses use the shared error envelope.

  • 409A catalogue item already uses this handle or reference.
  • 422The catalogue item is invalid.
  • 503The catalogue item could not be saved.
Last updated on