Start, advance, or probe Action Box wizard
POST /task/v1/actions/{feed-key}/action-box/flow
Operation id: actionBoxFlow
Description
Action Box flow endpoint for wizard navigation.
Modes:
- Start: body omitted or
{}(returns token + root buttons) - Advance: send
action_token+ non-finalselected_button - Probe: send only
action_token(noselected_button) to restore current state
Final-button selections must be submitted to /action-box/execute.
Tags: MyWorkFeedActions
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
feed-key | integer | Yes | Unique numeric feed identifier |
Security
- AuthTokenHeader (apiKey)
- Session authentication token validated server-side against the user session store.
Responses
200 — Success - {status: OK, action_box: {...}}
Content type: application/json
400 — Validation/business error. Examples:
E105—feed_key <= 0E159— non-numericfeed_keyE177— empty{feed_key}path segment (missing path variable)E372—selected_buttonis present but any ofbutton_id,button_key,box_id,track_id,track_labelis missing or blankE356,E361,E362,E369,E373,E374— Action Box wizard/business errors ForE361,responsemay contain a specific business reason from legacy action-box flow (not only the default "No actions available..." message).
Content type: application/json
401 — Token/auth mismatch (for example E357, E359, E367) or invalid session
Content type: application/json
404 — No action box configured for feed (E360)
Content type: application/json
500 — Unexpected server-side error
Content type: application/json
Request body
application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
action_token | string | No | Existing wizard token for advance/probe. |
selected_button | object | No | Echoed button metadata from prior flow response (for non-final advance). |
projections | array | No | Optional projections such as walk_status fields. |
msg_type | string | No | Optional message type override for initial start. |
is_update_status | boolean | No | Start shortcut for STATUS_BUTTON in ACTION_BOX_SETUP/SUPPORTED_ACTIONS. Mutually exclusive with other shortcut flags. |
is_reassign | boolean | No | Start shortcut for REASSIGN_BUTTON in ACTION_BOX_SETUP/SUPPORTED_ACTIONS. Mutually exclusive with other shortcut flags. |
is_other_button | boolean | No | Start shortcut for OTHER_BUTTON in ACTION_BOX_SETUP/SUPPORTED_ACTIONS. Mutually exclusive with other shortcut flags. |
{
"type": "object",
"properties": {
"action_token": {
"type": "string",
"description": "Existing wizard token for advance/probe."
},
"selected_button": {
"type": "object",
"description": "Echoed button metadata from prior flow response (for non-final advance)."
},
"projections": {
"type": "array",
"description": "Optional projections such as `walk_status` fields.",
"items": {
"type": "string"
}
},
"msg_type": {
"type": "string",
"description": "Optional message type override for initial start."
},
"is_update_status": {
"type": "boolean",
"description": "Start shortcut for STATUS_BUTTON in ACTION_BOX_SETUP/SUPPORTED_ACTIONS. Mutually exclusive with other shortcut flags."
},
"is_reassign": {
"type": "boolean",
"description": "Start shortcut for REASSIGN_BUTTON in ACTION_BOX_SETUP/SUPPORTED_ACTIONS. Mutually exclusive with other shortcut flags."
},
"is_other_button": {
"type": "boolean",
"description": "Start shortcut for OTHER_BUTTON in ACTION_BOX_SETUP/SUPPORTED_ACTIONS. Mutually exclusive with other shortcut flags."
}
}
}
Response models
200 — Success - {status: OK, action_box: {...}}
Content type: application/json
Schema
JSON object (structure varies by endpoint).
{
"type": "object",
"description": "JSON object (structure varies by endpoint)."
}
400 — Validation/business error. Examples:
E105—feed_key <= 0E159— non-numericfeed_keyE177— empty{feed_key}path segment (missing path variable)E372—selected_buttonis present but any ofbutton_id,button_key,box_id,track_id,track_labelis missing or blankE356,E361,E362,E369,E373,E374— Action Box wizard/business errors ForE361,responsemay contain a specific business reason from legacy action-box flow (not only the default "No actions available..." message).
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E302) |
response | string | Yes | Human-readable error message |
{
"type": "object",
"example": {
"status": "ER",
"errorCode": "E204",
"response": "Invalid or expired token"
},
"required": [
"status",
"errorCode",
"response"
],
"properties": {
"status": {
"type": "string",
"description": "Always \"ER\" for error responses",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Application-level error code (e.g. E204, E112, E302)"
},
"response": {
"type": "string",
"description": "Human-readable error message"
}
}
}
401 — Token/auth mismatch (for example E357, E359, E367) or invalid session
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E302) |
response | string | Yes | Human-readable error message |
{
"type": "object",
"example": {
"status": "ER",
"errorCode": "E204",
"response": "Invalid or expired token"
},
"required": [
"status",
"errorCode",
"response"
],
"properties": {
"status": {
"type": "string",
"description": "Always \"ER\" for error responses",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Application-level error code (e.g. E204, E112, E302)"
},
"response": {
"type": "string",
"description": "Human-readable error message"
}
}
}
404 — No action box configured for feed (E360)
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E302) |
response | string | Yes | Human-readable error message |
{
"type": "object",
"example": {
"status": "ER",
"errorCode": "E204",
"response": "Invalid or expired token"
},
"required": [
"status",
"errorCode",
"response"
],
"properties": {
"status": {
"type": "string",
"description": "Always \"ER\" for error responses",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Application-level error code (e.g. E204, E112, E302)"
},
"response": {
"type": "string",
"description": "Human-readable error message"
}
}
}
500 — Unexpected server-side error
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E302) |
response | string | Yes | Human-readable error message |
{
"type": "object",
"example": {
"status": "ER",
"errorCode": "E204",
"response": "Invalid or expired token"
},
"required": [
"status",
"errorCode",
"response"
],
"properties": {
"status": {
"type": "string",
"description": "Always \"ER\" for error responses",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Application-level error code (e.g. E204, E112, E302)"
},
"response": {
"type": "string",
"description": "Human-readable error message"
}
}
}
Example:
{
"status": "ER",
"errorCode": "E302",
"response": "Internal server error"
}