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.

Anchor

	create update
	create update

Create/Update 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.

Anchor
delete
delete

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`

Anchor

	list
	list

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.

...

XML Response

JSON Response

Expand

title	XML

Code Block

language	text

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<simulations>
    <simulation exportReleaseLevel="7.4.0.0" exportTable="ops_simulation">
        <abortActions>false</abortActions>
        <emailNotificationActions>false</emailNotificationActions>
        <exitCode>0</exitCode>
        <outputs/>
        <publishEarlyFinish>false</publishEarlyFinish>
        <publishLateFinish>false</publishLateFinish>
        <publishLateStart>false</publishLateStart>
        <publishStatus>false</publishStatus>
        <snmpNotificationActions>false</snmpNotificationActions>
        <status>SUCCESS</status>
        <sysId>37a56842d09f43c59a81343a8a4e42d5</sysId>
        <systemOperationActions>false</systemOperationActions>
        <task>Sleep 0</task>
        <variableActions>false</variableActions>
        <variables/>
        <vertexId>-1</vertexId>
        <workflow>work-2</workflow>
    </simulation>
    <simulation exportReleaseLevel="7.4.0.0" exportTable="ops_simulation">
        <abortActions>true</abortActions>
        <emailNotificationActions>false</emailNotificationActions>
        <exitCode>0</exitCode>
        <outputs/>
        <publishEarlyFinish>false</publishEarlyFinish>
        <publishLateFinish>false</publishLateFinish>
        <publishLateStart>true</publishLateStart>
        <publishStatus>true</publishStatus>
        <snmpNotificationActions>false</snmpNotificationActions>
        <status>SUCCESS</status>
        <sysId>6f65583589db46dc977f1e3f79544c35</sysId>
        <systemOperationActions>false</systemOperationActions>
        <task>Sleep 0</task>
        <variableActions>false</variableActions>
        <variables>
            <variable>
                <name>A</name>
                <value>abc</value>
            </variable>
            <variable>
                <name>B</name>
                <value>123</value>
            </variable>
        </variables>
        <vertexId>3</vertexId>
        <workflow>work-1</workflow>
    </simulation>
    <simulation exportReleaseLevel="7.4.0.0" exportTable="ops_simulation">
        <abortActions>true</abortActions>
        <emailNotificationActions>false</emailNotificationActions>
        <exitCode>0</exitCode>
        <outputs>
            <output>
                <outputData>test-2</outputData>
                <outputFileName>test2.csv</outputFileName>
                <outputType>STDERR</outputType>
                <sysId>1144f14157dc4e2bb58198330c434f34</sysId>
            </output>
            <output>
                <outputData>test-json</outputData>
                <outputFileName>test.json</outputFileName>
                <outputType>STDOUT</outputType>
                <sysId>922dc2e5287845be842f1dd974e25b94</sysId>
            </output>
        </outputs>
        <publishEarlyFinish>false</publishEarlyFinish>
        <publishLateFinish>false</publishLateFinish>
        <publishLateStart>true</publishLateStart>
        <publishStatus>true</publishStatus>
        <snmpNotificationActions>false</snmpNotificationActions>
        <status>SUCCESS</status>
        <sysId>e30b677763e14f72bdbe76e5c09263e7</sysId>
        <systemOperationActions>false</systemOperationActions>
        <task>win-5</task>
        <variableActions>false</variableActions>
        <variables>
            <variable>
                <name>A</name>
                <value>abc</value>
            </variable>
            <variable>
                <name>B</name>
                <value>123</value>
            </variable>
        </variables>
        <vertexId>3</vertexId>
        <workflow>work-1</workflow>
    </simulation>
</simulations>

Expand

title	JSON

Code Block

language	text

[
    {
        "abortActions": false,
        "emailNotificationActions": false,
        "exitCode": "0",
        "exportReleaseLevel": "7.4.0.0",
        "exportTable": "ops_simulation",        
        "outputs": [],
        "publishEarlyFinish": false,
        "publishLateFinish": false,
        "publishLateStart": false,
        "publishStatus": false,
        "snmpNotificationActions": false,
        "status": "SUCCESS",
        "sysId": "37a56842d09f43c59a81343a8a4e42d5",
        "systemOperationActions": false,
        "task": "Sleep 0",
        "variableActions": false,
        "variables": [],
        "vertexId": "-1",
        "workflow": "work-2"
    },
    {
        "abortActions": true,
        "emailNotificationActions": false,
        "exitCode": "0",
        "exportReleaseLevel": "7.4.0.0",
        "exportTable": "ops_simulation",                
        "outputs": [],
        "publishEarlyFinish": false,
        "publishLateFinish": false,
        "publishLateStart": true,
        "publishStatus": true,
        "snmpNotificationActions": false,
        "status": "SUCCESS",
        "sysId": "6f65583589db46dc977f1e3f79544c35",
        "systemOperationActions": false,
        "task": "Sleep 0",
        "variableActions": false,
        "variables": [
            {
                "name": "A",
                "value": "abc"
            },
            {
                "name": "B",
                "value": "123"
            }
        ],
        "vertexId": "3",
        "workflow": "work-1"
    },
    {
        "abortActions": true,
        "emailNotificationActions": false,
        "exitCode": "0",
        "exportReleaseLevel": "7.4.0.0",
        "exportTable": "ops_simulation",        
        "outputs": [
            {
                "outputData": "test-2",
                "outputFileName": "test2.csv",
                "outputType": "STDERR",
                "sysId": "1144f14157dc4e2bb58198330c434f34"
            },
            {
                "outputData": "test-json",
                "outputFileName": "test.json",
                "outputType": "STDOUT",
                "sysId": "922dc2e5287845be842f1dd974e25b94"
            }
        ],
        "publishEarlyFinish": false,
        "publishLateFinish": false,
        "publishLateStart": true,
        "publishStatus": true,
        "snmpNotificationActions": false,
        "status": "SUCCESS",
        "sysId": "e30b677763e14f72bdbe76e5c09263e7",
        "systemOperationActions": false,
        "task": "win-5",
        "variableActions": false,
        "variables": [
            {
                "name": "A",
                "value": "abc"
            },
            {
                "name": "B",
                "value": "123"
            }
        ],
        "vertexId": "3",
        "workflow": "work-1"
    }
]

Anchor

	read
	read

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	See Read Simulation Response.

...

Versions Compared

Old Version 7

New Version 8

Key

Create/Update a Simulation

Anchor
delete
delete

Delete a Simulation: URI Parameters

List Simulations

Read a Simulation

Page Comparison

Versions Compared

Old Version 7

New Version 8

Key

Create/Update a Simulation

Anchordeletedelete

Delete a Simulation: URI Parameters

List Simulations

Read a Simulation

Anchor
delete
delete