Versions Compared

Key

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


Panel

Table of Contents

...

Formatting specifications for each web service, including details about parameter requirements, are provided.

Anchor
create update
create update

...

XML RequestJSON Request


Expand
titleXML


Code Block
languagetext
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<simulation exportReleaseLevel="7.4.0.0" exportTable="ops_simulation" retainSysIds="true">
    <abortActions>true</abortActions>
    <emailNotificationActions>false</emailNotificationActions>
    <exitCode>0</exitCode>
    <otherOptions>z/OS JCL Resolution</otherOptions>
    <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>






Expand
titleJSON


Code Block
languagetext
{
    "abortActions": true,
    "emailNotificationActions": false,
    "exitCode": "0",
    "exportReleaseLevel": "7.4.0.0",
    "exportTable": "ops_simulation",  
    "otherOptions": "z/OS JCL Resolution</otherOptions>Resolution",   
    "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,
    "retainSysIds": false,
    "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"
}





...


 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.

...

XML ResponseJSON Response


Expand
titleXML


Code Block
languagetext
<?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>
        <otherOptions>z/OS JCL Resolution</otherOptions>
        <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>
        <otherOptions>z/OS JCL Resolution</otherOptions>
        <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>
        <otherOptions>z/OS JCL Resolution</otherOptions>
        <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
titleJSON


Code Block
languagetext
[
    {
        "abortActions": false,
        "emailNotificationActions": false,
        "exitCode": "0",
        "exportReleaseLevel": "7.4.0.0",
        "exportTable": "ops_simulation", 
        "otherOptions": "z/OS JCL Resolution",       
        "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", 
        "otherOptions": "z/OS JCL Resolution",               
        "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",     
        "otherOptions": "z/OS JCL Resolution",   
        "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"
    }
]





...

XML ResponseJSON Response


Expand
titleXML


Code Block
languagetext
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<simulation exportReleaseLevel="7.4.0.0" exportTable="ops_simulation" retainSysIds="true">
    <abortActions>true</abortActions>
    <emailNotificationActions>false</emailNotificationActions>
    <exitCode>0</exitCode>
    <otherOptions>z/OS JCL Resolution</otherOptions>
    <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>





Expand
titleJSON


Code Block
languagetext
{
    "abortActions": true,
    "emailNotificationActions": false,
    "exitCode": "0",
    "exportReleaseLevel": "7.4.0.0",
    "exportTable": "ops_simulation",   
    "otherOptions": "z/OS JCL 
Resolution</otherOptions>
Resolution", 
    "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,
    "retainSysIds": 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"
}