Skip to navigation

Create a new work item

Creates a new work item.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

body
appIdstringRequired
Application identifier that is creating the work item.
resourceIdstringRequired
Resource identifier for tracking across application boundaries. Combined with appId to enforce uniqueness constraint.
namestringRequired

Human-readable name of the work item.

summarystringRequired
Brief summary of the work item.
viewstringRequired
Relative URL path to the UI view for this task.
groupsobjectRequired
Access control groups defining read and write permissions.
executionobjectRequired

Identifies the running job or session that invoked createWorkItem. Ancestry-derived fields (name, root execution metadata) are resolved internally.

variablesobjectRequired
Variables payload containing incoming workflow data.
descriptionstringOptional
Optional detailed description of the work item.

Response

Work item created successfully
workItemIdstringformat: "uuid"

Unique identifier (UUID) of the work item.

Errors

500
Internal Server Error