...

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

Create a Workflow Task
List Workflow Forecast
Modify a Workflow Task
Read a Workflow Task

...

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

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

...

Workflow Task and Dependency Web Services

Anchor

	Create a Workflow Task
	Create a Workflow Task

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>.

...

List Workflow Forecast

	Description
URI	http://host_name/uc/resources/task
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/aworkflow/forecast
Authentication	HTTP Basic
HTTP Method	PUTGET
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>.

...

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	Get Forecast Details
Example URI	http://localhost:8080/uc/resources/workflow/forecast?workflowname=work_4

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.

Example for Task<taskWorkflow exportReleaseLevel="7.2.0.0" exportTable="ops_task_workflow" retainSysIds="true" version="1"

http://localhost:8080/uc/resources/workflow/taskforecast?taskname=test

Examples

XML

JSON

Anchor

Example for Task

Expand

title	XML

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

Status 200 /OK
(See Workflow Task: XML and JSON Examples.)
Status 404 /Not Found
A task with id "f87848b00a0001037f43e7c81c8ec969" does not exist.

...

workflowname=work_4&time=10:10&date=2022-01-06 http://localhost:8080/uc/resources/workflow/forecast?workflowname=work_4&calendarname=System Default&timezone=GMT-6&date=2022-01-08 http://localhost:8080/uc/resources/workflow/forecast?workflowname=work_4&calendarname=System Default&timezone=GMT-6&date=2022-01-08&triggername=trigger-1 http://localhost:8080/uc/resources/workflow/forecast?workflowname=work_4&exclude=Run&exclude=Skip http://localhost:8080/uc/resources/workflow/forecast?workflowname=work_4&variable=name1:value1&variable=name2:value2
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example	See List Workflow Forecast: XML and JSON Examples, below.
Properties	See List Workflow Forecast: URI Parameters, below.

List Workflow Forecast: URI Parameters

Property	Description	Specifications	Required	Mutually Exclusive With
`workflowid`	ID used within the Controller to identify the workflow.	String; URI parameter.	Y (unless workflowname is specified)	`workflowname`
`workflowname`	Name used within the Controller to identify the workflow.	String; URI parameter.	Y (unless workflowid is specified)	`workflowid`
`calendarid`	Unique ID for the Calendar.		N (unless calendarname is specified)	`calendarname`
`calendarname`	Name used within the Controller to identify the Calendar.	Maximum 100 alphanumeric.	N (unless calendarid is specified)	`calendarid`
`triggerid`	Unique ID for this trigger.		N (unless triggername is specified)	`triggername`
`triggername`	Name used within the Controller to identify this trigger.	Maximum 255 alphanumeric.	N (unless triggerid is specified)	`triggerid`
`date`	Date of the forecast.	Date (yyyy-mm-dd)	N
`time`	Time of the forecast.	Time(HH:mm)	N
`timezone`	Timezone.		N
`forecastTimezone`	Forecast Timezone.		N
`exclude`	Exclude the forecast types in the response.	Valid values: As String = Not Evaluated, As Value = 1 As String = Run, As Value = 2 As String = Skip, As Value = 3 As String = Run, As Value = 4 As String = Skip, As Value = 5	N
`variable`	Override the variables.	List of name:value variables

List Workflow Forecast: XML and JSON Examples

<avgRunTimeDisplay>3Seconds</avgRunTimeDisplay><cpDuration/> <cpDurationUnit>Minutes</cpDurationUnit><customField1label=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>9seconds</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>9Seconds</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>--SystemDefault--</twWorkflowOnly><userEstimatedDuration/><calculateCp>false</calculateCp><calendar/> <layoutOption>-- None --</layoutOption> <numberOfTasks>10</numberOfTasks><overrideCalendar>false</overrideCalendar> <skippedOption>ShowSkipped</skippedOption></taskWorkflow>{typetaskWorkflow"actions{ "abortActions":[], emailNotifications[],setVariableActions[], "snmpNotifications":[], systemOperations:[]},
"avgRunTime":3,
avgRunTimeDisplay3 Seconds"calculateCp": false,calendarnull"cpDuration":null,cpDurationUnitMinutes
criticalEndpointnull"customField1":{labelDomainvaluenull }"customField2":{labelnull,valuenull },"efDayConstraint":"NthDay",efDuration00: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": nulltask{ valueSB_ZOS_Task" },vertexId2vertexX480vertexY90" },{ aliasTimer0task { valueSleep 0"}, vertexId3vertexX480vertexY270 }] }

Examples

XML

JSON

Response

Expand

title	XML

Code Block

language	text

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<workflowForecast>
    <forecast>
        <agent />

<actions

 <agentCluster />

<variables

 <agentClusterVariable />

<notes

<agentVariable />

<virtualResources

 <businessServices/>

<exclusiveTasks

<clusterBroadcast />

<stepConditions

 <clusterBroadcastVariable />
        <created>2023-01-12 17:24:45 -0500</created>

   <createdBy>ops.admin</createdBy>
        <endTime>2022-01-08 10:04:32 -0500</endTime>
        <endTimeAccuracy>High</endTimeAccuracy>

<launchTime>2022-01-08 10:03:00 -0500</launchTime>

<criticalEndpoint

 <runSkipEvalution>Run</

>

runSkipEvalution>

 <sysId>3dd2ff81f3934898adba1396b44a7537</sysId>

 <task>work-1</task>
        <taskType>Workflow</taskType>
        <trigger>work-1 #TRIGGER#</trigger>

<alias

/>

   <triggerTime>2022-01-08 10:03:00 -0500</triggerTime>
        <updated>2023-01-12 17:24:45 -0500</updated>

<task>Sleep 30</task>

<updatedBy>ops.admin</updatedBy>
        <vertexId />
        <workflow />

vertexId>2<

vertexId>

forecast>
    <forecast>
        <agent />
        <agentCluster

<vertexX>360<

vertexX

>
        <agentClusterVariable />

<vertexY>60</vertexY

<agentVariable />
        <businessServices/>

</workflowVertex>

 <clusterBroadcast />
        <clusterBroadcastVariable />

    <created>2023-01-12 17:24:46 -0500</created>
        <createdBy>ops.admin</createdBy>

<endTime>2022-01-08 10:03:41 -0500</endTime>
        <endTimeAccuracy>Medium</endTimeAccuracy>
        <launchTime>2022-01-08

10:03:41 -0500</launchTime>

<task>Sleep

60</task>

      <runSkipEvalution>Run</runSkipEvalution>
        <sysId>088f8283fcdf42d7858bc991d42e8e66</sysId>
        <task>Sleep

<vertexId>3<

0</

vertexId>

task>
        <taskType>Timer</taskType>
        <trigger>work-1 #TRIGGER#</trigger>

   <triggerTime>2022-01-08 10:03:00 -0500</triggerTime>
        <updated>2023-01-12 17:24:46 -0500</updated>

<vertexY>170<

<updatedBy>ops.admin</

vertexY>

updatedBy>
        <vertexId>3</vertexId>

<

<workflow>work-1</

workflowVertex>

workflow>
    </forecast>
    <forecast>

  <agent />
        <agentCluster />

<alias

<agentClusterVariable />
        <agentVariable />

<businessServices/>

<task>zos

task</task>

    <clusterBroadcast />
        <clusterBroadcastVariable />

<created>2023-01-12 17:24:46 -0500</created>
        <createdBy>ops.admin</createdBy>
        <endTime>2022-01-08 10:03:41 -0500</endTime>

   <endTimeAccuracy>Medium</endTimeAccuracy>
        <launchTime>2022-01-08 10:03:11 -0500</launchTime>
        <runSkipEvalution>Run</runSkipEvalution>

       <sysId>a7fa4a5b35854af297eb2f9197e63f97</sysId>
        <task>Sleep

<

30</

workflowVertex>

task>
        <taskType>Timer</taskType>

 <trigger>work-1 #TRIGGER#</trigger>

<triggerTime>2022-01-08 10:03:00 -0500</triggerTime>
        <updated>2023-01-12

17:24:46 -0500</updated>
        <updatedBy>ops.admin</updatedBy>
        <vertexId>2</vertexId>

<task>uc

 <workflow>work-

Windows Sleep</task>

1</workflow>
    </forecast>
    <forecast>
        <agent />

    <agentCluster />
        <agentClusterVariable />
        <agentVariable

<vertexX>390<

vertexX>

>
        <businessServices>

<businessService>A</businessService>
            <businessService>B</businessService>

</workflowVertex>

     </businessServices>

</workflowVertices>

      <clusterBroadcast />

        <clusterBroadcastVariable />

 <created>2023-01-12 17:24:46 -0500</created>
        <createdBy>ops.admin</createdBy>
        <endTime>2022-01-08

<condition>Success</condition>

10:03:05 -0500</endTime>
        <endTimeAccuracy>Medium</endTimeAccuracy>
        <launchTime>2022-01-08

10:03:00 -0500</launchTime>

      <runSkipEvalution>Run</runSkipEvalution>
        <sysId>efea93a7ed804280b6fbee22a29a004c</sysId>
        <task>Sleep

5</task>
        <taskType>Timer</taskType>
        <trigger>work-1 #TRIGGER#</trigger>

   <triggerTime>2022-01-08 10:03:00 -0500</triggerTime>
        <updated>2023-01-12

</workflowEdge>

17:24:46 -0500</updated>
        <updatedBy>ops.admin</updatedBy>

 <vertexId>5</vertexId>
        <workflow>work-1</workflow>
    </forecast>
    <forecast>

<condition

type="Exit

Code">123</condition>

  <agent />
        <agentCluster />
        <agentClusterVariable />

       <agentVariable />
        <businessServices>

     <businessService>C</businessService>
        </businessServices>

<clusterBroadcast

<targetId>5<

targetId>

>
        <clusterBroadcastVariable />

</workflowEdge>

  <created>2023-01-12 17:24:46 -0500</created>
        <createdBy>ops.admin</createdBy>

     <endTime>2022-01-08 10:03:15 -0500</endTime>
        <endTimeAccuracy>Medium</endTimeAccuracy>

<launchTime>2022-01-08 10:03:05 -0500</launchTime>
        <runSkipEvalution>Run</runSkipEvalution>
        <sysId>c0901a00837b46da99606d45998ba780</sysId>

  <task>Sleep 10</task>
        <taskType>Timer</taskType>

<trigger>work-1 #TRIGGER#</trigger>
        <triggerTime>2022-01-08 10:03:00 -0500</triggerTime>

<updated>2023-01-12 17:24:46 -0500</updated>
        <updatedBy>ops.admin</updatedBy>

<

<vertexId>6</

workflowEdge>

vertexId>

</workflowEdges>

<workflow>work-1</workflow>

</forecast>
<

avgRunTime>3</avgRunTime>

/workflowForecast>

Expand

title	JSON

Code Block

language	text

[
    {

      "agent": null,

"agentCluster": null,

agentClusterVariable": null,

 "agentVariable": null,

   "businessServices": [],

     "clusterBroadcast": null,

"clusterBroadcastVariable": null,
        "created": "2023-01-12 17:19:12 -0500",

    "createdBy": "ops.admin",

"endTime": "2022-01-08 10:04:32 -0500",
        "endTimeAccuracy": "High",
        "launchTime": "2022-01-08 10:03:00 -0500",

"runSkipEvalution": "Run",

 "sysId": "bca33d227d8d4bcda7e8ede5abe62994",

   "task": "work-1",

     "taskType": "Workflow",

"trigger": "work-1 #TRIGGER#",

 "triggerTime": "2022-01-08 10:03:00 -0500",
        "updated": "2023-01-12 17:19:12 -0500",
        "updatedBy":

"ops.admin",

"vertexId": null,

 "workflow": null

},
    {

     "agent": null,

"agentCluster": null,

  "agentClusterVariable": null,

"agentVariable": null,

"businessServices": [],

"clusterBroadcast": null,

"clusterBroadcastVariable": null,

 "created": "2023-01-12 17:19:12 -0500",

     "createdBy": "ops.admin",

"endTime": "2022-01-08 10:03:41 -0500",

    "endTimeAccuracy": "Medium",

"launchTime": "2022-01-08 10:03:41 -0500",

    "runSkipEvalution": "Run",

"sysId": "57232f7ecb3b4dae9ff1367442036a81",

"task": "Sleep 0",

  "taskType": "Timer",

   "trigger": "work-1 #TRIGGER#",

"triggerTime": "2022-01-08 10:03:00 -0500",

 "updated": "2023-01-12 17:19:12 -0500",

    "updatedBy": "ops.admin",

      "vertexId": "3",

"workflow": "work-1"
    },

  "agent": null,

    "agentCluster": null,

   "agentClusterVariable": null,

    "agentVariable": null,

      "businessServices": [],

"clusterBroadcast": null,

"clusterBroadcastVariable": null,

 "created": "2023-01-12 17:19:12 -0500",

Expand

title	JSON

createdBy": "

ops.admin",

      "endTime":

"2022-01-08 10:03:41 -0500",

endTimeAccuracy":

"Medium",
        "

launchTime":

"2022-01-08 10:03:11 -0500",

"runSkipEvalution": "

Run"

sysId": "

f531aa964eb6495e8e7549e13d2f3ea1",

task": "Sleep

30",

taskType": "

Timer",

trigger":

"work-1 #TRIGGER#",

triggerTime": "

2022-01-08 10:03:00 -0500",
        "

updated":

"2023-01-12 17:19:12 -0500",

updatedBy":

"ops.admin",
        "

vertexId":

"2",

workflow": "

work-1"

},

  {
        "agent": null,
        "agentCluster": null,
        "agentClusterVariable": null,
        "agentVariable": null,
        "businessServices": [
            "A",
            "B"
        ],
        "clusterBroadcast": null,
        "clusterBroadcastVariable": null,
        "created": "2023-01-12 17:19:12 -0500",
        "createdBy": "ops.admin",
        "endTime": "2022-01-08 10:03:05 -0500",
        "endTimeAccuracy": "Medium",
        "launchTime": "2022-01-08 10:03:00 -0500",
        "runSkipEvalution": "Run",
        "sysId": "2f9fee276640457ba1c743dfb683b9a6",
        "task": "Sleep 5",
        "taskType": "Timer",
        "trigger": "work-1 #TRIGGER#",
        "triggerTime": "2022-01-08 10:03:00 -0500",
        "updated": "2023-01-12 17:19:12 -0500",
        "updatedBy": "ops.admin",
        "vertexId": "5",
        "workflow": "work-1"
    },
    {
        "agent": null,
        "agentCluster": null,
        "agentClusterVariable": null,
        "agentVariable": null,
        "businessServices": [
            "C"
        ],
        "clusterBroadcast": null,
        "clusterBroadcastVariable": null,
        "created": "2023-01-12 17:19:12 -0500",
        "createdBy": "ops.admin",
        "endTime": "2022-01-08 10:03:15 -0500",
        "endTimeAccuracy": "Medium",
        "

launchTime":

"2022-01-08 10:03:05 -0500",
        "

runSkipEvalution": "

Run",
        "

sysId": "

12ca3120496e48f5be1ff5a5a103b927",
        "

task": "

Sleep 10",
        "

taskType": "

Timer",

trigger": "

work-1

#TRIGGER#",
        "

triggerTime":

 "2022-01-08 10:03:00 -0500",

updated": "

2023-01-12 17:19:12 -0500",

updatedBy": "

ops.admin",
        "

vertexId": "

6",
        "

workflow": "

work-1"
    }

...

Anchor

	Modify a Workflow Task
	Modify a Workflow Task

Modify a Workflow Task

	Description
URI	http://host_name/uc/resources/

workflow/forecast

Authentication

HTTP Basic

task
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
HTTP Method

GET

PUT

Description

Get Forecast Details

Example URI

http://localhost:8080/uc/resources/workflow/forecast?workflowname=work_4

http://localhost:8080/uc/resources/workflow/forecast?workflowname=work_4&time=10:10&date=2022-01-06

http://localhost:8080/uc/resources/workflow/forecast?workflowname=work_4&calendarname=System Default&timezone=GMT-6&date=2022-01-08

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>.

Anchor

	Read a Workflow Task
	Read a Workflow Task

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/

workflow/forecast

task?

workflowname=work_4&calendarname=System Default&timezone=GMT-6&date=2022-01-08&triggername=trigger-1

http://localhost:8080/uc/resources/workflow/forecast?workflowname=work_4&exclude=Run&exclude=Skip

http://localhost:8080/uc/resources/workflow/forecast?workflowname=work_4&variable=name1:value1&variable=name2:value2

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

List Workflow Forecast: XML and JSON Examples

Examples

XMLJSONResponse Expand

title	XML

Code Block

language	text

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <workflowForecast> <forecast>

taskname=test
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example Response	Status 200 /OK (See Workflow Task: XML and JSON Examples.) Status 404 /Not Found A task with id "f87848b00a0001037f43e7c81c8ec969" does not exist.

Anchor

	Workflow Task XML and JSON Examples
	Workflow Task XML and JSON Examples

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

Anchor

	Example for Task
	Example for Task

Example for Task

Expand

title	XML

<taskWorkflow exportReleaseLevel="7.2.0.0" exportTable="ops_task_workflow" retainSysIds="true" version="1">
       <actions />
       <variables />
       <notes />
       <virtualResources />
       <exclusiveTasks />
       <stepConditions />
       <stepActions />
       <runCriteria />
       <criticalEndpoint />
       <workflowVertices>
		        <workflowVertex>

<agent

<alias />

<agentCluster

/>

<agentClusterVariable

<task>Sleep

/>

30</task>

<agentVariable

/>

<businessServices

<vertexId>2</vertexId>

<clusterBroadcast

/>

<clusterBroadcastVariable

 <vertexX>360</vertexX>

<createdBy>ops.admin</createdBy>

       <vertexY>60</vertexY>

<endTime>2022-01-08

10:04:32

-0500</endTime>

    </workflowVertex>

<launchTime>2022-01-08

10:03:00

-0500</launchTime>

 <workflowVertex>

        <alias

<taskType>Workflow<

taskType>

<trigger>work-1

#TRIGGER#</trigger>

<triggerTime>2022-01-08

10:03:00

-0500</triggerTime>

    <task>Sleep 60</task>

<updated>2023-01-12

17:24:45

-0500</updated>

<updatedBy>ops.admin</updatedBy>

<vertexId

 <vertexId>3</

>

vertexId>

<workflow

/>

</forecast>

     <vertexX>360</vertexX>

<agent

/>

<agentCluster

/>

<agentClusterVariable

 <vertexY>170</

>

vertexY>

<agentVariable

/>

       </workflowVertex>

<clusterBroadcast

/>

    <workflowVertex>

<clusterBroadcastVariable

/>

<created>2023-01-12

17:24:46

-0500</created>

        <alias

<createdBy>ops.admin</createdBy>

/>

<endTime>2022-01-08

10:03:41

-0500</endTime>

<endTimeAccuracy>Medium</endTimeAccuracy>

   <task>zos task</task>

<launchTime>2022-01-08

10:03:41

-0500</launchTime>

<sysId>088f8283fcdf42d7858bc991d42e8e66<

<vertexId>4</

sysId>

vertexId>

<task>Sleep

0</task>

<taskType>Timer</taskType>

     <vertexX>560</vertexX>

<trigger>work-1 #TRIGGER#</trigger>

<triggerTime>2022-01-08

10:03:00

-0500</triggerTime>

<vertexY>50</vertexY>

<updatedBy>ops.admin</updatedBy>

     </workflowVertex>

    <workflowVertex>

</forecast>

<agent

/>

<agentCluster

<alias />

<agentClusterVariable

/>

       <task>uc -

<agentVariable

Windows Sleep</

>

task>

<clusterBroadcast

/>

     <vertexId>5</vertexId>

<clusterBroadcastVariable

/>

<created>2023-01-12

17:24:46

-0500</created>

<createdBy>ops.admin</createdBy>

<vertexX>390</vertexX>

<endTime>2022-01-08

10:03:41

-0500</endTime>

<endTimeAccuracy>Medium</endTimeAccuracy>

   <vertexY>310</vertexY>

<launchTime>2022-01-08

10:03:11

-0500</launchTime>

<runSkipEvalution>Run<

</

runSkipEvalution>

workflowVertex>

</workflowVertices>
       <workflowEdges>

<task>Sleep

30</task>

<taskType>Timer</taskType>

    <workflowEdge>

<trigger>work-1

#TRIGGER#</trigger>

<triggerTime>2022-01-08

10:03:00

-0500</triggerTime>

<condition>Success</condition>

<updatedBy>ops.admin</updatedBy>

    <sourceId>2</sourceId>

</forecast>

<agent

 <straightEdge>true</straightEdge>

<agentClusterVariable

 <targetId>3</targetId>

<agentVariable

/>

      </workflowEdge>

 <workflowEdge>

</businessServices>

    <condition type="Exit Code">123</condition>

<clusterBroadcast

/>

<clusterBroadcastVariable

/>

<created>2023-01-12

17:24:46 -0500</created>

 <sourceId>3</sourceId>

<createdBy>ops.admin</createdBy>

<endTime>2022-01-08

10:03:05

-0500</endTime>

    <straightEdge>true</straightEdge>

<endTimeAccuracy>Medium</endTimeAccuracy>

<launchTime>2022-01-08

10:03:00

-0500</launchTime>

<runSkipEvalution>Run<

<targetId>5</

runSkipEvalution>

targetId>

       </workflowEdge>

<task>Sleep

5</task>

<taskType>Timer</taskType>

    <workflowEdge>

<trigger>work-1

#TRIGGER#</trigger>

<triggerTime>2022-01-08

10:03:00

-0500</triggerTime>

<condition type="Step Condition">1:*:*:1</condition>

<updatedBy>ops.admin</updatedBy>

    <sourceId>4</sourceId>

</forecast>

<agent

/>

<straightEdge>true</straightEdge>

<agentCluster

/>

<agentClusterVariable

 <targetId>2</

>

targetId>

<agentVariable

/>

       </workflowEdge>

      </workflowEdges>

<avgRunTime>3</avgRunTime>
       <avgRunTimeDisplay>3

<

Seconds</

businessServices>

avgRunTimeDisplay>

<clusterBroadcast

<cpDuration />

<clusterBroadcastVariable /

<cpDurationUnit>Minutes</cpDurationUnit>

<customField1 label="Domain">web.com</customField1>
       <customField2 />

<createdBy>ops.admin</createdBy>

   <efDayConstraint>Nth</efDayConstraint>

  <efDuration>00:00:00:00</efDuration>

<endTimeAccuracy>Medium</endTimeAccuracy>

<efEnabled>false</efEnabled>

<efNthAmount>10</efNthAmount>
       <efOffsetDuration />
       <efOffsetDurationUnit>MInutes</efOffsetDurationUnit>
       <efOffsetPercentage>0</efOffsetPercentage>
       <efOffsetType>Percentage</efOffsetType>
       <efTime>00:00</efTime>

<efType>Time</efType>

<task>Sleep 10</task>

<executionRestriction>Run</executionRestriction>
       <firstRun>2021-03-15

<taskType>Timer</taskType>

13:59:37 -0400</firstRun>

<trigger>work-1 #TRIGGER#</trigger>

<holdResources>false</holdResources>

<lastRun>2021-03-16 17:12:42 -0400</lastRun>

<lastRunTime>9</lastRunTime>

<updatedBy>ops.admin</updatedBy>

<lastRunTimeDisplay>9 seconds</lastRunTimeDisplay>

<lfDayConstraint>Nth</lfDayConstraint>

<lfDuration>00:00:00:00</lfDuration>
       <lfEnabled>false</

forecast> </workflowForecast> Expand

title	JSON

Code Block

language	text

[

lfEnabled>

{

  <lfNthAmount>1</lfNthAmount>
       <lfOffsetDuration />

"agent": null,

<lfOffsetDurationUnit>MInutes</lfOffsetDurationUnit>
       <lfOffsetPercentage>0</lfOffsetPercentage>
       <lfOffsetType>Percentage</lfOffsetType>
       <lfTime>00:00</lfTime>

"agentCluster":

null,

 <lfType>Time</lfType>

"agentClusterVariable": null,

<lsDayConstraint>Nth</lsDayConstraint>

"agentVariable": null,

<lsDuration>00:00:00:00</lsDuration>
       <lsEnabled>false</lsEnabled>

"businessServices":

[],

     <lsNthAmount>7</lsNthAmount>

"clusterBroadcast":

null,

<lsTime>00:00</lsTime>

"clusterBroadcastVariable":

null,

    <lsType>Time</lsType>

"created": "2023-01-12 17:19:12 -0500",

  <maxRunTime>9</maxRunTime>
       <maxRunTimeDisplay>9 Seconds</maxRunTimeDisplay>

"createdBy":

"ops.admin",

   <minRunTime>3</minRunTime>

"endTime": "2022-01-08 10:04:32 -0500",

 <minRunTimeDisplay>3 Seconds</minRunTimeDisplay>
       <name>uc -

"endTimeAccuracy": "High",

Test Email</name>

"launchTime": "2022-01-08 10:03:00 -0500",

<opswiseGroups /> 
       <resolveNameImmediately>false</resolveNameImmediately>

"runSkipEvalution":

"Run",

    <resPriority>10</resPriority>

"sysId":

"bca33d227d8d4bcda7e8ede5abe62994",

  <restrictionPeriod>Span</restrictionPeriod>

"task": "work-1",

 <restrictionPeriodAfterDate>2017-11-10</restrictionPeriodAfterDate>

"taskType": "Workflow",

<restrictionPeriodAfterTime>10:30</restrictionPeriodAfterTime>

"trigger": "work-1 #TRIGGER#",

<restrictionPeriodBeforeDate>2017-11-20</restrictionPeriodBeforeDate>

"triggerTime": "2022-01-08 10:03:00 -0500",

<restrictionPeriodBeforeTime>15:00</restrictionPeriodBeforeTime>

"updated": "2023-01-12 17:19:12 -0500",

<restrictionPeriodDateList />

<runCount>32</runCount>

"updatedBy":

"ops.admin",

  <runTime>108</runTime>

"vertexId": null,

 <skippedOption>Show Skipped</skippedOption>

"workflow": null

<startHeld>false</startHeld>

},

  <startHeldReason />

{

      <summary />

"agent":

null,

     <sysId>c835007fc0a802650080dabfc04d4d67</sysId>

"agentCluster":

null,

   <timeZonePref>-- System Default --</timeZonePref>

"agentClusterVariable":

null,

    <twDelayAmount />

"agentVariable":

null,

<twDelayDuration>00:00:00:00</twDelayDuration>

"businessServices":

[],

   <twDelayType>None</twDelayType>

"clusterBroadcast":

null,

 <twWaitAmount />

"clusterBroadcastVariable": null,

 <twWaitDayConstraint>None</twWaitDayConstraint>

"created": "2023-01-12 17:19:12 -0500",

<twWaitDuration>00:00:00:00</twWaitDuration>

"createdBy": "ops.admin",

<twWaitTime>00:00</twWaitTime>

"endTime": "2022-01-08 10:03:41 -0500",

<twWaitType>None</twWaitType>
       <twWorkflowOnly>-- System Default --</twWorkflowOnly>

"endTimeAccuracy":

"Medium",

     <userEstimatedDuration />

"launchTime":

"2022-01-08

10:03:41

-0500",

  <calculateCp>false</calculateCp>

"runSkipEvalution": "Run",

 <calendar />

"sysId": "57232f7ecb3b4dae9ff1367442036a81",

<layoutOption>-- None --</layoutOption>

"task": "Sleep 0",

<numberOfTasks>10</numberOfTasks>
       <overrideCalendar>false</overrideCalendar>

"taskType":

"Timer",

    <skippedOption>Show Skipped</skippedOption>
</taskWorkflow>

Expand

title	JSON

{
  "

trigger

type": "

work-1 #TRIGGER#

taskWorkflow",
  "actions": {
     "

triggerTime

abortActions":

"2022-01-08 10:03:00 -0500",

[],

updated

emailNotifications":

"2023-01-12 17:19:12 -0500",

[],

updatedBy

setVariableActions":

"ops.admin"

[],

vertexId

snmpNotifications":

"3"

[],

workflow

systemOperations":

"work-1"

[]
  },
  "avgRunTime": 3,

{

"avgRunTimeDisplay": "3 Seconds",
  "calculateCp": false,
  "

agent

calendar": null,

agentCluster

cpDuration": null,

"cpDurationUnit": "Minutes",
  "

agentClusterVariable

criticalEndpoint": null

,


  "customField1": {
    "

agentVariable

label":

null

"Domain",


    "value": null

"businessServices": []

 },
  "customField2": {
    "

clusterBroadcast

label": null,

clusterBroadcastVariable

value": null

,

},
  "

created

efDayConstraint": "

2023-01-12 17:19:12 -0500",

Nth Day",

createdBy

efDuration": "

ops.admin

00:00:00:00",
  "efEnabled": false,

endTime

efNthAmount":

"2022-01-08

:03:41 -0500"

"endTimeAccuracy

  "efOffsetDuration": null,  
  "efOffsetDurationUnit": "

Medium

Minutes",
  "efOffsetPercentage": 0,

"launchTime

"efOffsetType": "Percentage",
  "efTime": "

2022-01-08 10:03:11 -0500

00:00",
  "efType": "Time",

runSkipEvalution

excludeRelated":

"Run"

false,

"exclusiveTasks": [],
  "

sysId

executionRestriction": "

f531aa964eb6495e8e7549e13d2f3ea1

Run",

task

exportReleaseLevel": "

Sleep 30

7.2.0.0",

"taskType

"exportTable": "

Timer

ops_task_manual",

trigger

firstRun": "

work-1 #TRIGGER#

2021-03-15 13:59:37 -0400",

"holdResources": false,

triggerTime

lastRun": "

2022

2021-

01

03-

08

10

17:

03

12:

00

42 -

0500

0400",

"lastRunTime": 9,

updated

lastRunTimeDisplay": "

2023-01-12 17:19:12 -0500

9 Seconds",
  "layoutOption": "-- None --",
  "

updatedBy

lfDayConstraint": "

ops.admin

Nth Day",

vertexId

lfDuration": "

2

00:00:00:00",

"lfEnabled": false,

workflow

lfNthAmount":

"work-

"

}, { "agent": null, "agentCluster": null, "agentClusterVariable": null, "agentVariable": null, "businessServices": [ "A", "B" ], "clusterBroadcast": null, "clusterBroadcastVariable": null, "created": "2023-01-12 17:19:12 -0500", "createdBy": "ops.admin", "endTime": "2022-01-08 10:03:05 -0500", "endTimeAccuracy": "Medium", "launchTime": "2022-01-08 10:03:00 -0500", "runSkipEvalution": "Run", "sysId": "2f9fee276640457ba1c743dfb683b9a6", "task": "Sleep 5", "taskType": "Timer", "trigger": "work-1 #TRIGGER#", "triggerTime": "2022-01-08 10:03:00 -0500", "updated": "2023-01-12 17:19:12 -0500", "updatedBy": "ops.admin", "vertexId": "5", "workflow": "work-1" }, { "agent": null, "agentCluster": null, "agentClusterVariable": null, "agentVariable": null, "businessServices": [ "C" ], "clusterBroadcast": null, "clusterBroadcastVariable": null, "created": "2023-01-12 17:19:12 -0500", "createdBy": "ops.admin",

"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,
       "

endTime

task":

"2022-01-08 10:03:15 -0500",

{
          "

endTimeAccuracy

value": "

Medium

SB_ZOS_Task"

,

"launchTime": "2022-01-08 10:03:05 -0500",

},
       "

runSkipEvalution

vertexId": "

Run

2",

sysId

vertexX": "

12ca3120496e48f5be1ff5a5a103b927

480",

task

vertexY": "

Sleep 10

90"

,

"taskType": "Timer",

},{
       "

trigger

alias": "

work-1

Timer

#TRIGGER#

0",

triggerTime

task":

"2022-01-08 10:03:00 -0500",

{
          "

updated

value": "Sleep

"2023-01-12 17:19:12 -0500"

0"
       },

updatedBy

vertexId": "

ops.admin

3",

vertexId

vertexX": "

6

480",

workflow

vertexY": "

work-1"

270"
       }]

]

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

...

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

Anchor

	Properties
	Properties

Versions Compared

Old Version 3

New Version Current

Key

Create a Workflow Task

List Workflow Forecast

List Workflow Forecast: URI Parameters

List Workflow Forecast: XML and JSON Examples

Modify a Workflow Task

Read a Workflow Task

List Workflow Forecast: XML and JSON Examples

Workflow Task: XML and JSON Examples

Properties

Page Comparison

Versions Compared

Old Version 3

New Version Current

Key

Create a Workflow Task

List Workflow Forecast

List Workflow Forecast: URI Parameters

List Workflow Forecast: XML and JSON Examples

Modify a Workflow Task

Read a Workflow Task

List Workflow Forecast: XML and JSON Examples

Workflow Task: XML and JSON Examples

Properties