Universal Task Web Services

Owned by Stonebranch (Deactivated)
Last updated: Jul 15, 2024
9 min read

Overview

Universal Controller supports the following RESTful-based web services for Universal 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.
 

For information on Task web services that are applicable to all task types, see:

Create a Universal Task


Description

URI

http://host_name/uc/resources/task

HTTP Method

POST

Description

Creates a new Universal task.
 
To persist sysIds, use the retainSysIds property.

Example URI

http://localhost:8080/uc/resources/task

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example

See Universal Task: XML and JSON Examples, below.

Properties

See Properties.

Example Response

  • Status 200 /OK
    Successfully created the <task type> task with sysId <sysId>.

Modify a Universal Task


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 Universal Task properties without modifying related records, use the excludeRelated property.

Example

See Universal Task: XML and JSON Examples.

Properties

See Properties.

Example Response

  • Status 200 /OK
    Successfully updated the <task type> task with sysId <sysId> to version <version>.

Read a Universal Task


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

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

Properties

See Properties.

Universal Task: XML and JSON Examples

The retainSysIds and version properties are specified as attributes in XML.

The exportReleaseLevel and exportTable properties are specified as attributes in XML.


Examples

XML

JSON

Example for Task

 XML
<taskUniversal exportReleaseLevel="7.2.0.0" exportTable="ops_task_universal" retainSysIds="true" version="1">
       <actions />
       <variables />
       <notes />
       <virtualResources />
       <exclusiveTasks />
       <agent />
       <agentCluster>uc Demo Cluster</agentCluster>
       <agentClusterVar />
       <agentVar />
       <avgRunTime>3</avgRunTime>
       <avgRunTimeDisplay>3 Seconds</avgRunTimeDisplay>
       <broadcastCluster />
       <broadcastClusterVar />
       <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>false</startHeld>
       <startHeldReason /> 
       <summary>Test Email</summary>
       <sysId>fb59a227517a421a92c15ff5aefe3b66</sysId>
       <timeZonePref>-- System Default --</timeZonePref>
       <twDelayAmount />
       <twDelayDuration>00:00:00:00</twDelayDuration>
       <twDelayType>None</twDelayType>
       <twWaitAmount />
       <twWaitDayConstraint>NONE</twWaitDayConstraint>
       <twWaitDuration>00:00:00:00</twWaitDuration>
       <twWaitTime>00:00</twWaitTime>
       <twWaitType>None</twWaitType>
       <twWorkflowOnly>-- System Default --</twWorkflowOnly>
       <userEstimatedDuration />
       <arrayField1 name="array1" label="Customers" nameTitle="Custom Name" valueTitle="Custom Id">
           <field>
               <name>John Doe Jr.</name>
               <value>1234567</value>
           </field>
           <field>
               <name>Max</name>
               <value>888888</value>
           </field>
       </arrayField1>
       <arrayField2 name="array2" label="Array2">
           <field>
               <name>A1</name>
               <value>test1</value>
           </field>
           <field>
               <name>A2</name>
               <value>test2</value>
           </field>
       </arrayField2>
       <booleanField1 name="run_immediately" label="Run Immediately">false</booleanField1>
       <choiceField1 name="progname" label="Program Name">val 1</choiceField1>
       <createConsole>false</createConsole>
       <credentialField1 name="credname" label="Credential Name">cred 1</credentialField1>
       <desktopInteract>false</desktopInteract>
       <elevateUser>false</elevateUser>
       <environment />
       <exitCodeOutput />
       <exitCodeProcessing>Success Exitcode Range</exitCodeProcessing>
       <exitCodes>0</exitCodes>
       <exitCodeText />
       <floatField1 name="float1" label="float1">2.1274</floatField1>
       <intField1 name="error_level" label="Error Level">12</intField1>
       <largeTextField1 name="respapp" label="Responsibility Application">test text</largeTextField1>
       <outputFailureOnly>true</outputFailureOnly>
       <outputReturnFile />
       <outputReturnNline>100</outputReturnNline>
       <outputReturnSline>1</outputReturnSline>
       <outputReturnText />
       <outputReturnType>NONE</outputReturnType>
       <outputType>STDOUT</outputType>
       <retryExitCodes />
       <retryIndefinitely>false</retryIndefinitely>
       <retryInterval>60</retryInterval>
       <retryMaximum>0</retryMaximum>
       <retrySuppressFailure>false</retrySuppressFailure>
       <runtimeDir />
       <scriptField1 name="s1" label="Script 1">Data3.txt</scriptField1>
       <template>test template</template>
       <textField1 name="username" label="Application User">test text</textField1>
</taskUniversal>
 JSON
{
  "type": "taskUniversal",
  "actions": {
    "abortActions": [],
    "emailNotifications": [],
    "setVariableActions": [],
    "snmpNotifications": [],
    "systemOperations": []
  },
  "agent": null,
  "agentCluster": "uc Demo Cluster",
  "agentClusterVar": null,
  "agentVar": null,
  "arrayField1":{
        "fields":[
            {
                "name": "John Doe Jr.",
                "value": "1234567"
            },
            {
                "name": "Max",
                "value": "888888"
            }
        ],
        "label": "Customers",
        "name": "array1",
        "nameTitle": "Custom Name",
        "valueTitle": "Custom Id"
  },
    "arrayField2": {
        "fields":[
            {
                "name": "A1",
                "value": "test1"
            },
            {
                "name": "A2",
                "value": "test2"
            }
        ],
        "label": "Array2",
        "name": "array2"
},
  "avgRunTime": 3,
  "avgRunTimeDisplay": "3 Seconds",
  "booleanField1": {
    "label": "Run Immediately",
    "name": "run_immediately",
    "value": false
  },
  "broadcastCluster": null,
  "broadcastClusterVar": null,
  "choiceField1": {
    "label": "Program Name",
    "name": "progname",
    "value": "1"
  },
  "cpDuration": null,
  "cpDurationUnit": "Minutes",
  "createConsole": false,
  "credentialField1": {
    "label": "Credential Name",
    "name": "credname",
    "value": "A"
  },
  "credentials": null,
  "credentialsVar": null,
  "customField1": {
    "label": "Domain",
    "value": "http://qa-cntlr-mssql:8080/uc/"
  },
  "customField2": {
    "label": null,
    "value": null
  },
  "desktopInteract": false, 
  "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",
  "elevateUser": false,
  "environment": null,
  "excludeRelated": false,
  "exclusiveTasks": [],
  "executionRestriction": "Run",
  "exitCodeOutput": null,
  "exitCodeProcessing": "Success Exitcode Range",
  "exitCodes": 0,
  "exitCodeText": null,
  "exportReleaseLevel": "7.2.0.0",
  "exportTable": "ops_task_universal",
  "firstRun": "2021-03-15 13:59:37 -0400",
  "floatField1": { 
    "label": "float 1",
    "name": "float 1",
    "value": 2.1274 
  },
  "holdResources": false,
  "intField1": {
    "label": "Error Level",
    "name": "error_level",
    "value": 12
  },
  "largeTextField1": {
    "label": "Responsibility Application",
    "name": "respapp",
    "value": "test text"
  },
  "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": "NONE",
  "outputType": "STDOUT",
  "resolveNameImmediately": false,
  "resPriority": 10,
  "restrictionPeriod": "Span",
  "restrictionPeriodAfterDate": "2017-11-10",
  "restrictionPeriodAfterTime": "10:30",
  "restrictionPeriodBeforeDate": "2017-11-20",
  "restrictionPeriodBeforeTime": "15:00",
  "restrictionPeriodDateList": [],
  "retainSysIds": true,
  "retryExitCodes": null,
  "retryIndefinitely": false,
  "retryInterval": 60,
  "retryMaximum": 0,
  "retrySuppressFailure": false,
  "runCount": 32,
  "runTime": 108,
  "runtimeDir": null,
  "scriptField1": {
    "label": "Script 1",
    "name": "s1",
    "value": "Data3.txt"
  },
  "startHeld": false,
  "startHeldReason": null,  
  "summary": "Test Email",
  "sysId": "fb59a227517a421a92c15ff5aefe3b66",
  "template": "test template",
  "textField1": {
    "label": "Application User",
    "name": "username",
    "value": "test text"
  },
  "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 --",
  "userEstimatedDuration": null,
  "variables": [],
  "version": 1,
  "virtualResources": []
}


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

See Task Web Services - Task-Related Records for XML and JSON examples of task-related records.

Properties