Blueprint

Shape

• base_typeWorkItemTypeepicstorybugtaskspikechoreincidentsub_taskThe built-in type the custom type is based on, which decides where its items may live, their children and their fields. "API Feature" might be a story with a blueprint on top.
• blueprint_idBlueprintId (string)The blueprint's slug, unique within its group or repository. It never changes.
• created_atstring
• created_byActorSummaryWho created the blueprint, as they were when they created it.

  • The ActorSummary schema
  • emailstring
  • idstring
  • usernamestring
  • avatar_urlstring or nulloptional
• namestringThe custom type's display name, such as "API Feature".
• scope_idstring
• scope_typeScopeTypegrouprepository
• updated_atstring
• archivedbooleanoptionalHidden from the type picker; items already filed keep their type_profile.
• descriptionstring or nulloptional
• facetsarray of FacetTemplateoptionalThe blueprint's facets, in order.

  • The FacetTemplate schema
  • categoryFacetCategory (string)The facet's category — any value you choose. Facets with the same category are grouped together.
  • keyFacetKey (string)The facet's identifier within the blueprint. It stays the same when the label changes, so a work item re-applying the blueprint updates the facet in place.
  • labelstringThe facet's display name, such as "Observability".
  • bindingFacetBindingTemplateoptionalHow the seeded criterion is bound. Defaults to a manual checkbox.
  • hintstring or nulloptionalThe starter criterion's text. When absent the criterion is titled by the facet label.
  • requiredbooleanoptionalWhether the facet's criterion must be satisfied before the work item can be closed or verified. Defaults to true.
• versioninteger · int64optional0–∞The blueprint's revision, incremented on every change. An update must send the version it read, and is refused with a 409 if the blueprint changed since.

Graph

Used by