Submit an answer and advance the execution

POST

https://staging.cail.health/v1/pathway-executions/:id/answers

Submits the option the member selected for the current question node and returns the next node to render. If the engine has reached a terminal, next.kind is terminal and the execution has been transitioned to completed. The nodeId in the request is checked against the engine’s current node; mismatches return a contract error code and the client should refetch the current node. The Idempotency-Key header is REQUIRED. Same key with the same body within the dedup window returns the cached response; same key with a different body returns a conflict error. Empty branchCode is permitted on info nodes (single implicit branch).

Submits the option the member selected for the current question node and returns the next node to render. If the engine has reached a terminal, `next.kind` is `terminal` and the execution has been transitioned to `completed`. The `nodeId` in the request is checked against the engine’s current node; mismatches return a contract error code and the client should refetch the current node. The `Idempotency-Key` header is REQUIRED. Same key with the same body within the dedup window returns the cached response; same key with a different body returns a conflict error. Empty `branchCode` is permitted on `info` nodes (single implicit branch).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Stable identifier of the pathway execution.

Request

This endpoint expects an object.

nodeIdstringRequired<=128 characters

Identifier of the node the client believes it is answering. The engine rejects mismatches with a contract error code; refetch the current node and retry.

branchCodestringRequired<=128 characters

Selected option code. Empty string is permitted on info nodes (single implicit branch). Validated against the current node’s published options.

Response

The next node to render.

nextobject

Next node to render. When next.kind is terminal, the engine has already transitioned the execution to completed.

$	curl -X POST https://staging.cail.health/v1/pathway-executions/2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f/answers \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"nodeId": "q.acute_chest_pain",
>	"branchCode": "yes"
>	}'

1	{
2	"next": {
3	"nodeId": "q.duration",
4	"kind": "question",
5	"prompt": {
6	"code": "q.duration",
7	"text": "How long has it lasted?"
8	},
9	"options": [
10	{
11	"code": "under_30m",
12	"text": "Under 30 minutes"
13	},
14	{
15	"code": "over_30m",
16	"text": "30 minutes or more"
17	}
18	]
19	}
20	}