Items carry a dynamic set of fields controlled by their process and container permissions. To understand the field model, available field types, and how to discover which fields you can set, see Items and fields.
create_item
Create a new work item in the specified container with a given process type.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
containerId | string | Yes | Container to create the item in. Use get_containers to find IDs. |
processId | string | Yes | Process type for the item. Use get_container_process_list to find IDs. |
name | string | Yes | Item name/title. |
description | string | No | Item description. |
priorityId | string | No | Priority value ID. Use get_priority_list for valid values. |
severityId | string | No | Severity value ID. Use get_severity_list for valid values. |
fieldsJson | string | No | Additional fields as JSON: [{"fieldId":"<id>","value":"<value>"}] |
Returns
ACycleItemDto with the created item’s key, name, status, container, and planning details.
update_item
Update an existing work item. Supports item ID or key format (e.g.GEM-123). Only provided fields are updated.
| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
itemId | string | Yes | Item ID or key (e.g. GEM-123). |
name | string | No | New item name. |
statusId | string | No | Status value ID. Use get_status_list. |
priorityId | string | No | Priority value ID. Use get_priority_list. |
severityId | string | No | Severity value ID. Use get_severity_list. |
resolutionId | string | No | Resolution value ID. Use get_resolution_list. |
fieldsJson | string | No | Additional fields as JSON: [{"fieldId":"<id>","value":"<value>"}] |
Returns
ACycleItemDto with the updated item details.
plan_item
Assign a work item to a board and cycle, optionally assigning a resource.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
itemId | string | Yes | Item ID or key. |
boardId | string | Yes | Target board ID. Use get_board_cycle. |
cycleId | string | Yes | Target cycle ID. Use get_board_cycle. |
resourceId | string | No | User or job role ID to assign. |
resourceType | string | No | User or JobRole. Required when resourceId is provided. |
Returns
ACycleItemDto with the updated planning details.
unplan_item
Remove an item from its board and cycle, clearing all planning fields (board, cycle, resource).| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
itemId | string | Yes | Item ID or key. |
Returns
ACycleItemDto with the cleared planning fields.