Get workflow readiness for a component

GET

/api/components/{id}/workflow_state

Returns where the component stands across the authoring, lock, review, comment, triage, and export stages — SQL-aggregated counts plus the comment-phase write-guard booleans. Access matches the component show rules: released components are readable by any authenticated user; unreleased ones require viewer permission.

Authorizations

tokenAuth

Personal access token authentication. Send via Authorization header: Authorization: Token vulcan_xxx. Tokens are SHA-256 hashed server-side (never stored in plaintext). Scopes: read (GET), write (mutations), admin (everything). Create tokens via Settings → API Tokens in the web UI.

Type

HTTP (token)

Parameters

Path Parameters

id*

Numeric ID of the component.

Type

integer

Required

Example38

Responses

Component workflow state

Content-Type

application/json

{

  

"document_type": "stig",

  

"authoring": {

  

  

"rules_total": 203,

  

  

"rules_determined": 153

  

},

  

"locks": {

  

  

"locked": 25,

  

  

"total": 203,

  

  

"all_locked": false

  

},

  

"reviews": {

  

  

"under_review": 4

  

},

  

"comment": {

  

  

"phase": "open",

  

  

"accepting_new_comments": true,

  

  

"triaging_active": true,

  

  

"frozen_for_writes": false,

  

  

"pending_comments": 3

  

},

  

"triage": {

  

  

"pending": 3,

  

  

"awaiting_adjudication": 1

  

},

  

"export": {

  

  

"released": false,

  

  

"releasable": false

  

}

}

GET

/api/components/{id}/workflow_state

Playground

Server

Authorization

tokenAuth

Variables

Key

Value

id*

Samples

Powered by VitePress OpenAPI