Skip to main content

Exceptions

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

soat.exceptions.listExceptions()​

List exception items

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

→ Request & response schema

soat.exceptions.getException()​

Get an exception item

  • Method: GET
  • Path: /api/v1/exceptions/{exception_id}
await soat.exceptions.getException();

→ Request & response schema

soat.exceptions.acknowledgeException()​

Acknowledge an exception item

  • Method: POST
  • Path: /api/v1/exceptions/{exception_id}/acknowledge
await soat.exceptions.acknowledgeException();

→ Request & response schema

soat.exceptions.resolveException()​

Resolve an exception item

  • Method: POST
  • Path: /api/v1/exceptions/{exception_id}/resolve
await soat.exceptions.resolveException({
  body: { /* + optional */ },
});

→ Request & response schema