ControlService

Provides access to control methods defined on CIs.

POST /control/ Creates the control task
GET /control/prepare/{controlName}/{id:.*?} Returns a parameter object for the task that will execute the control task method.

POST /control/

Creates the control task for the object returned by invoking /control/prepare.
Permissions
controltask#execute
Parameters
Request body application/xml Control the Control parameter object.
Response body
String - a reference to a Task ID that can be executed by the TaskService .
Content type: application/xml

GET /control/prepare/{controlName}/{id:.*?}

Returns a parameter object for the task that will execute the control task method. The returned object can be used in the call to /control.
Permissions
controltask#execute
Parameters
Path controlName String The name of the control method to execute.
Path id String the CI to execute the control method on
Response body
Control - a Control parameter object.
Content type: application/xml