/
Operations REST Interface

Operations REST Interface

REST Interface in Platform

Operations such a workflow configuration, workflow execution plan, external references and 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.

REST Interface in EC

EC (Execution Context) REST interfaces are documented and accessible via OpenAPI. The specification can be accessed from both the Platform and EC server.

Authentication is performed against the Platform using users defined in the Access Controller, if possible. When the Platform is unreachable, the user is authenticated against the locally defined user that is configured by the ec.webserver.user property in the Execution Context Properties | EC Web Interface Properties.

Workflows

The detailed YAML file is available for download,

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

or

http(s)://<ec server>:<ec port>/ecweb/wf/v1/api-docs

Note!

Actual REST API calls, such as Retrieving or deactivating workflows, must be made directly to the EC server and port. This ensures the request is routed to the correct EC instance managing the target workflows.