Workflow Comments

Users can add comments to a workflow. This allows for teams to provide additional context to a certain workflow step change.

Availability

Workflow comments are globally available for all customers.

Workflow comment schema

A worklfow comment has two top level properties: body and sys. These are described in detail below.

In addition to the common sys properties comments have the following extra sys properties

The property resolvedBy is only defined if the comment is resolved. Reopening a comment will remove the field from the sys section.

Workflow comments collection

Get all comments of a workflow

Use this endpoint to get all the comments of a workflow.

It is possible to filter comments by optionally providing the status query parameter, if no value is provided comments with any status will be returned.

Permissions

Any user with read access to workflows in the given space-environment can call this endpoint.

Workflow versioned comments collection

Get all comments of a specific workflow version

Use this endpoint to get all the comments of a workflow with a specific version.

Permissions

Any user with read access to workflows in the given space-environment can call this endpoint.

Workflow comment

Create a workflow comment

Use this endpoint to create a workflow comment for a specific workflow version. Currently we only support one workflow comment per workflow version.

Permissions

Any user with read access to workflows in the given space-environment can call this endpoint.

Errors

• A 400 - BadRequest error is returned if there’s an attempt to create more than one workflow comment for a given workflow version.
• A 422 - ValidationFailed error is returned if:
  • The body field has a value bigger than 512 bytes