TRANXACT.AI Help

Platform · Health

Work Processes

Every request, background worker and batch run on every container, each tied to the database backend it is using, and every backend tied back to the work that sent it. Cancel a runaway statement or end a stuck backend.

Type REST3 operationsBase path /api/platform/monitor-processes

Download specification (OpenAPI 3.1) Screen: Work Processes

Overview

PackagePlatform
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Platform › Work Processes on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

3 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/platform/monitor-processesRead work processes

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/monitor-processes" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/monitor-processes/cancelCancel

Request body

The keys this action reads (* = required; "one of" lists the only values):

kind, id, instance; items: [{ kind, id }]

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/monitor-processes/cancel" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"kind":"value","id":"value","instance;":"value"}'
DELETE/api/platform/monitor-processes/{pid}Delete work processes

Path parameters

NameTypeDescription
pidstring (uuid)The record's pid, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/platform/monitor-processes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Platform › Work Processes for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.