Page Comparison

...

Universal Controller supports the following RESTful-based web services for SAP Task operations, which are listed alphabetically on this page.

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

Links to detailed information about the properties used in these web services also is located on this page.

...

	Description
URI	http://host_name/uc/resources/task
HTTP Method	POST
Description	Creates a new SAP task.
Example URI	http://localhost:8080/uc/resources/task
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example	See SAP Task: XML and JSON Examples, below.
Properties	See 63547595 Properties.
Example Response	Status 200 /OK Successfully created the <task type> task with sysId <sysId>.

...

	Description
URI	http://host_name/uc/resources/task
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
HTTP Method	PUT
Description	Modifies the task specified by the sysId in the request. To modify SAP Task properties without modifying related records, use the excludeRelated property.
Example	See SAP Task: XML and JSON Examples.
Properties	See 63547595 Properties.
Example Response	Status 200 /OK Successfully updated the <task type> task with sysId <sysId> to version <version>.

...

	Description
URI	http://host_name/uc/resources/task
HTTP Method	GET
Description	Retrieves information on the specified task.
Request Parameters	`taskid` or `taskname`
Mutually Exclusive Parameters	`taskid` and `taskname`
Example URI	http://localhost:8080/uc/resources/task?taskname=testTask http://localhost:8080/uc/resources/task?taskid=d26265a2c4f345359d9b356f18a462c1
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example Response	Status 200 /OK (See SAP Task: XML and JSON Examples.) Status 404 /Not Found A task with id "f87848b00a0001037f43e7c81c8ec969" does not exist.
Properties	See 63547595 Properties.

Anchor

	SAP Task XML and JSON Examples
	SAP Task XML and JSON Examples

...

Examples

XML

JSON

Example for Task

Expand

title	XML

<taskSap exportReleaseLevel="7.2.0.0" exportTable="ops_task_sap" retainSysIds="true" version="1">
       <actions />
       <variables />
       <notes />
       <virtualResources />
       <exclusiveTasks />
       <agent>AGNT0001</agent>
       <agentCluster />
       <agentClusterVar />
       <agentVar />
       <avgRunTime>3</avgRunTime>
       <avgRunTimeDisplay>3 Seconds</avgRunTimeDisplay>
       <broadcastCluster />
       <cpDuration />
       <cpDurationUnit>Minutes</cpDurationUnit>
       <credentials />
       <credentialsVar /> 
       <customField1 label="Domain">web.com</customField1>
       <customField2 />
       <efDayConstraint>Nth</efDayConstraint>
       <efDuration>00:00:00:00</efDuration>
       <efEnabled>false</efEnabled>
       <efNthAmount>10</efNthAmount>
       <efOffsetDuration />
       <efOffsetDurationUnit>Minutes</efOffsetDurationUnit>
       <efOffsetPercentage>0</efOffsetPercentage>
       <efOffsetType>Percentage</efOffsetType>
       <efTime>00:00</efTime>
       <efType>Time</efType>
       <executionRestriction>Run</executionRestriction>
       <firstRun>2021-03-15 13:59:37 -0400</firstRun>
       <holdResources>false</holdResources>
       <lastRun>2021-03-16 17:12:42 -0400</lastRun>
       <lastRunTime>9</lastRunTime>
       <lastRunTimeDisplay>9 seconds</lastRunTimeDisplay>
       <lfDayConstraint>Nth</lfDayConstraint>
       <lfDuration>00:00:00:00</lfDuration>
       <lfEnabled>false</lfEnabled>
       <lfNthAmount>1</lfNthAmount>
       <lfOffsetDuration />
       <lfOffsetDurationUnit>Minutes</lfOffsetDurationUnit>
       <lfOffsetPercentage>0</lfOffsetPercentage>
       <lfOffsetType>Percentage</lfOffsetType>
       <lfTime>00:00</lfTime>
       <lfType>Time</lfType>
       <lsDayConstraint>Nth</lsDayConstraint>
       <lsDuration>00:00:00:00</lsDuration>
       <lsEnabled>false</lsEnabled>
       <lsNthAmount>7</lsNthAmount>
       <lsTime>00:00</lsTime>
       <lsType>Time</lsType>
       <maxRunTime>9</maxRunTime>
       <maxRunTimeDisplay>9 Seconds</maxRunTimeDisplay>
       <minRunTime>3</minRunTime>
       <minRunTimeDisplay>3 Seconds</minRunTimeDisplay>
       <name>uc - Test Email</name>
       <opswiseGroups /> 
       <resolveNameImmediately>false</resolveNameImmediately>
       <resPriority>10</resPriority>
       <restrictionPeriod>Span</restrictionPeriod>
       <restrictionPeriodAfterDate>2017-11-10</restrictionPeriodAfterDate>
       <restrictionPeriodAfterTime>10:30</restrictionPeriodAfterTime>
       <restrictionPeriodBeforeDate>2017-11-20</restrictionPeriodBeforeDate>
       <restrictionPeriodBeforeTime>15:00</restrictionPeriodBeforeTime>
       <restrictionPeriodDateList />
       <runCount>32</runCount>
       <runTime>108</runTime>
       <startHeld>true</startHeld>
       <startHeldReason>hold reason</startHeldReason> 
       <summary />
       <sysId>f87848b00a0001037f43e7c81c8ec969</sysId>
       <timeZonePref>-- System Default --</timeZonePref>
       <twDelayAmount />
       <twDelayDuration>00:00:01:00</twDelayDuration>
       <twDelayType>Duration</twDelayType>
       <twWaitAmount />
       <twWaitDayConstraint />
       <twWaitDuration>00:00:00:00</twWaitDuration>
       <twWaitTime>00:00</twWaitTime>
       <twWaitType>Time</twWaitType>
       <twWorkflowOnly>Yes</twWorkflowOnly>
       <userEstimatedDuration>00:00:00:02</userEstimatedDuration>
       <chainDesc />
       <chainId />
       <commandGroup>Run</commandGroup>
       <commandOptions />
       <dataSource />
       <defFile />
       <definitionOrModel>USAP Definition File</definitionOrModel>
       <definitionOrModelJobVar>USAP Definition File</definitionOrModelJobVar>
       <dispAbapName />
       <dispSapEventId />
       <dispSapEventParm />
       <dispVariant />
       <environment />
       <exitCodeOutput />
       <exitCodeProcessing>Success Exitcode Range</exitCodeProcessing>
       <exitCodeText />
       <exitCodes>0</exitCodes>
       <immediate>true</immediate>
       <infoPackage />
       <infoPackageJobName />
       <infoSource />
       <jobId />
       <jobLog>true</jobLog>
       <jobName />
       <jobStatus />
       <logId />
       <outputFailureOnly>true</outputFailureOnly>
       <outputReturnFile />
       <outputReturnNline>100</outputReturnNline>
       <outputReturnSline>1</outputReturnSline>
       <outputReturnText />
       <outputReturnType>OUTERR</outputReturnType>
       <outputType>STDOUT</outputType>
       <pcRestart>false</pcRestart>
       <printAppLog>true</printAppLog>
       <printAppRc>true</printAppRc>
       <purge>false</purge>
       <repositoryOrFilesys>Script Library</repositoryOrFilesys>
       <requestId />
       <retryIndefinitely>false</retryIndefinitely>
       <retryInterval>60</retryInterval>
       <retryMaximum>0</retryMaximum>
       <retrySuppressFailure>false</retrySuppressFailure>
       <runtimeDir />
       <sapCommandMask />
       <sapCmProfileId />
       <sapCmProfileType />
       <sapCmXmlFile />
       <sapConnection />
       <sapConnectionVar />
       <sapCred>uc - Db Credentials</sapCred>
       <sapCredVar />
       <sapDispConfirmEvents>false</sapDispConfirmEvents>
       <sapDispEventSelectState>New</sapDispEventSelectState>
       <sapDisplayCommand />
       <sapEventId />
       <sapEventParm />
       <sapFromDate />
       <sapLang />
       <sapPrinterName />
       <sapToDate />
       <script>test script</script>
       <sourceSystem />
       <spoollist>true</spoollist>
       <start>false</start>
       <stepNum />
       <targetJobName />
       <targetServer>serv1</targetServer>
       <targetVariantName />
       <useAppRc>false</useAppRc>
       <wait>false</wait>
       <waitForOutput>false</waitForOutput>
</taskSap>

Expand

title	JSON

{
  "type": "taskSap",
  "actions": {
    "abortActions": [],
    "emailNotifications": [],
    "setVariableActions": [],
    "snmpNotifications": [],
    "systemOperations": []
  },
  "agent": null,  
  "agentCluster": "uc Demo Cluster",
  "agentClusterVar": null,
  "agentVar": null,
  "avgRunTime": 3,
  "avgRunTimeDisplay": "3 Seconds",
  "broadcastCluster": null,
  "chainDesc": null,
  "chainId": null,
  "commandGroup": "Run",
  "commandOptions": null,
  "cpDuration": null,
  "cpDurationUnit": "Minutes",
  "credentials": null,
  "credentialsVar": null,
  "customField1": {
    "label": "Domain",
    "value": "http://qa-cntlr-mssql:8080/uc/"
  },
  "customField2": {
    "label": null,
    "value": null
  },
  "dataSource": null,
  "defFile": null,
  "definitionOrModel": "USAP Definition File",
  "definitionOrModelJobVar": "USAP Definition File",
  "dispAbapName": null,
  "dispSapEventId": null,
  "dispSapEventParm": null,
  "dispVariant": null,
  "efDayConstraint": "Nth Day",
  "efDuration": "00:00:00:00",
  "efEnabled": false,
  "efNthAmount": 10,
  "efOffsetDuration": null,  
  "efOffsetDurationUnit": "Minutes",
  "efOffsetPercentage": 0,
  "efOffsetType": "Percentage",
  "efTime": "00:00",
  "efType": "Time",
  "environment": null,
  "excludeRelated": false,
  "exclusiveTasks": [],
  "executionRestriction": "Run",
  "exitCodeOutput": null,
  "exitCodeProcessing": "Success Exitcode Range",
  "exitCodeText": null,
  "exitCodes": 0,
  "exportReleaseLevel": "7.2.0.0",
  "exportTable": "ops_task_sap",
  "firstRun": "2021-03-15 13:59:37 -0400",
  "holdResources": false,
  "immediate": true,
  "infoPackage": null,
  "infoPackageJobName": null,
  "infoSource": null,
  "jobId": null,
  "jobLog": true,
  "jobName": null,
  "jobStatus": null,
  "lastRun": "2021-03-16 17:12:42 -0400",
  "lastRunTime": 9,
  "lastRunTimeDisplay": "9 Seconds",
  "lfDayConstraint": "Nth Day",
  "lfDuration": "00:00:00:00",
  "lfEnabled": false,
  "lfNthAmount": 1,
  "lfOffsetDuration": null,  
  "lfOffsetDurationUnit": "Minutes",
  "lfOffsetPercentage": 0,
  "lfOffsetType": "Percentage",
  "lfTime": "00:00",
  "lfType": "Time",
  "lsDayConstraint": "Nth Day",
  "lsDuration": "00:00:00:00",
  "lsEnabled": false,
  "lsNthAmount": 7,
  "lsTime": "00:00",
  "lsType": "Time",
  "maxRunTime": 9,
  "maxRunTimeDisplay": "9 Seconds",
  "minRunTime": 3,
  "minRunTimeDisplay": "3 Seconds",
  "name": "uc - Test Email",
  "notes": [],
  "opswiseGroups": null, 
  "outputFailureOnly": true,
  "outputReturnFile": null,
  "outputReturnNline": 100,
  "outputReturnSline": 1,
  "outputReturnText": null,
  "outputReturnType": "OUTERR",
  "outputType": "STDOUT",
  "pcRestart": false,
  "printAppLog": true,
  "printAppRc": true,
  "purge": false,
  "repositoryOrFilesys": "Script Library",
  "requestId": null,
  "resolveNameImmediately": false,
  "resPriority": 10,
  "restrictionPeriod": "Span",
  "restrictionPeriodAfterDate": "2017-11-10",
  "restrictionPeriodAfterTime": "10:30",
  "restrictionPeriodBeforeDate": "2017-11-20",
  "restrictionPeriodBeforeTime": "15:00",
  "restrictionPeriodDateList": [],
  "retainSysIds": true,
  "retryIndefinitely": false,
  "retryInterval": 60,
  "retryMaximum": 0,
  "retrySuppressFailure": false,
  "runCount": 32,
  "runTime": 108,
  "runtimeDir": null,
  "sapCommandMask": null,
  "sapCmProfileId": null,
  "sapCmProfileType": null,
  "sapCmXmlFile": null,
  "sapConnection": null,
  "sapConnectionVar": null,
  "sapCred": "uc - Db Credentials",
  "sapCredVar": null,
  "sapDispConfirmEvents": false,
  "sapDispEventSelectState": "New",
  "sapDisplayCommand": null,
  "sapEventId": null,
  "sapEventParm": null,
  "sapFromDate": null,
  "sapLang": null,
  "sapPrinterName": null,
  "sapToDate": null,
  "script": "test script",
  "sourceSystem": null,
  "spoollist": true,
  "start": false,
  "startHeld": false,
  "startHeldReason": null,  
  "stepNum": null,
  "summary": "Test Email",
  "sysId": "fb59a227517a421a92c15ff5aefe3b66",
  "targetJobName": null,
  "targetServer": "serv1",
  "targetVariantName": null,
  "timeZonePref": "-- System Default --",
  "twDelayAmount": null,
  "twDelayDuration": "00:00:00:00",
  "twDelayType": "None",
  "twWaitAmount": null,
  "twWaitDayConstraint": "NONE",
  "twWaitDuration": "00:00:00:00",
  "twWaitTime": "00:00",
  "twWaitType": "None",
  "twWorkflowOnly": "-- System Default --",
  "useAppRc": false,
  "userEstimatedDuration": null,
  "variables": [],
  "version": 1,
  "virtualResources": [],
  "wait": false,
  "waitForOutput": false
}

See Task Web Services - Task Actions for XML and JSON examples of task actions.

...

Versions Compared

Old Version 3

New Version Current

Key