Simulation Web Services
Overview
Universal Controller supports the following RESTful-based web services for Simulation operations, which are listed alphabetically on this page.
Formatting specifications for each web service, including details about parameter requirements, are provided.
Create/Update a Simulation
Description |
|
---|---|
URI |
http://host_name/uc/resources/simulation |
HTTP Method |
Post/PUT |
Description |
Create Simulation. |
Example URI |
|
Authentication |
HTTP Basic |
Produces Content-Type |
application/xml, application/json |
Consumes Content-Type |
application/xml, application/json |
Example Request | See Create/Update a Simulation: Example Request. |
Simulation Properties | See Simulation Properties and Simulation Output Properties, below. |
Example Responses |
|
Simulation Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
---|---|---|---|---|
|
Task |
Name of the task. |
Y |
|
|
n/a |
Specification for whether or not the Create a Simulation web service will persist the sysId property.
Note In XML web services, retainSysIds is specified as an attribute in the <simulation> element. |
Valid values: true/false (default is true). |
N |
|
Workflow |
Name of the workflow. |
N |
|
vertexId |
Vertex |
Vertex ID of the task added to the workflow. |
Defaults to ANY (-1) if not specified |
N |
|
Status |
Projected simulation status. |
Allowed values
|
N |
|
Exit Code |
Exit code to return. |
Defaults to 0(zero) if not specified. |
N |
|
Simulation Variables |
Specifies variables that should be added for simulation purposes, including any built-in monitor variables starting with "ops_trigger_". The Simulation Variables are for adding variables that the simulated instance would have normally produced, therefore, are only available after the instance is already Queued or Running. |
List of variables:
|
N |
|
Publish Status |
Specifies if Status events should be published to task monitor instances. |
Defaults to false |
N |
|
Publish Late Start |
Specifies if Late Start events should be published to task monitor instances. |
Defaults to false |
N |
|
Publish Late Finish |
Specifies if Late Finish events should be published to task monitor instances. |
Defaults to false |
N |
|
Publish Early Finish |
Specifies if Early Finish events should be published to task monitor instances. |
Defaults to false |
N |
|
Execute Abort Actions |
Specifies if Abort Actions should be executed for the simulated instance. |
Defaults to false |
N |
|
Execute Email Notification Actions |
Specifies if Email Notification Actions should be executed for the simulated instance. |
Defaults to false |
N |
|
Execute Set Variable Actions |
Specifies if Set Variable Actions should be executed for the simulated instance. |
Defaults to false |
N |
|
Execute SNMP Notification Actions |
Specifies if SNMP Notification Actions should be executed for the simulated instance. |
Defaults to false |
N |
|
Execute System Operation Actions |
Specifies if System Operation Actions should be executed for the simulated instance. |
Defaults to false |
N |
otherOptions |
Other Options | Specify Other Options for the Simulation record. | Valid Values:
|
N |
Simulation Output Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
---|---|---|---|---|
|
Type |
Type of Output |
Allowed Values:
|
N |
|
Output |
Output Data |
N |
|
|
File Name |
Name of the File |
N |
Create/Update a Simulation: Example Request
XML Request | JSON Request |
---|---|
Delete a Simulation
Description |
|
---|---|
URI |
http://host_name/uc/resources/simulation |
HTTP Method |
DELETE |
Description |
Delete Simulation. |
URI Parameters | See Delete a Simulation: URI Parameters, below. |
Example URI |
http://localhost:8080/uc/resources/simulation?taskname=task-1 http://localhost:8080/uc/resources/simulation?taskname=task-1&workflowname=work-1&vertexid=-1 http://localhost:8080/uc/resources/simulation?simulationid=12345 |
Authentication |
HTTP Basic |
Produces Content-Type |
application/xml, application/json |
Example Responses |
Simulation deleted successfully. |
Delete a Simulation: URI Parameters
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
N/A |
ID used within the Controller to identify this simulation. |
String; URI parameter |
Y |
taskname |
|
N/A |
Name used within the Controller to identify the task Name. |
String; URI parameter |
Y |
|
|
N/A |
Name used within the Controller to identify the workflow Name. |
String; URI parameter |
N |
|
|
N/A |
Vertex ID of the task added to the workflow. |
String; URI parameter |
N (Y if workflowname is specified) |
|
List Simulations
|
Description |
---|---|
URI |
http://host_name/uc/resources/simulation/list |
HTTP Method |
GET |
Description |
List All Simulations. |
Example URI |
http://localhost:8080/uc/resources/simulation/list http://localhost:8080/uc/resources/simulation/list?taskname=task-1 http://localhost:8080/uc/resources/simulation/list?workflowname=work-1 |
Authentication |
HTTP Basic |
Produces Content-Type |
application/xml, application/json |
Example Responses |
List Simulations: URI Parameters
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
N/A |
Name used within the Controller to identify the task Name. |
String; URI parameter |
N |
|
|
N/A |
Name used within the Controller to identify the workflow Name. |
String; URI parameter |
N |
List Simulations: Example Response
XML Response | JSON Response |
---|---|
|
Read a Simulation
|
Description |
---|---|
URI |
http://host_name/uc/resources/simulation |
HTTP Method |
GET |
Description |
read Simulation |
Example URI |
http://localhost:8080/uc/resources/simulation?taskname=task-1 http://localhost:8080/uc/resources/simulation?taskname=task-1&workflowname=work-1&vertexid=-1 http://localhost:8080/uc/resources/simulation?simulationid=12345 |
Authentication |
HTTP Basic |
Produces Content-Type |
application/xml, application/json |
Consumes Content-Type |
|
Example Responses |
Read a Simulation: URI Parameters
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
N/A |
ID used within the Controller to identify this simulation. |
String; URI parameter |
Y |
taskname |
|
N/A |
Name used within the Controller to identify the task Name. |
String; URI parameter |
Y |
|
|
N/A |
Name used within the Controller to identify the workflow Name. |
String; URI parameter |
N |
|
|
N/A |
Vertex ID of the task added to the workflow. |
String; URI parameter |
N (Y if workflowname is specified) |
|
Read a Simulation: Example Response
XML Response | JSON Response |
---|---|
|
|