Skip to main content

Deciders

SDK methods for the Deciders module, accessed via soat.deciders. See the Deciders module docs for permissions and data model, and each method's REST page for the full request/response schema.

soat.deciders.listDeciders()​

List deciders

  • Method: GET
  • Path: /api/v1/deciders
await soat.deciders.listDeciders({
  query: { /* + optional */ },
});

→ Request & response schema

soat.deciders.createDecider()​

Create a decider

  • Method: POST
  • Path: /api/v1/deciders
await soat.deciders.createDecider({
  body: { name, questions, /* + optional */ },
});

→ Request & response schema

soat.deciders.getDecider()​

Get a decider

  • Method: GET
  • Path: /api/v1/deciders/{decider_id}
await soat.deciders.getDecider({
  path: { decider_id },
});

→ Request & response schema

soat.deciders.updateDecider()​

Update a decider

  • Method: PATCH
  • Path: /api/v1/deciders/{decider_id}
await soat.deciders.updateDecider({
  path: { decider_id },
  body: { /* + optional */ },
});

→ Request & response schema

soat.deciders.deleteDecider()​

Delete a decider

  • Method: DELETE
  • Path: /api/v1/deciders/{decider_id}
await soat.deciders.deleteDecider({
  path: { decider_id },
});

→ Request & response schema

soat.deciders.listDeciderVersions()​

List a decider's versions

  • Method: GET
  • Path: /api/v1/deciders/{decider_id}/versions
await soat.deciders.listDeciderVersions({
  path: { decider_id },
});

→ Request & response schema

soat.deciders.getDeciderVersion()​

Fetch an archived decider version

  • Method: GET
  • Path: /api/v1/deciders/{decider_id}/versions/{version}
await soat.deciders.getDeciderVersion({
  path: { decider_id, version },
});

→ Request & response schema

soat.deciders.restoreDeciderVersion()​

Restore an archived decider version

  • Method: POST
  • Path: /api/v1/deciders/{decider_id}/versions/{version}/restore
await soat.deciders.restoreDeciderVersion({
  path: { decider_id, version },
  body: { /* + optional */ },
});

→ Request & response schema

soat.deciders.createDecision()​

Request a decision

  • Method: POST
  • Path: /api/v1/deciders/{decider_id}/decisions
await soat.deciders.createDecision({
  path: { decider_id },
  body: { input, /* + optional */ },
});

→ Request & response schema

soat.deciders.createInlineDecision()​

Request a decision with inline questions

  • Method: POST
  • Path: /api/v1/decisions
await soat.deciders.createInlineDecision({
  body: { questions, input, /* + optional */ },
});

→ Request & response schema

soat.deciders.listDecisions()​

List decisions

  • Method: GET
  • Path: /api/v1/decisions
await soat.deciders.listDecisions({
  query: { /* + optional */ },
});

→ Request & response schema

soat.deciders.getDecision()​

Get a decision

  • Method: GET
  • Path: /api/v1/decisions/{decision_id}
await soat.deciders.getDecision({
  path: { decision_id },
});

→ Request & response schema