get_workitem
Retrieves details of a work item by ID or OSLC URL.
Purpose
This tool fetches detailed information about a specific work item from Engineering Workflow Management. You can retrieve work items using either the work item ID or OSLC URL. By default, the tool returns a minimal set of attributes including work item type, ID, summary, description, owner, state, priority, severity, and modification date. Set fetch_all to true to retrieve complete information including comments, approvals, and links.
Tags: CCM | Read | Basic
Input parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| workitem_id | string | No | The ID of the work item to retrieve | 123 |
| workitem_oslc_url | string | No | Optional OSLC URL for work item | https://server/ccm/resource/itemName/com.ibm.team.workitem.WorkItem/123 |
| project_area_id | string | No | Optional project area item ID | _LffMgzPzEfGBT6ihmWSqcQ |
| fetch_all | boolean | No | Whether to fetch all data including comments, approvals, and links | false |
Note: Either workitem_id or workitem_oslc_url must be provided.
Output schema
- When
fetch_all=False(default - minimal set): -
id string Work item ID workItemType string Type of work item (e.g., "defect", "task", "story") summary string Brief summary of the work item description string Detailed description (may contain HTML) owner string Owner's user ID or email internalState string Current workflow state (e.g., "Open", "In Progress", "Resolved") internalPriority string Priority level (e.g., "High", "Medium", "Low") internalSeverity string Severity level (e.g., "Critical", "Major", "Minor") modified string Last modified timestamp (ISO 8601 format) oslc_url string OSLC URL for the work item - When
fetch_all=True(complete data): -
Field Type Description comments array Array of comment objects with text, author, and timestamp approvals array Array of approval objects with status and approvers links array Array of link objects showing relationships to other work items creator string User who created the work item created string Creation timestamp (ISO 8601 format) customAttributes object Project-specific custom attributes tags array Array of tag strings subscribers array Array of subscriber user IDs
Common use cases
- Retrieving work item details for AI analysis
- Checking work item status before updates
- Fetching work item information for reporting
- Validating work item existence before linking