Versions Compared

Key

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


Panel

Table of Contents

...

  • Create/Update a Simulation 
  • Delete a Simulation 
  • List Simulations
  • Read a Simulation

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

http://localhost:8080/uc/resources/simulation

Authentication

HTTP Basic

Produces Content-Type

application/xml, application/json

Consumes Content-Type

application/xml, application/json

Example RequestSee
Simulation PropertiesSee Simulation Properties and Simulation Output Properties, below. 

Example Responses

  • Status 200

    • Successfully created the simulation with id {uuid}.

  • Status 400

    • Error message.

  • Status 403

    • Operation prohibited due to security constraints.

  • Status 404

    • A simulation with taskname “{taskname}” does not exist.

    • A simulation with taskid "{uuid}" does not exist.

  • Status 500

    • Unexpected request failure. See log(s) for more details.

Simulation: Properties

Property

UI Field Name

Description

Specifications

Required

task

Task

Name of the task.


Y

retainSysIds

n/a

Specification for whether or not the Create a Simulation web service will persist the sysId property.

  • If retainSysIds="true" and sysId is included in the request/response, sysId will be persisted to the database.

  • If retainSysIds="false" and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller.

Note

In XML web services, retainSysIds is specified as an attribute in the <simulation> element.

Valid values: true/false (default is true).

N

workflow

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

Status

Projected simulation status.

Allowed values

  • Success (200)

  • Failed (140)

N

exitCode

Exit Code

Exit code to return.

Defaults to 0(zero) if not specified.

N

variables

Simulation Variables


List of variables: 

<variables>
       <variable>
             <name>env1</name>
             <value>test1</value>
       </variable>
       <variable>
             <name>env2</name>
             <value>test2</value>
       </variable>
</variables>

N

publishStatus

Publish Status


Defaults to false

N

publishLateStart

Publish Late Start


Defaults to false

N

publishLateFinish

Publish Late Finish


Defaults to false

N

publishEarlyFinish

Publish Early Finish


Defaults to false

N

abortActions

Execute Abort Actions


Defaults to false

N

emailNotificationActions

Execute Email Notification Actions


Defaults to false

N

variableActions

Execute Set Variable Actions


Defaults to false

N

snmpNotificationActions

Execute SNMP Notification Actions


Defaults to false

N

systemOperationActions

Execute System Operation Actions


Defaults to false

N


Simulation Output: Properties

Property

UI Field Name

Description

Specifications

Required

outputType

Type

Type of Output

Allowed Values:

  • STDOUT

  • STDERR

  • FILE

  • JOBLOG

  • WEB SERVICE

  • EXTENSION

N

outputData

Output

Output Data


N

outputFileName

File Name

Name of the File


N

...


 Description

URI

http://host_name/uc/resources/simulation

HTTP Method

DELETE

Description

Delete Simulation.

URI ParametersSee 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

simulationid

N/A

ID used within the Controller to identify this simulation.

String; URI parameter

Y

taskname

taskname



N/A

Name used within the Controller to identify the task Name.

String; URI parameter

Y

simulationid

workflowname



N/A

Name used within the Controller to identify the workflow Name.

String; URI parameter

N

simulationid

vertexid

N/A

Vertex ID of the task added to the workflow.

String; URI parameter

N (Y if workflowname is specified)

simulationid


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

See List Simulation: Example Response, below.

...