IssueRollup
A work item's progress, computed from its children. It counts only the children you can see, and reports no hidden total.
Shape
- cancelledinteger · int320–∞
childrenarray of IssueChildLink
- The IssueChildLink schema
child_refIssueRefThe child's current address: the group or repository it lives in, and its number there.
- The IssueRef schema
- iidIssueId (integer · int64)
- scopeScopeRef
- child_uidIssueUid (string · uuid)The child's permanent identifier.
- linked_atstring
- status_categoryStatusCategorytriagetodoin_progressin_reviewblockeddonecancelledThe status category the child is in.
- work_item_typeWorkItemTypeepicstorybugtaskspikechoreincidentsub_taskThe kind of work item. The type decides where an item may live (a group or a repository), which types it may have as children, and which fields it accepts.
- pointsinteger · int32 or nulloptional0–∞
- completedinteger · int320–∞Children in the
donecategory only. A cancelled child is closed but not completed, and is counted incancelled. - openinteger · int320–∞
- points_completedinteger · int320–∞
- points_totalinteger · int320–∞
- totalinteger · int320–∞
Example
Synthesized example{
"cancelled": 59,
"children": [
{
"child_ref": {
"iid": 55,
"scope": {
"group": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
}
},
"child_uid": "4e094d80-ee37-47c6-ae13-1d6017252349",
"linked_at": "2026-10-12T18:42:34Z",
"status_category": "triage",
"work_item_type": "epic"
},
{
"child_ref": {
"iid": 15,
"scope": {
"group": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
}
},
"child_uid": "396734ac-1ac6-4794-a5ed-e7fc381a4712",
"linked_at": "2026-10-14T09:39:00Z",
"status_category": "triage",
"work_item_type": "epic"
}
],
"completed": 64,
"open": 23,
"points_completed": 23,
"points_total": 2,
"total": 3
}
Graph
Used inside
Contains
Used by
Sent by 0 operations
No operation takes it as a request body.
Returned by 6 operations
- GETList a group subtree's work items as cards/groups/{group_id}/issues/cards
- GETRoll up a group work item's children/groups/{group_id}/issues/{issue_id}/rollup
- GETList a repository's work items as cards/repositories/{repo_id}/issues/cards
- GETRoll up a repository work item's children/repositories/{repo_id}/issues/{issue_id}/rollup
- GETList the work items assigned to the caller as cards/user/issues/cards
- GETList the work items the caller reported as cards/user/reported-issues/cards