API reference · Schema
V1Investigation
V1Investigationcontract v1.investigation
- playbook_idenum (1)required
margin_fall - paramsobjectrequired
- period_monthstring (date)requiredpattern ^(?:(?:[0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|(?:02)-(?:0[1-9]|1[0-9]|2[0-8])))$
- compare_monthstring (date)requiredpattern ^(?:(?:[0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|(?:02)-(?:0[1-9]|1[0-9]|2[0-8])))$
- outlet_scopeone of 2required
- modeenum (3)required
stepplanauto - statusenum (8)required
openwaitingdoneno_driver_foundcannot_verifycancelledexhaustedrestricted - stop_reasonenum (6) | nullrequired
draftabstainbudgetscopewaitingceiling - steps_doneintegerrequired≥ 0≤ 9007199254740991
- max_stepsintegerrequired≥ 1≤ 10
- checklistarray of objectrequired
- item_idstringrequiredpattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- label_keystringrequiredmin length 1
- specialistenum (8)required
cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket - signatureobjectrequired
- keyconst "investigation.signature.specialist"required
- specialistenum (8)required
cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket - name_keystringrequiredmin length 1
- statusenum (5)required
pendingsupportedrefutedcannot_verifyrestricted - frozenbooleanrequired
- refsarray of stringrequired
- planobject | nullrequired
- itemsarray of objectrequiredmin items 1
- item_idstringrequiredpattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- label_keystringrequiredmin length 1
- specialistenum (8)required
cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
- specialistsarray of enum (8)requiredmin items 1
- estimateobjectrequired
- labelconst "estimate (computed)"required
- statusenum (2)required
computedcannot_verify - estimate_refstring | nullrequiredpattern ^⟨snap:[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}·(?:0|[1-9][0-9]*)·[a-z_][a-z0-9_]*⟩$
- currency_refstring | nullrequiredpattern ^⟨snap:[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}·(?:0|[1-9][0-9]*)·[a-z_][a-z0-9_]*⟩$
- stepsarray of objectrequired
- step_nointegerrequired≥ 1≤ 9007199254740991
- triggered_byenum (3)required
memberplanauto - item_updatesarray of objectrequired
- item_idstringrequiredpattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- specialistenum (8)required
cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket - fromenum (5)required
pendingsupportedrefutedcannot_verifyrestricted - toenum (5)required
pendingsupportedrefutedcannot_verifyrestricted - frozenbooleanrequired
- reopenedbooleanrequired
- refsarray of stringrequired
- taintedbooleanrequired
- narrationobject | nullrequired
- signaturesarray of objectrequired
Show fields of signatures
- keyconst "investigation.signature.specialist"required
- specialistenum (8)required
cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket - name_keystringrequiredmin length 1
- resolved_refsarray of objectrequired
- valueone of 3 | nullrequired
Used by
- post/v1/investigationsOpen an investigation (Step or Plan mode, within the role's ceiling) for a playbook over the caller's outlet scope; the client's id is its idempotency key
- get/v1/investigations/{id}An investigation with its checklist, steps and narrations (404 outside the caller's outlet scope)
- post/v1/investigations/{id}:continueRun exactly the named next step: mint, judge in code, store, narrate
- post/v1/investigations/{id}:cancelCancel an open or waiting investigation (its creator); a repeat is a replay, a later :continue is 409
- post/v1/investigations/{id}:approve-planApprove a Plan-mode investigation (its creator, within the role's ceiling), as Plan or Auto, and run its steps inside this request until a stop