Panel | |
---|---|
|
...
Formatting specifications for each web service, including details about parameter requirements, are provided.
Anchor | ||||
---|---|---|---|---|
|
...
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. | Valid 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. | N |
Simulation Output Properties
...
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. |
...