Operations REST Interface

Owned by Yeok Hong Ng
Last updated: Oct 17, 2024
1 min read

Operations such a workflow configuration, workflow execution plan, external references etc are exposed as an OpenAPI. A live instance of this OpenAPI can be accessed here for any given running Platform:

Workflows
http(s)://<platform server>:<platform port>/ops/mz/wf/v1/api-docs

 

Workflow Groups
http(s)://<platform server>:<platform port>/ops/mz/wfg/v1/api-docs

 

External References
http(s)://<platform server>:<platform port>/ops/extref/v1/api-docs

 

Host

 

Pico

Note!

For Host and Pico, users must have Execute permission from the Pico Viewer application to access the API.

This permission can be viewed and granted in Access Controller.

 

This allows for exploration of the OpenAPI and it is also possible to place live requests against the running Platform granted that valid credentials are provided.