CRcraft
Work Items and OKRs

POST /item/{itemId}/dependency

Changed on

Create, retype, or remove a dependency between two items — work items (epics, features, stories, bugs, tasks, requirements) and/or portfolio initiatives. Products, OKRs, key results and super-initiatives cannot have dependencies and are rejected (422) on create/retype; remove is allowed regardless of type. Upsert — creates the relation or changes its type; remove: true deletes it (idempotent — removing an absent dependency returns 200 with removed=false). Directional from the path item: "item <type> relatedItem". Relation types: blocks, blocked by, related. Read dependencies via get_item fields=all.

Request

  • Base URL
    https://api.craft.io
  • URL
    https://api.craft.io/item/{itemId}/dependency
  • Auth
    API key in header x-api-key

Path parameters

itemIdstring required

Request body

relatedItemIdstring required

The other item in the relation: numeric ID or shortId KEY-N.

typestring

Relation type, directional from the path item: "item <type> relatedItem". One of blocks, blocked by, related. Required unless remove=true. Typed string (not a union) so an invalid value gets one clear controller message ("type must be one of: …") instead of a raw tsoa union error.

removeboolean

true = delete the dependency between the two items (type is ignored).

Response

The resulting dependency

itemIdstring required
relatedItemIdstring required
type'blocks' | 'blocked by' | 'related' nullable required
removedboolean required

Changes

  • 6009bb084cb5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status