TRANXACT.AI Help

Platform · Business Flows

Scenario Steps

The call each step makes, with tokens for the parts that vary. {{ref:module/resource}} picks an existing record; {{prev.x}} takes it from the step before.

Type REST6 operationsBase path /api/platform/scenario-stepsPublished as /api/v1/scenario-steps

Download specification (OpenAPI 3.1) Screen: Scenario Steps

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 › Scenario Steps 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.
Tableflow.scenario_steps
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/platform/scenario-stepsList scenario steps

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "scenario_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "step_no": 10,
      "name": "Example",
      "flow_step_code": "FLO-000001",
      "method": "POST",
      "path": "text",
      "body": {},
      "depends_on": 10,
      "captures": {},
      "optional": true,
      "note": "text",
      "created_at": "2026-10-30T09:00:00Z",
      "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/platform/scenario-steps?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/scenario-steps/{id}Read one scenario steps

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "scenario_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "step_no": 10,
  "name": "Example",
  "flow_step_code": "FLO-000001",
  "method": "POST",
  "path": "text",
  "body": {},
  "depends_on": 10,
  "captures": {},
  "optional": true,
  "note": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/platform/scenario-steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/scenario-stepsCreate a scenario steps

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
scenario_iduuidYesScenario
step_nointegerYesStep
nametextYesName
flow_step_codetextNoFlow step
methodtextNoMethod
Allowed: POST GET PUT PATCH
pathtextYesPath
bodyjsonbNoBody
depends_onintegerNoDepends on step
capturesjsonbNoCaptures
optionalbooleanNoMay not apply
notetextNoNote

Sample body

{
  "scenario_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "step_no": 10,
  "name": "Example",
  "path": "text",
  "flow_step_code": "FLO-000001",
  "method": "POST",
  "body": {},
  "depends_on": 10
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "scenario_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "step_no": 10,
  "name": "Example",
  "flow_step_code": "FLO-000001",
  "method": "POST",
  "path": "text",
  "body": {},
  "depends_on": 10,
  "captures": {},
  "optional": true,
  "note": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/scenario-steps" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"scenario_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","step_no":10,"name":"Example","path":"text","flow_step_code":"FLO-000001","method":"POST","body":{},"depends_on":10}'
PUT/api/platform/scenario-steps/{id}Change a scenario steps

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
scenario_iduuidYesScenario
step_nointegerYesStep
nametextYesName
flow_step_codetextNoFlow step
methodtextNoMethod
Allowed: POST GET PUT PATCH
pathtextYesPath
bodyjsonbNoBody
depends_onintegerNoDepends on step
capturesjsonbNoCaptures
optionalbooleanNoMay not apply
notetextNoNote

Sample body

{
  "scenario_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "step_no": 10
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "scenario_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "step_no": 10,
  "name": "Example",
  "flow_step_code": "FLO-000001",
  "method": "POST",
  "path": "text",
  "body": {},
  "depends_on": 10,
  "captures": {},
  "optional": true,
  "note": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/platform/scenario-steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"scenario_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","step_no":10}'
DELETE/api/platform/scenario-steps/{id}Delete a scenario steps

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/platform/scenario-steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/scenario-steps/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

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

overrides, preview, withLines

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/scenario-steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a scenario steps, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
scenario_iduuidread, writeScenario
step_nointegerread, writeStep
nametextread, writeName
flow_step_codetextread, writeFlow step
methodtextread, writeMethod
Allowed: POST GET PUT PATCH
pathtextread, writePath
bodyjsonbread, writeBody
depends_onintegerread, writeDepends on step
capturesjsonbread, writeCaptures
optionalbooleanread, writeMay not apply
notetextread, writeNote
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

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 › Scenario Steps 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.