Walk Execution

Version: 1.0.0 OpenAPI: 3.0.3

OpenAPI for the Walk execution APIs (walk/v1/...).

Same server base URL as WALK next-gen and legacy specs: /MYWORK/service/.

Query and form fields are generally snake_case; the server normalizes to camelCase internally.

Authentication: All endpoints require the X-reflexis-csrf-token-X header carrying a valid session token. Session-derived identity fields (domain_id, user_id, unit_id, dept_id, profile_id, time_zone_long, lang_code) are not accepted as request parameters — they are always resolved from the validated session.

Companion spec: task-execution/next-gen-task-execution-api.yaml. Use Swagger UI definition dropdown to switch modules.

Error Codes Reference (Walk APIs)

Session validation uses shared error codes (same family as MyWork). Walk-specific validation uses Walk codes. Structured failures return JSON with status, errorCode, and response for HTTP 4xx/5xx. Business-rule failures often return HTTP 200 with status: "ER" and an error field (string or structured) — no errorCode.

Note: The code E202 appears for invalid user session (HTTP 401) and invalid instance / model access (HTTP 403). Use HTTP status to tell them apart.

Session / token

Code	HTTP	Description
`E112`	400	`X-reflexis-csrf-token-X` header is mandatory
`E101`	400	Domain id is mandatory (invalid session payload)
`E202`	401	User session is invalid (empty user id after token parse)
`E204`	401	Invalid or expired token

Typical walk validation and server errors

Code	HTTP	Description
`E110`	400	Missing required parameter (placeholder `{0}` is the snake_case parameter name)
`E108`	500	Walk name is mandatory
`E109`	500	Walk description is mandatory
`E301`	500	Walk name exceeds maximum length
`E302`	500	Walk description exceeds maximum length
`E202`	403	Invalid instance / model access (walk creation only)
`E500`	500	Unhandled exception (message `"Unexpected server error."`)

Full walk error code catalog (reference)

Code	Description
`E101`	Domain id is mandatory
`E102`	Auth token is mandatory
`E103`	User id is mandatory
`E104`	Profile id is mandatory
`E105`	Department id is mandatory
`E106`	Unit id is mandatory
`E107`	Action type is mandatory
`E108`	Walk name is mandatory
`E109`	Walk description is mandatory
`E110`	`{0}` is mandatory
`E201`	User session is invalid (reserved walk code; session path typically uses `E202`)
`E202`	Invalid instance access
`E301`	Walk name length should not exceed `{0}` characters
`E302`	Walk description length should not exceed `{0}` characters
`E303`	Error while starting the walk
`E304`	Error while scheduling the walk
`E305`	Error while submitting the walk
`E404`	No data found
`E500`	Internal server error

ER is the status field value for error responses; it is not an errorCode.

Common Response Envelope

Successful responses use status: OK and a payload field named for the resource (e.g. walk_categories, walks, walk_details), not a generic message field.

On HTTP 200 application-level failure (business error envelope):

{ "status": "ER", "error": "<details>" }

On HTTP 4xx/5xx (structured validation / server error envelope):

{ "status": "ER", "errorCode": "E110", "response": "<localized message>" }

Download OpenAPI specification (v1.0.0)

Servers

URL	Description
`/MYWORK/service/`	Application context + Pulse servlet (typical deployment)
`https://fs3.reflexisinc.com/MYWORK/service/`	Example development host
`http://localhost:3001/MYWORK/service/`	Local CORS proxy — npm run cors-proxy
`https://dev-api.zebra.com/`	Dev API APIGEE
`https://api.zebra.com/`	API APIGEE

Security schemes

Name	Type	Description
`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.

Operations

Use the sidebar to browse individual operations generated from this specification.