Retrieve model history (audit trail) for a walk instance

GET /walk/v1/walks/history

Operation id: getWalkHistory

Description

Returns the submission audit-trail history for a walk instance identified by form_trace_id. When cluster_child_id is supplied, history is further filtered to that specific cluster child.

Session-derived fields (time_zone, lang_code, domain_id) are resolved server-side from the validated session — they are not accepted as request parameters.

Authentication: X-reflexis-csrf-token-X required.


Response Structure

Success envelope: top-level walk_history object next to status.

When history records exist the object contains a history_details array of audit entries (status transitions, routing, actors). Otherwise it contains info_msg with a localised placeholder.

Successful list response (example from form_trace_id=1779351866748, cluster_child_id=-1):

{
  "status": "OK",
  "walk_history": {
    "history_details": [
      {
        "state_key": 21881,
        "form_trace_id": 1779351866748,
        "domain_id": 170010099,
        "model_id": "FORM_54273",
        "model_name": "TM-61482%2BMultiple%2BInstance%2BReviewer%2BHistory%2BTest",
        "category_id": "FORM_APPROVE",
        "category_name": "",
        "action_type": "S",
        "action_text": "",
        "action_time": "05/21/2026 04:24 am",
        "old_status": "I",
        "new_status": "PR",
        "txn_category": "R",
        "permit_type": "C",
        "comments": "",
        "from_user": "GM_0001",
        "from_profile": "STRMGR,strm,308511",
        "from_unit": "0001",
        "from_dept": "1234567891234567,ASGN_DEPT_1,STORE",
        "created_by": "GM_0001",
        "creator_name": "GM_0001",
        "send_to_user": "-1",
        "send_to_profile": "DIST_MGR",
        "send_to_unit": "8455",
        "send_to_dept": "-1"
      }
    ]
  }
}

No history (example from form_trace_id=1779337636336, cluster_child_id=-1):

{
  "status": "OK",
  "walk_history": {
    "info_msg": "This section will show audit messages on Walk submission"
  }
}
FieldDescription
walk_historyHistory payload
walk_history.history_detailsArray of WalkModelHistoryEntry objects when records exist
walk_history.history_details[*].old_status / new_statusStatus transition (e.g. I → PR)
walk_history.history_details[*].action_timeTimestamp formatted in the session time zone
walk_history.info_msgLocalised message when no records exist

Error Scenarios

ScenarioHTTP StatusMessage
Missing X-reflexis-csrf-token-X header400X-reflexis-csrf-token-X header is mandatory
Missing form_trace_id400form_trace_id is mandatory (errorCode E124)
Missing cluster_child_id400cluster_child_id is mandatory (errorCode E122)
Invalid or expired token401Invalid or expired token
Internal server error500Error while processing request.

Error Codes Reference

CodeHTTPDescription
E112400X-reflexis-csrf-token-X header is mandatory
E101400Domain id is mandatory (session payload)
E124400form_trace_id is mandatory
E122400cluster_child_id is mandatory
E202401User session is invalid
E204401Invalid or expired token
E500500Unhandled server error

Tags: WalkHistory

Parameters

Query parameters

NameTypeRequiredDescription
cluster_child_idstringYesRequired. Cluster child identifier used to filter history records to a specific cluster member. Pass "-1" when the walk is not associated with a cluster child. Missing this parameter → HTTP 400 with errorCode: E122.
form_trace_idstringYesRequired. Walk instance trace ID identifying the walk whose history is to be retrieved. Obtained from GET /walk/v1/walks/ or the create-walk response. Missing this parameter → HTTP 400 with errorCode: E124.

Security

  • ApiKeyHeader (apiKey)
    • APIGEE API key header validated by VerifyAPIKey policy.
  • AuthTokenHeader (apiKey)
    • Session authentication token validated server-side against the user session store. Required on every request. Absence returns HTTP 400; invalid/expired token returns HTTP 401.

Responses

200 — Success — returns walk_history with history_details (list) when audit

records exist, or info_msg when none match. Application-level errors are also returned as HTTP 200 with status: "ER".

Content type: application/json

400 — Invalid or missing required request parameter.

Content type: application/json

401 — Missing or invalid X-reflexis-csrf-token-X session token.

Content type: application/json

500 — Unexpected server-side error.

Content type: application/json

Response models

200 — Success — returns walk_history with history_details (list) when audit

records exist, or info_msg when none match. Application-level errors are also returned as HTTP 200 with status: "ER".

Content type: application/json

Schema

{
  "oneOf": [
    {
      "type": "object",
      "required": [
        "status",
        "walk_history"
      ],
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "OK"
          ]
        },
        "walk_history": {
          "type": "object",
          "properties": {
            "history_details": {
              "type": "array",
              "items": {
                "type": "object"
              }
            },
            "info_msg": {
              "type": "string"
            }
          }
        }
      }
    },
    {
      "type": "object",
      "description": "Error envelope shape depends on how the error is produced:\n\n- **HTTP 200** — business or validation failure after the request is accepted:\n  `{ \"status\": \"ER\", \"error\": \"<string or JSON>\" }` (no `errorCode`).\n- **HTTP 4xx/5xx** — structured API error:\n  `{ \"status\": \"ER\", \"errorCode\": \"<code>\", \"response\": \"<localized message>\" }`.\n\nSee the global **Error Codes Reference** in this spec for `errorCode` values.\n",
      "example": {
        "status": "ER",
        "errorCode": "E112",
        "response": "model_id is mandatory"
      },
      "required": [
        "status"
      ],
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "ER"
          ]
        },
        "errorCode": {
          "type": "string",
          "description": "Structured error code (Walk or shared session codes; see **Error Codes Reference**)."
        },
        "response": {
          "type": "string",
          "description": "Human-readable message when `errorCode` is present (HTTP 4xx/5xx responses)."
        },
        "error": {
          "description": "Payload for HTTP 200 error bodies (string, array, or object).",
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "array",
              "items": {}
            },
            {
              "type": "object"
            }
          ]
        }
      }
    }
  ]
}

400 — Invalid or missing required request parameter.

Content type: application/json

Schema

Error envelope shape depends on how the error is produced:

  • HTTP 200 — business or validation failure after the request is accepted: { "status": "ER", "error": "<string or JSON>" } (no errorCode).
  • HTTP 4xx/5xx — structured API error: { "status": "ER", "errorCode": "<code>", "response": "<localized message>" }.

See the global Error Codes Reference in this spec for errorCode values.

PropertyTypeRequiredDescription
statusstringYes
errorCodestringNoStructured error code (Walk or shared session codes; see Error Codes Reference).
responsestringNoHuman-readable message when errorCode is present (HTTP 4xx/5xx responses).
erroroneOfNoPayload for HTTP 200 error bodies (string, array, or object).
{
  "type": "object",
  "description": "Error envelope shape depends on how the error is produced:\n\n- **HTTP 200** — business or validation failure after the request is accepted:\n  `{ \"status\": \"ER\", \"error\": \"<string or JSON>\" }` (no `errorCode`).\n- **HTTP 4xx/5xx** — structured API error:\n  `{ \"status\": \"ER\", \"errorCode\": \"<code>\", \"response\": \"<localized message>\" }`.\n\nSee the global **Error Codes Reference** in this spec for `errorCode` values.\n",
  "example": {
    "status": "ER",
    "errorCode": "E112",
    "response": "model_id is mandatory"
  },
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Structured error code (Walk or shared session codes; see **Error Codes Reference**)."
    },
    "response": {
      "type": "string",
      "description": "Human-readable message when `errorCode` is present (HTTP 4xx/5xx responses)."
    },
    "error": {
      "description": "Payload for HTTP 200 error bodies (string, array, or object).",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "object"
        }
      ]
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E127",
  "response": "entity_id is mandatory"
}

401 — Missing or invalid X-reflexis-csrf-token-X session token.

Content type: application/json

Schema

Error envelope shape depends on how the error is produced:

  • HTTP 200 — business or validation failure after the request is accepted: { "status": "ER", "error": "<string or JSON>" } (no errorCode).
  • HTTP 4xx/5xx — structured API error: { "status": "ER", "errorCode": "<code>", "response": "<localized message>" }.

See the global Error Codes Reference in this spec for errorCode values.

PropertyTypeRequiredDescription
statusstringYes
errorCodestringNoStructured error code (Walk or shared session codes; see Error Codes Reference).
responsestringNoHuman-readable message when errorCode is present (HTTP 4xx/5xx responses).
erroroneOfNoPayload for HTTP 200 error bodies (string, array, or object).
{
  "type": "object",
  "description": "Error envelope shape depends on how the error is produced:\n\n- **HTTP 200** — business or validation failure after the request is accepted:\n  `{ \"status\": \"ER\", \"error\": \"<string or JSON>\" }` (no `errorCode`).\n- **HTTP 4xx/5xx** — structured API error:\n  `{ \"status\": \"ER\", \"errorCode\": \"<code>\", \"response\": \"<localized message>\" }`.\n\nSee the global **Error Codes Reference** in this spec for `errorCode` values.\n",
  "example": {
    "status": "ER",
    "errorCode": "E112",
    "response": "model_id is mandatory"
  },
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Structured error code (Walk or shared session codes; see **Error Codes Reference**)."
    },
    "response": {
      "type": "string",
      "description": "Human-readable message when `errorCode` is present (HTTP 4xx/5xx responses)."
    },
    "error": {
      "description": "Payload for HTTP 200 error bodies (string, array, or object).",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "object"
        }
      ]
    }
  }
}

500 — Unexpected server-side error.

Content type: application/json

Schema

Error envelope shape depends on how the error is produced:

  • HTTP 200 — business or validation failure after the request is accepted: { "status": "ER", "error": "<string or JSON>" } (no errorCode).
  • HTTP 4xx/5xx — structured API error: { "status": "ER", "errorCode": "<code>", "response": "<localized message>" }.

See the global Error Codes Reference in this spec for errorCode values.

PropertyTypeRequiredDescription
statusstringYes
errorCodestringNoStructured error code (Walk or shared session codes; see Error Codes Reference).
responsestringNoHuman-readable message when errorCode is present (HTTP 4xx/5xx responses).
erroroneOfNoPayload for HTTP 200 error bodies (string, array, or object).
{
  "type": "object",
  "description": "Error envelope shape depends on how the error is produced:\n\n- **HTTP 200** — business or validation failure after the request is accepted:\n  `{ \"status\": \"ER\", \"error\": \"<string or JSON>\" }` (no `errorCode`).\n- **HTTP 4xx/5xx** — structured API error:\n  `{ \"status\": \"ER\", \"errorCode\": \"<code>\", \"response\": \"<localized message>\" }`.\n\nSee the global **Error Codes Reference** in this spec for `errorCode` values.\n",
  "example": {
    "status": "ER",
    "errorCode": "E112",
    "response": "model_id is mandatory"
  },
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Structured error code (Walk or shared session codes; see **Error Codes Reference**)."
    },
    "response": {
      "type": "string",
      "description": "Human-readable message when `errorCode` is present (HTTP 4xx/5xx responses)."
    },
    "error": {
      "description": "Payload for HTTP 200 error bodies (string, array, or object).",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "object"
        }
      ]
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E500",
  "response": "Unexpected server error."
}