Issue

Shape

• created_atstring
• created_byActorSummaryWho created the work item, as they were when they created it.

  • The ActorSummary schema
  • emailstring
  • idstring
  • usernamestring
  • avatar_urlstring or nulloptional
• iidIssueId (integer · int64)
• root_scope_idGroupId (string · uuid)The top-level group the item's group or repository belongs to.
• scope_idstring
• scope_typeScopeTypegrouprepositoryWhether the item lives in a group or a repository. With scope_id and iid it forms the item's current address — the #412 a person types — which changes when the item moves.
• status_categoryStatusCategorytriagetodoin_progressin_reviewblockeddonecancelledThe fixed category of the item's current status, which boards, filters and progress rollups work from.
• status_idStatusId (string)
• titleIssueTitle (string)
• uidIssueUid (string · uuid)The work item's permanent identifier. Unlike its number, it never changes, even when the item moves to another group or repository.
• updated_atstringWhen the work item last changed, ISO 8601. Listings order by it, newest first.
• 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.
• ancestor_group_idsarray of GroupId (string · uuid)optionalThe groups the item sits beneath, nearest first.
• ancestor_issue_uidsarray of IssueUid (string · uuid)optionalThe item's ancestors' permanent identifiers, nearest first, for display. It can briefly lag behind a change of parent higher up the chain.
• assignee_idsarray of PrincipalId (string · uuid)optionalThe people assigned to the work item. Absent when nobody is.
• author_can_pushboolean or nulloptionalWhether the author can push to where this work item lives — its repository, or a group work item's group. False for a drive-by contributor's text. Absent where it was not computed.
• closed_atstring or nulloptional
• closed_byPrincipalId (string · uuid) or nulloptional
• descriptionMarkdownDoc (string) or nulloptional
• labelsarray of LabelKey (string)optionalThe keys of the labels applied to the work item. Absent when it has none.
• milestone_idMilestoneId (string · uuid) or nulloptional
• milestone_scope_idstring or nulloptional
• milestone_scope_typeScopeTypegrouprepositoryor nulloptionalWhether the item's milestone belongs to a group or a repository — not necessarily the item's own, since a group milestone can hold work items from several repositories.
• parent_refIssueRef or nulloptionalThe parent's current address, for display. Absent when the item has no parent.

  • The IssueRef schema
  • iidIssueId (integer · int64)
  • scopeScopeRef
• parent_uidIssueUid (string · uuid) or nulloptionalThe parent work item's permanent identifier, if the item has a parent.
• pointsinteger · int32 or nulloptional0–∞
• regressed_atstring or nulloptional
• regressed_at_shaCommitHash (string) or nulloptionalThe commit whose evidence proved the regression — the first known bad commit, and the upper end of the range of suspect commits.
• regressed_from_shaCommitHash (string) or nulloptionalThe commit at which the item was last verified, kept when it regresses — the last known good commit.
• regressed_run_idPipelineRunId (string · uuid) or nulloptional
• severitySeveritycriticalhighmediumlowor nulloptional
• type_profileBlueprintRef or nulloptionalThe custom type this item was filed as, pointing at the group or repository where the blueprint is defined. work_item_type still decides where the item may live, its children and its fields; the blueprint adds a display label and facets. Absent for an item filed as a plain built-in type.

  • The BlueprintRef schema
  • blueprint_idBlueprintId (string)
  • scopeScopeRef
• verificationVerificationStateunverifiedverifiedregressedoptionalWhether CI has proved the work item's acceptance criteria. unverified until a pipeline run proves them, verified once one has, and regressed when a later run shows that evidence no longer holds.
• verified_atstring or nulloptional
• verified_at_shaCommitHash (string) or nulloptionalThe commit at which CI proved the acceptance criteria. Absent until a pipeline run has.
• verified_run_idPipelineRunId (string · uuid) or nulloptional
• versioninteger · int64optional0–∞The work item's revision, incremented on every change. Send it back with an update; if the item has changed since you read it, the update is refused with a 409.

Graph

Used by