Skip to content
GitmoapAPIBeta
Schema

UpdateBlueprintRequest

Replace a blueprint as a whole. Work items already filed as it keep their criteria; apply the blueprint to a work item again to add any new facets to it.

Shape

  • base_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.
  • namestring
  • versioninteger · int640–∞The version you last read. The update is refused with a 409 if the blueprint changed since.
  • archivedbooleanoptional
  • descriptionstring or nulloptional
  • facetsarray of FacetTemplateoptional
    • 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.

Example

Synthesized example
{
"base_type": "epic",
"name": "payments-api",
"version": 26,
"archived": false,
"description": "Renders each region as density contours of its operations.",
"facets": [
{
"category": "category-579c",
"key": "key-e900",
"label": "label-238e"
}
]
}

Graph

Used inside

No schema contains this one.

Used by