Skip to content
GitmoapAPIBeta
Schema

CreateBlueprintRequest

Create a blueprint on a scope.

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.
  • blueprint_idBlueprintId (string)The custom-type slug, unique within the scope.
  • namestring
  • 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",
"blueprint_id": "902dd8fd-c4da-44d9-9aa5-a49834a6ae3c",
"name": "payments-api",
"description": "Renders each region as density contours of its operations.",
"facets": [
{
"category": "category-cbfa",
"key": "key-c843",
"label": "label-a5cb"
},
{
"category": "category-ed1b",
"key": "key-addf",
"label": "label-0107"
}
]
}

Graph

Used inside

No schema contains this one.

Used by