Operations REST Interface

Operations such as workflow configuration, workflow execution plan, external references etc are exposed as an OpenAPI. The detailed YAML link and the live instance of this OpenAPI are listed below and can be accessed here for any given running Platform:

Workflows

The detailed YAML file is available for download,

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

Workflow Groups

The detailed YAML file is available for download,

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

External References

The detailed YAML file is available for download,

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

Host

The detailed YAML file is available for download,

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

Pico

The detailed YAML file is available for download,

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

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 the exploration of the OpenAPI and it is also possible to place live requests against the running Platform, provided that valid credentials are given.