get_workitem_schema
Retrieves work item type schema for a project area.
Purpose
This tool fetches the complete schema definition for work item types in a project area, including attributes, enumerations, workflows, and link types. The schema information is essential for building search filters and understanding available work item fields. You can retrieve schema for a specific work item type or for all types in the project area. Categories and releases are excluded from the schema and must be fetched separately using list_workitem_categories and list_workitem_releases.
Tags: CCM | Read | Standard
Input parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| project_area_item_id | string | Yes | Project area item ID | _LffMgzPzEfGBT6ihmWSqcQ |
| workitem_type | string | No | Optional type filter | defect |
Output schema
| Field | Type | Description |
|---|---|---|
| projectAreaId | string | Project area item ID |
| projectAreaName | string | Human-readable project area name |
| workItemTypes | array | Array of work item type objects (filtered if workitem_type specified) |
- workItemTypes array elements:
-
Field Type Description id string Work item type identifier name string Display name of the work item type attributes array Array of attribute definition objects enumerations array Array of enumeration definition objects workflows array Array of workflow state objects linkTypes array Array of available link type objects
Common use cases
- Building search filters with correct attribute IDs
- Understanding available work item fields
- Validating work item type configurations
- Extracting enumeration values for filters