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.
get_item_screen
Discover available fields for creating or updating an item. Returns field definitions, types, required flags, default values, and valid options. List fields include selectable options inline. Picker fields include ascope and pickerHint indicating which tool to call for valid entity IDs.
Parameters
Returns
AnItemScreenDto containing:
stage— the requested stage (createorupdate)fields— list ofItemScreenFieldDto:
workflow— available status transitions withstatusId,statusValue, andphase
get_item
Get a single work item by ID or key (e.g.GEM-123). Returns item details including status, priority, assignment, and time logged.
Parameters
Returns
ACycleItemDto with the item’s key, name, url, status, container, board, cycle, work estimate, time logged, and resource assignment. The url field links directly to the item in the Ekso web app. Returns an error if the item is not found.
search_items
Search for work items by keyword across containers. Matches on item name or sequence number. For structured queries by field values (status, priority, etc.), usefilter_items instead.
Parameters
Returns
A list ofItemMatch objects, each containing:
itemId,itemName,itemSequence— item identitycontainerId,containerName,containerCode— container context
create_item
Create a new work item in the specified container with a given process type. Callget_item_screen with stage create first to discover available fields. Only include fields marked as required — optional fields (priority, severity, etc.) can be set later via update_item.
Parameters
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. Call get_item_screen with stage update and the itemId to discover updatable fields, current values, and valid workflow transitions.
Parameters
Returns
ACycleItemDto with the updated item details.
delete_item
Delete a work item by ID or key (e.g.GEM-123).
Parameters
Returns
A confirmation message with the deleted item’s key.copy_item
Duplicate a work item within the same container. Requires Add permission on the item’s container.Parameters
Returns
ACycleItemDto with the newly created copy’s details.
plan_item
Assign a work item to a board and cycle, optionally assigning a resource.Parameters
Returns
ACycleItemDto with the updated planning details.
unplan_item
Remove an item from its board and cycle, clearing all planning fields (board, cycle, resource).Parameters
Returns
ACycleItemDto with the cleared planning fields.
get_items_by_resource
Get work items assigned to a specific user, filtered by the current user’s visibility permissions. For filtering by multiple criteria, usefilter_items with resource conditions.
Parameters
Returns
A list ofCycleItemDto objects for items assigned to the specified user.
get_item_dependencies
Get the full dependency tree for a work item. Requires View permission on the container and FieldView permission on the dependency field.Parameters
Returns
A list ofCycleItemDto objects representing the dependency tree, filtered to items the current user can see.
add_item_dependency
Add a parent-child dependency between two work items. Both IDs support key format (e.g.GEM-123). Requires View permission on both items.