Retrieve cluster records for a walk instance
GET /walk/v1/walks/{walk-id}/clusters
Operation id: getClusterRecords
Description
Thin wrapper around legacy POST /walk/getClusterRecords. walk-id path parameter maps to legacy form_trace_id.
Response envelope key: walk_cluster_records.
Tags: WalkDetail
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
walk-id | string | Yes | form_unique_id of the walk instance. Obtained from GET /walk/v1/walks/ or GET /walk/v1/walks/scheduled response list. Must not be blank. |
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_cluster_records payload.
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_cluster_records payload.
Content type: application/json
Schema
Successful response envelope for Walk APIs.
Named key (most GET endpoints): { "status": "OK", "<resource_key>": <payload> } — e.g. walk_categories, walks, scheduled_walks, walk_types, walk_questions, walk_stores, walk_details, walk_permissions, walk_users. There is no message property.
Default key (multipart POST — create / schedule / submit): { "status": "OK", "response": <object> }.
Nested objects and arrays are emitted in snake_case (internal camelCase field names are normalized in responses).
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | |
response | object | No | Generic JSON object — structure varies by endpoint and config type. |
walk_categories | array | No | |
walks | object | No | Generic JSON object — structure varies by endpoint and config type. |
scheduled_walks | object | No | Generic JSON object — structure varies by endpoint and config type. |
walk_types | array | No | |
walk_questions | object | No | Generic JSON object — structure varies by endpoint and config type. |
walk_stores | object | No | Generic JSON object — structure varies by endpoint and config type. |
walk_details | object | No | Generic JSON object — structure varies by endpoint and config type. |
walk_permissions | object | No | Generic JSON object — structure varies by endpoint and config type. |
walk_users | array | No | |
walk_history | object | No |
{
"type": "object",
"description": "Successful response envelope for Walk APIs.\n\n**Named key (most GET endpoints):** `{ \"status\": \"OK\", \"<resource_key>\": <payload> }` — e.g. `walk_categories`,\n`walks`, `scheduled_walks`, `walk_types`, `walk_questions`, `walk_stores`, `walk_details`, `walk_permissions`,\n`walk_users`. There is **no** `message` property.\n\n**Default key (multipart POST — create / schedule / submit):** `{ \"status\": \"OK\", \"response\": <object> }`.\n\nNested objects and arrays are emitted in **snake_case** (internal camelCase field names are normalized in responses).\n",
"example": {
"status": "OK",
"walks": {
"walk_list": [],
"last_fetch_time": 1710000000000
}
},
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"enum": [
"OK"
]
},
"response": {
"type": "object",
"description": "Generic JSON object — structure varies by endpoint and config type."
},
"walk_categories": {
"type": "array",
"items": {
"type": "object",
"description": "A single walk category object.",
"properties": {
"domain_id": {
"type": "integer",
"description": "Domain identifier for the category."
},
"category_name": {
"type": "string",
"description": "Display name of the walk category."
},
"category_id": {
"type": "string",
"description": "Unique category identifier."
},
"category_type": {
"type": "string",
"description": "Category type code (e.g. `\"W\"` for walk)."
},
"category_desc": {
"type": "string",
"description": "Category description."
},
"creator_name": {
"type": "string",
"description": "Username of the category creator."
},
"permission": {
"type": "string",
"description": "Comma-separated permission flags (e.g. `\"1,1,1,1\"`)."
},
"created_by": {
"type": "string",
"description": "Login ID of the creator."
}
}
}
},
"walks": {
"type": "object",
"description": "Generic JSON object — structure varies by endpoint and config type."
},
"scheduled_walks": {
"type": "object",
"description": "Generic JSON object — structure varies by endpoint and config type."
},
"walk_types": {
"type": "array",
"items": {}
},
"walk_questions": {
"type": "object",
"description": "Generic JSON object — structure varies by endpoint and config type."
},
"walk_stores": {
"type": "object",
"description": "Generic JSON object — structure varies by endpoint and config type."
},
"walk_details": {
"type": "object",
"description": "Generic JSON object — structure varies by endpoint and config type."
},
"walk_permissions": {
"type": "object",
"description": "Generic JSON object — structure varies by endpoint and config type."
},
"walk_users": {
"type": "array",
"items": {}
},
"walk_history": {
"type": "object",
"properties": {
"history_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"state_key": {
"type": "integer"
},
"form_trace_id": {
"type": "integer",
"format": "int64"
},
"domain_id": {
"type": "integer"
},
"model_id": {
"type": "string"
},
"model_name": {
"type": "string"
},
"category_id": {
"type": "string"
},
"category_name": {
"type": "string"
},
"action_type": {
"type": "string"
},
"action_text": {
"type": "string"
},
"action_time": {
"type": "string"
},
"old_status": {
"type": "string"
},
"new_status": {
"type": "string"
},
"txn_category": {
"type": "string"
},
"permit_type": {
"type": "string"
},
"comments": {
"type": "string"
},
"from_user": {
"type": "string"
},
"from_profile": {
"type": "string"
},
"from_unit": {
"type": "string"
},
"from_dept": {
"type": "string"
},
"created_by": {
"type": "string"
},
"creator_name": {
"type": "string"
},
"send_to_user": {
"type": "string"
},
"send_to_profile": {
"type": "string"
},
"send_to_unit": {
"type": "string"
},
"send_to_dept": {
"type": "string"
}
}
}
},
"info_msg": {
"type": "string"
}
}
}
}
}
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>" }(noerrorCode). - 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.
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | |
errorCode | string | No | Structured error code (Walk or shared session codes; see Error Codes Reference). |
response | string | No | Human-readable message when errorCode is present (HTTP 4xx/5xx responses). |
error | oneOf | No | Payload 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>" }(noerrorCode). - 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.
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | |
errorCode | string | No | Structured error code (Walk or shared session codes; see Error Codes Reference). |
response | string | No | Human-readable message when errorCode is present (HTTP 4xx/5xx responses). |
error | oneOf | No | Payload 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>" }(noerrorCode). - 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.
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | |
errorCode | string | No | Structured error code (Walk or shared session codes; see Error Codes Reference). |
response | string | No | Human-readable message when errorCode is present (HTTP 4xx/5xx responses). |
error | oneOf | No | Payload 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."
}