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-final selected_button
  • Probe: send only action_token (no selected_button) to restore current state

Final-button selections must be submitted to /action-box/execute.

Tags: MyWorkFeedActions

Parameters

Path parameters

NameTypeRequiredDescription
feed-keyintegerYesUnique 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 <= 0
  • E159 — non-numeric feed_key
  • E177 — empty {feed_key} path segment (missing path variable)
  • E372 — selected_button is present but any of button_id, button_key, box_id, track_id, track_label is missing or blank
  • E356, E361, E362, E369, E373, E374 — Action Box wizard/business errors For E361, response may 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

PropertyTypeRequiredDescription
action_tokenstringNoExisting wizard token for advance/probe.
selected_buttonobjectNoEchoed button metadata from prior flow response (for non-final advance).
projectionsarrayNoOptional projections such as walk_status fields.
msg_typestringNoOptional message type override for initial start.
is_update_statusbooleanNoStart shortcut for STATUS_BUTTON in ACTION_BOX_SETUP/SUPPORTED_ACTIONS. Mutually exclusive with other shortcut flags.
is_reassignbooleanNoStart shortcut for REASSIGN_BUTTON in ACTION_BOX_SETUP/SUPPORTED_ACTIONS. Mutually exclusive with other shortcut flags.
is_other_buttonbooleanNoStart 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 <= 0
  • E159 — non-numeric feed_key
  • E177 — empty {feed_key} path segment (missing path variable)
  • E372 — selected_button is present but any of button_id, button_key, box_id, track_id, track_label is missing or blank
  • E356, E361, E362, E369, E373, E374 — Action Box wizard/business errors For E361, response may contain a specific business reason from legacy action-box flow (not only the default "No actions available..." message).

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-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

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-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

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-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

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-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"
}