Investigations

Multi-step investigations in Step, Plan or Auto mode; every plan and result waits for a person.

get

/v1/investigations

Investigations in the caller's outlet scope, most recently changed first; ?status= one status

operationId listInvestigations

Auth

Member token+Tenant header

Parameters

statusin queryenum (7)optional
openwaitingdoneno_driver_foundcannot_verifycancelledexhausted
cursorin querystringoptional
limitin queryintegeroptional

Response 200

V1InvestigationsResponsecontract v1.investigations.response

itemsarray of objectrequired
- investigation_idUuid7required
- playbook_idenum (1)required
  margin_fall
- paramsobjectrequired
  - period_monthstring (date)required
    pattern ^(?:(?:[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)required
    pattern ^(?:(?:[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
- created_byUuid7required
- steps_doneintegerrequired
  ≥ 0≤ 9007199254740991
- max_stepsintegerrequired
  ≥ 1≤ 10
- created_atIsoDatetimerequired
- updated_atIsoDatetimerequired
next_cursorstring | nullrequired

Errors

400Bad requestError
401UnauthenticatedError
403Not allowedError
404Not foundError
422Validation failedError

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/investigations

Open 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

operationId createInvestigation

Auth

Member token+Tenant header

Request body

V1InvestigationCreateRequestcontract v1.investigation.create.request

investigation_idUuid7required
playbook_idenum (1)required
margin_fall
paramsobjectrequired
- period_monthstring (date)required
  pattern ^(?:(?:[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)required
  pattern ^(?:(?:[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 2optional
modeenum (3)optional
stepplanauto

Response 201

V1Investigationcontract v1.investigation

investigation_idUuid7required
playbook_idenum (1)required
margin_fall
paramsobjectrequired
- period_monthstring (date)required
  pattern ^(?:(?:[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)required
  pattern ^(?:(?:[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
created_byUuid7required
steps_doneintegerrequired
≥ 0≤ 9007199254740991
max_stepsintegerrequired
≥ 1≤ 10
created_atIsoDatetimerequired
updated_atIsoDatetimerequired
checklistarray of objectrequired
- item_idstringrequired
  pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- label_keystringrequired
  min length 1
- specialistenum (8)required
  cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
- signatureobjectrequired
  - keyconst "investigation.signature.specialist"required
  - specialistenum (8)required
    cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
  - name_keystringrequired
    min length 1
- statusenum (5)required
  pendingsupportedrefutedcannot_verifyrestricted
- frozenbooleanrequired
- snapshot_idsarray of Uuid7required
- refsarray of stringrequired
planobject | nullrequired
- itemsarray of objectrequired
  min items 1
  - item_idstringrequired
    pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
  - label_keystringrequired
    min length 1
  - specialistenum (8)required
    cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
- specialistsarray of enum (8)required
  min items 1
- estimateobjectrequired
  - labelconst "estimate (computed)"required
  - statusenum (2)required
    computedcannot_verify
  - snapshot_idUuid7 | nullrequired
  - estimate_refstring | nullrequired
    pattern ^⟨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 | nullrequired
    pattern ^⟨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_]*⟩$
- approved_byUuid7 | nullrequired
- approved_atIsoDatetime | nullrequired
stepsarray of objectrequired
- step_nointegerrequired
  ≥ 1≤ 9007199254740991
- member_idUuid7required
- triggered_byenum (3)required
  memberplanauto
- started_atIsoDatetimerequired
- item_updatesarray of objectrequired
  - item_idstringrequired
    pattern ^[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
  - snapshot_idsarray of Uuid7required
  - refsarray of stringrequired
- taintedbooleanrequired
- narrationobject | nullrequired
  - answer_idUuid7required
  - envelopeAnswerEnveloperequired
  - signaturesarray of objectrequired
    Show fields of signatures
    - keyconst "investigation.signature.specialist"required
    - specialistenum (8)required
      cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
    - name_keystringrequired
      min length 1
resolved_refsarray of objectrequired
- refRefrequired
- valueone of 3 | nullrequired

Errors

400Bad requestError
401UnauthenticatedError
403Not allowedError
404Not foundError
409ConflictError
422Validation failedError

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

get

/v1/investigations/{id}

An investigation with its checklist, steps and narrations (404 outside the caller's outlet scope)

operationId getInvestigation

Auth

Member token+Tenant header

Parameters

idin pathstringrequired
pattern ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Response 200

V1Investigationcontract v1.investigation

investigation_idUuid7required
playbook_idenum (1)required
margin_fall
paramsobjectrequired
- period_monthstring (date)required
  pattern ^(?:(?:[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)required
  pattern ^(?:(?:[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
created_byUuid7required
steps_doneintegerrequired
≥ 0≤ 9007199254740991
max_stepsintegerrequired
≥ 1≤ 10
created_atIsoDatetimerequired
updated_atIsoDatetimerequired
checklistarray of objectrequired
- item_idstringrequired
  pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- label_keystringrequired
  min length 1
- specialistenum (8)required
  cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
- signatureobjectrequired
  - keyconst "investigation.signature.specialist"required
  - specialistenum (8)required
    cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
  - name_keystringrequired
    min length 1
- statusenum (5)required
  pendingsupportedrefutedcannot_verifyrestricted
- frozenbooleanrequired
- snapshot_idsarray of Uuid7required
- refsarray of stringrequired
planobject | nullrequired
- itemsarray of objectrequired
  min items 1
  - item_idstringrequired
    pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
  - label_keystringrequired
    min length 1
  - specialistenum (8)required
    cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
- specialistsarray of enum (8)required
  min items 1
- estimateobjectrequired
  - labelconst "estimate (computed)"required
  - statusenum (2)required
    computedcannot_verify
  - snapshot_idUuid7 | nullrequired
  - estimate_refstring | nullrequired
    pattern ^⟨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 | nullrequired
    pattern ^⟨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_]*⟩$
- approved_byUuid7 | nullrequired
- approved_atIsoDatetime | nullrequired
stepsarray of objectrequired
- step_nointegerrequired
  ≥ 1≤ 9007199254740991
- member_idUuid7required
- triggered_byenum (3)required
  memberplanauto
- started_atIsoDatetimerequired
- item_updatesarray of objectrequired
  - item_idstringrequired
    pattern ^[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
  - snapshot_idsarray of Uuid7required
  - refsarray of stringrequired
- taintedbooleanrequired
- narrationobject | nullrequired
  - answer_idUuid7required
  - envelopeAnswerEnveloperequired
  - signaturesarray of objectrequired
    Show fields of signatures
    - keyconst "investigation.signature.specialist"required
    - specialistenum (8)required
      cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
    - name_keystringrequired
      min length 1
resolved_refsarray of objectrequired
- refRefrequired
- valueone of 3 | nullrequired

Errors

400Bad requestError
401UnauthenticatedError
403Not allowedError
404Not foundError
422Validation failedError

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/investigations/{id}:continue

Run exactly the named next step: mint, judge in code, store, narrate

operationId continueInvestigation

Auth

Member token+Tenant header

Parameters

idin pathstringrequired
pattern ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

V1InvestigationContinueRequestcontract v1.investigation.continue.request

step_nointegerrequired
≥ 1≤ 10

Response 200

V1Investigationcontract v1.investigation

investigation_idUuid7required
playbook_idenum (1)required
margin_fall
paramsobjectrequired
- period_monthstring (date)required
  pattern ^(?:(?:[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)required
  pattern ^(?:(?:[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
created_byUuid7required
steps_doneintegerrequired
≥ 0≤ 9007199254740991
max_stepsintegerrequired
≥ 1≤ 10
created_atIsoDatetimerequired
updated_atIsoDatetimerequired
checklistarray of objectrequired
- item_idstringrequired
  pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- label_keystringrequired
  min length 1
- specialistenum (8)required
  cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
- signatureobjectrequired
  - keyconst "investigation.signature.specialist"required
  - specialistenum (8)required
    cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
  - name_keystringrequired
    min length 1
- statusenum (5)required
  pendingsupportedrefutedcannot_verifyrestricted
- frozenbooleanrequired
- snapshot_idsarray of Uuid7required
- refsarray of stringrequired
planobject | nullrequired
- itemsarray of objectrequired
  min items 1
  - item_idstringrequired
    pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
  - label_keystringrequired
    min length 1
  - specialistenum (8)required
    cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
- specialistsarray of enum (8)required
  min items 1
- estimateobjectrequired
  - labelconst "estimate (computed)"required
  - statusenum (2)required
    computedcannot_verify
  - snapshot_idUuid7 | nullrequired
  - estimate_refstring | nullrequired
    pattern ^⟨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 | nullrequired
    pattern ^⟨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_]*⟩$
- approved_byUuid7 | nullrequired
- approved_atIsoDatetime | nullrequired
stepsarray of objectrequired
- step_nointegerrequired
  ≥ 1≤ 9007199254740991
- member_idUuid7required
- triggered_byenum (3)required
  memberplanauto
- started_atIsoDatetimerequired
- item_updatesarray of objectrequired
  - item_idstringrequired
    pattern ^[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
  - snapshot_idsarray of Uuid7required
  - refsarray of stringrequired
- taintedbooleanrequired
- narrationobject | nullrequired
  - answer_idUuid7required
  - envelopeAnswerEnveloperequired
  - signaturesarray of objectrequired
    Show fields of signatures
    - keyconst "investigation.signature.specialist"required
    - specialistenum (8)required
      cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
    - name_keystringrequired
      min length 1
resolved_refsarray of objectrequired
- refRefrequired
- valueone of 3 | nullrequired

Errors

400Bad requestError
401UnauthenticatedError
403Not allowedError
404Not foundError
409ConflictError
422Validation failedError

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/investigations/{id}:cancel

Cancel an open or waiting investigation (its creator); a repeat is a replay, a later :continue is 409

operationId cancelInvestigation

Auth

Member token+Tenant header

Parameters

idin pathstringrequired
pattern ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

V1InvestigationCancelRequestcontract v1.investigation.cancel.request

Response 200

V1Investigationcontract v1.investigation

investigation_idUuid7required
playbook_idenum (1)required
margin_fall
paramsobjectrequired
- period_monthstring (date)required
  pattern ^(?:(?:[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)required
  pattern ^(?:(?:[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
created_byUuid7required
steps_doneintegerrequired
≥ 0≤ 9007199254740991
max_stepsintegerrequired
≥ 1≤ 10
created_atIsoDatetimerequired
updated_atIsoDatetimerequired
checklistarray of objectrequired
- item_idstringrequired
  pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- label_keystringrequired
  min length 1
- specialistenum (8)required
  cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
- signatureobjectrequired
  - keyconst "investigation.signature.specialist"required
  - specialistenum (8)required
    cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
  - name_keystringrequired
    min length 1
- statusenum (5)required
  pendingsupportedrefutedcannot_verifyrestricted
- frozenbooleanrequired
- snapshot_idsarray of Uuid7required
- refsarray of stringrequired
planobject | nullrequired
- itemsarray of objectrequired
  min items 1
  - item_idstringrequired
    pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
  - label_keystringrequired
    min length 1
  - specialistenum (8)required
    cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
- specialistsarray of enum (8)required
  min items 1
- estimateobjectrequired
  - labelconst "estimate (computed)"required
  - statusenum (2)required
    computedcannot_verify
  - snapshot_idUuid7 | nullrequired
  - estimate_refstring | nullrequired
    pattern ^⟨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 | nullrequired
    pattern ^⟨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_]*⟩$
- approved_byUuid7 | nullrequired
- approved_atIsoDatetime | nullrequired
stepsarray of objectrequired
- step_nointegerrequired
  ≥ 1≤ 9007199254740991
- member_idUuid7required
- triggered_byenum (3)required
  memberplanauto
- started_atIsoDatetimerequired
- item_updatesarray of objectrequired
  - item_idstringrequired
    pattern ^[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
  - snapshot_idsarray of Uuid7required
  - refsarray of stringrequired
- taintedbooleanrequired
- narrationobject | nullrequired
  - answer_idUuid7required
  - envelopeAnswerEnveloperequired
  - signaturesarray of objectrequired
    Show fields of signatures
    - keyconst "investigation.signature.specialist"required
    - specialistenum (8)required
      cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
    - name_keystringrequired
      min length 1
resolved_refsarray of objectrequired
- refRefrequired
- valueone of 3 | nullrequired

Errors

400Bad requestError
401UnauthenticatedError
403Not allowedError
404Not foundError
409ConflictError
422Validation failedError

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/v1/investigations/{id}:approve-plan

Approve 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

operationId approveInvestigationPlan

Auth

Member token+Tenant header

Parameters

idin pathstringrequired
pattern ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

V1InvestigationApprovePlanRequestcontract v1.investigation.approve-plan.request

modeenum (2)optional
planauto

Response 200

V1Investigationcontract v1.investigation

investigation_idUuid7required
playbook_idenum (1)required
margin_fall
paramsobjectrequired
- period_monthstring (date)required
  pattern ^(?:(?:[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)required
  pattern ^(?:(?:[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
created_byUuid7required
steps_doneintegerrequired
≥ 0≤ 9007199254740991
max_stepsintegerrequired
≥ 1≤ 10
created_atIsoDatetimerequired
updated_atIsoDatetimerequired
checklistarray of objectrequired
- item_idstringrequired
  pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
- label_keystringrequired
  min length 1
- specialistenum (8)required
  cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
- signatureobjectrequired
  - keyconst "investigation.signature.specialist"required
  - specialistenum (8)required
    cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
  - name_keystringrequired
    min length 1
- statusenum (5)required
  pendingsupportedrefutedcannot_verifyrestricted
- frozenbooleanrequired
- snapshot_idsarray of Uuid7required
- refsarray of stringrequired
planobject | nullrequired
- itemsarray of objectrequired
  min items 1
  - item_idstringrequired
    pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
  - label_keystringrequired
    min length 1
  - specialistenum (8)required
    cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
- specialistsarray of enum (8)required
  min items 1
- estimateobjectrequired
  - labelconst "estimate (computed)"required
  - statusenum (2)required
    computedcannot_verify
  - snapshot_idUuid7 | nullrequired
  - estimate_refstring | nullrequired
    pattern ^⟨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 | nullrequired
    pattern ^⟨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_]*⟩$
- approved_byUuid7 | nullrequired
- approved_atIsoDatetime | nullrequired
stepsarray of objectrequired
- step_nointegerrequired
  ≥ 1≤ 9007199254740991
- member_idUuid7required
- triggered_byenum (3)required
  memberplanauto
- started_atIsoDatetimerequired
- item_updatesarray of objectrequired
  - item_idstringrequired
    pattern ^[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
  - snapshot_idsarray of Uuid7required
  - refsarray of stringrequired
- taintedbooleanrequired
- narrationobject | nullrequired
  - answer_idUuid7required
  - envelopeAnswerEnveloperequired
  - signaturesarray of objectrequired
    Show fields of signatures
    - keyconst "investigation.signature.specialist"required
    - specialistenum (8)required
      cataloguekitcheninventory_purchasingfinancepeoplecustomerscompliancemarket
    - name_keystringrequired
      min length 1
resolved_refsarray of objectrequired
- refRefrequired
- valueone of 3 | nullrequired

Errors

400Bad requestError
401UnauthenticatedError
403Not allowedError
404Not foundError
409ConflictError
422Validation failedError

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.