Workflow Task Web Services

Owned by Former user (Deleted)
Last updated: Mar 16, 2022
10 min read

Overview

Universal Controller supports the following RESTful-based web services for Workflow Task operations.

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 Workflow Task web services that are applicable to all task types, see:

For a list of Workflow Vertex and Edge web services, see:

Create a Workflow Task


Description

URI

http://host_name/uc/resources/task

HTTP Method

POST

Description

Creates a new Workflow task.

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example

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

Example Response

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

Read a Workflow 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

http://localhost:8080/uc/resources/task?taskname=test

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

Workflow Task: XML and JSON Examples

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

The exportReleaseLevel and /wiki/spaces/UC71x/pages/5179227 properties are specified as attributes in XML.


Examples

XML

JSON

Example for Task

 XML
<taskWorkflow exportReleaseLevel="7.2.0.0" exportTable="ops_task_workflow" retainSysIds="true" version="1">
       <actions />
       <variables />
       <notes />
       <virtualResources />
       <exclusiveTasks />
       <stepConditions />
       <stepActions />
       <runCriteria />
       <workflowVertices>
		        <workflowVertex>
                        <alias />
                        <task>Sleep 30</task>
                        <vertexId>2</vertexId>
                        <vertexX>360</vertexX>
                        <vertexY>60</vertexY>
                </workflowVertex>
                <workflowVertex>
                        <alias />
                        <task>Sleep 60</task>
                        <vertexId>3</vertexId>
                        <vertexX>360</vertexX>
                        <vertexY>170</vertexY>
                </workflowVertex>
                <workflowVertex>
                        <alias />
                        <task>zos task</task>
                        <vertexId>4</vertexId>
                        <vertexX>560</vertexX>
                        <vertexY>50</vertexY>
                </workflowVertex>
                <workflowVertex>
                        <alias />
                        <task>uc - Windows Sleep</task>
                        <vertexId>5</vertexId>
                        <vertexX>390</vertexX>
                        <vertexY>310</vertexY>
                </workflowVertex>
       </workflowVertices>
       <workflowEdges>
                <workflowEdge>
                        <condition>Success</condition>
                        <sourceId>2</sourceId>
                        <straightEdge>true</straightEdge>
                        <targetId>3</targetId>
                </workflowEdge>
                <workflowEdge>
                        <condition type="Exit Code">123</condition>
                        <sourceId>3</sourceId>
                        <straightEdge>true</straightEdge>
                        <targetId>5</targetId>
                </workflowEdge>
                <workflowEdge>
                        <condition type="Step Condition">1:*:*:1</condition>
                        <sourceId>4</sourceId>
                        <straightEdge>true</straightEdge>
                        <targetId>2</targetId>
                </workflowEdge>
       </workflowEdges>
       <avgRunTime>3</avgRunTime>
       <avgRunTimeDisplay>3 Seconds</avgRunTimeDisplay>
       <cpDuration />
       <cpDurationUnit>Minutes</cpDurationUnit>
       <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>
       <skippedOption>Show Skipped</skippedOption>
       <startHeld>false</startHeld>
       <startHeldReason />
       <summary />
       <sysId>c835007fc0a802650080dabfc04d4d67</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 />
       <calculateCp>false</calculateCp>
       <calendar />
       <layoutOption>-- None --</layoutOption>
       <numberOfTasks>10</numberOfTasks>
       <overrideCalendar>false</overrideCalendar>
       <skippedOption>Show Skipped</skippedOption>
</taskWorkflow>
 JSON
{
  "type": "taskWorkflow",
  "actions": {
     "abortActions": [],
     "emailNotifications": [],
     "setVariableActions": [],
     "snmpNotifications": [],
     "systemOperations": []
  },
  "avgRunTime": 3,
  "avgRunTimeDisplay": "3 Seconds",
  "calculateCp": false,
  "calendar": null,
  "cpDuration": null,
  "cpDurationUnit": "Minutes",
  "customField1": {
    "label": "Domain",
    "value": null
  },
  "customField2": {
    "label": null,
    "value": 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",
  "excludeRelated": false,
  "exclusiveTasks": [],
  "executionRestriction": "Run",
  "exportReleaseLevel": "7.2.0.0",
  "exportTable": "ops_task_manual",
  "firstRun": "2021-03-15 13:59:37 -0400",
  "holdResources": false,
  "lastRun": "2021-03-16 17:12:42 -0400",
  "lastRunTime": 9,
  "lastRunTimeDisplay": "9 Seconds",
  "layoutOption": "-- None --",
  "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": "test-wkfl-web-service",
  "notes": [],
  "numberOfTasks": 2,
  "opswiseGroups": [],
  "overrideCalendar": false,
  "resolveNameImmediately": false,
  "resPriority": 10,
  "restrictionPeriod": "Span",
  "restrictionPeriodAfterDate": "2017-11-10",
  "restrictionPeriodAfterTime": "10:30",
  "restrictionPeriodBeforeDate": "2017-11-20",
  "restrictionPeriodBeforeTime": "15:00",
  "restrictionPeriodDateList": [],
  "retainSysIds": true,
  "runCount": 32,
  "runCriteria": [],
  "runTime": 108,
  "skippedOption": "Show Skipped",
  "startHeld": false,
  "startHeldReason": null,  
  "stepActions": [],
  "stepConditions": [],
  "summary": null,
  "sysId": "fb59a227517a421a92c15ff5aefe3b66",
  "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": 2,
  "virtualResources": [],
"workflowEdges": [ {
  "condition": {
    "value": "Success"
  },
  "sourceId": {
    "taskName": "SB_ZOS_Task ",
    "value": "2"
  },
  "straightEdge": true,
  "targetId": {
    "taskAlias": "Timer 0",
    "taskName": "Sleep 0",
    "value": "3"
  }
} ],
    "workflowVertices": [ {
       "alias": null,
       "task": {
          "value": "SB_ZOS_Task"
       },
       "vertexId": "2",
       "vertexX": "480",
       "vertexY": "90"
       },{
       "alias": "Timer 0",
       "task": {
          "value": "Sleep 0"
       },
       "vertexId": "3",
       "vertexX": "480",
       "vertexY": "270"
       }]
}


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.

See Workflow Task - Workflow Task-Related Records for XML and JSON examples of Worklfow task-related records.

Properties