1. Web API

Owned by Jenni Wallin
Last updated: Jul 25, 2023 by Former user (Deleted)

The Web API enables external systems to collect status information from selected parts of the  system, as well as start and stop workflows and workflow groups.

When sending HTTP requests to the Platform, the version of the protocol is included in the URL. For more details about protocol versioning, see the section below, Protocol Versioning.


Collecting Status Information

Status information can be collected for:

  • Hosts

  • Picos

  • Workflows

  • Workflow Groups

The status collection part is implemented using the standard HTTP method GET. Refer to 4. Status Collection HTTP Requests for information about the GET request URLs that are supported for getting the status information.

Managing Workflows

The requests for enabling, disabling, starting and stopping workflows and workflow groups are invoked using the HTTP method POST.

Refer to 5. Workflow Requests for information about the HTTP POST request URLs that are supported for managing workflows.

Protocol Versioning

The protocol is versioned according to the model: X.Y, where X is major versions and Y is minor versions. Both X and Y are integers that increment for each new version. X starts at 1 and Y starts at 0. Major versions may be incompatible with older versions of the protocol.

Minor versions are backwards compatible with older versions of the protocol within the same major version. The client programmer must take into consideration that newer minor versions of the protocol within the same major version may contain additions to the protocol, such as new XML tags, but will never remove or change pre-existing tags in older minor versions of the protocol.


Next:
2. HTTP Properties