Walk Creator

Version: 1.0.0 OpenAPI: 3.0.3

OpenAPI for the Walk Creator APIs (walk-creator/v1/...).

Same server base URL as Walk execution and Task execution specs: /MYWORK/service/. Example: https://fs3.reflexisinc.com/MYWORK/service/walk-creator/v1/attributes.

These endpoints are not mounted under /api/v2/ (unlike some SWA controllers such as /api/v2/formAttr). Use /MYWORK/service/walk-creator/v1/... only.

Query fields are 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, etc.) are not accepted as request parameters — they are resolved from the validated session.

Companion spec: walk-execution/next-gen-walk-execution-api.yaml (walk instance execution). Error codes and structured envelopes follow the same Walk API conventions documented there.


Common Response Envelope

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

On HTTP 200 application-level failure:

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

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

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

Servers

URLDescription
/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

NameTypeDescription
AuthTokenHeaderapiKeySession 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.