Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

This page is Work in Progress

The CLAMP control loop feature has the APIs that are described in the following sections.

...

The body of the create and update end points is a TOSCA Service/Topology template that defines the new or changed Control Loop Type. The update and delete endpoints take a reference to the Control Loop Type. The incoming TOSCA is verified and checked for referential integrity. OnĀ delete requests, a check is made to ensure that no Control Loop Instances exist for the Control Loop Type to be deleted.

Note

The Swagger for the Commissioning API will appear here.

Instantiation API

The instantiation API has two functions:

  1. Creation, Reading, Update, and Deletion of Control Loop Instances.
  2. Instantiation and lifecycle management of Control Loop Instances on participants

The Instantiation API is used by the CLAMP GUI.

Instantiation Control Loop Instance CRUD

This sub API allows for the creation, read, update, and deletion of Control Loop Instances. The endpoints for create and update take a JSON body that describes the Control Loop Instance. The endpoints for read and delete take a Control Loop Instance ID to determine which Control Loop Instance to act on. For the delete endpoint, a check is made to ensure that the Control Loop Instance is not instantiated on participants.

A call to the update endpoint for a Control Loop Instance follow the semantics described here: TOSCA Defined Control Loop: Architecture and Design.

Note

The Swagger for the Instantiation CRUD API will appear here.

Instantiation Control Loop Instance Lifecycle Management

Note

The Swagger for the Instantiation Lifecycle Management API will appear here.

Monitoring API

Pass Through API

...