Versions Compared

Old Version 3

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 4

changes.mady.by.user Stonebranch

Saved on

Key

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

...

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:

...


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/a
workflow/forecast

Authentication

HTTP Basic

HTTP Method

PUT

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

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

...

Get Forecast Details

Example URI

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

http://localhost:8080/uc/resources/workflow/

task?taskname=test

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

...

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

AnchorExample for TaskExample for TaskExample for Task Expand
titleXML
<taskWorkflow exportReleaseLevel="7.2.0.0" exportTable="ops_task_workflow" retainSysIds="true" version="1"> <actions />

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

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

ExampleSee List Workflow Forecast: XML and JSON Examples, below. 
PropertiesSee List Workflow Forecast Properties. 

List Workflow Forecast: XML and JSON Examples

Examples

XMLJSON
Response


Expand
titleXML


Code Block
languagetext
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<workflowForecast>
    <forecast>
<variables
<agent />
<notes
<agentCluster />
<virtualResources
<agentClusterVariable />
<exclusiveTasks
 <agentVariable />
<stepConditions
 <businessServices/>
<stepActions
 <clusterBroadcast />
<runCriteria
<clusterBroadcastVariable />
<criticalEndpoint
/>
 <created>2023-01-12 17:24:45 -0500</created>
<workflowVertices>
 
   <createdBy>ops.admin</createdBy>
<workflowVertex>
    <endTime>2022-01-08 10:04:32 -0500</endTime>
        <endTimeAccuracy>High</endTimeAccuracy>
<alias />
<launchTime>2022-01-08 10:03:00 -0500</launchTime>
        <runSkipEvalution>Run</runSkipEvalution>
        <sysId>3dd2ff81f3934898adba1396b44a7537</sysId>
<task>Sleep 30</task>
 <task>work-1</task>
        <taskType>Workflow</taskType>
        
<trigger>work-1 #TRIGGER#</trigger>
<vertexId>2</vertexId>
    <triggerTime>2022-01-08 10:03:00 -0500</triggerTime>
        <updated>2023-01-12 17:24:45 -0500</updated>
<vertexX>360</vertexX>
<updatedBy>ops.admin</updatedBy>
        <vertexId />
        <workflow />
    <
vertexY>60<
/
vertexY>
forecast>
    <forecast>
        <agent
<
/
workflowVertex>
>
        <agentCluster />
<workflowVertex>
  <agentClusterVariable />
        <agentVariable />
<alias 
<businessServices/>
        <clusterBroadcast />
<task>Sleep 60</task>
<clusterBroadcastVariable />
        <created>2023-01-12 17:24:46 -0500</created>
<vertexId>3</vertexId>
<createdBy>ops.admin</createdBy>
        <endTime>2022-01-08 10:03:41 -0500</endTime>
        <endTimeAccuracy>Medium</endTimeAccuracy>
<vertexX>360</vertexX>
    <launchTime>2022-01-08 10:03:41 -0500</launchTime>
        <runSkipEvalution>Run</runSkipEvalution>
<vertexY>170<
<sysId>088f8283fcdf42d7858bc991d42e8e66</
vertexY>
sysId>
        <task>Sleep 0</task>
</workflowVertex>
  <taskType>Timer</taskType>
        <trigger>work-1 #TRIGGER#</trigger>
<workflowVertex>
    <triggerTime>2022-01-08 10:03:00 -0500</triggerTime>
        <updated>2023-01-12 17:24:46 -0500</updated>
<alias
 <updatedBy>ops.admin</
>
updatedBy>
        <vertexId>3</vertexId>
        <workflow>work-1</workflow>
<task>zos task</task>
</forecast>
    <forecast>
        <agent />
        <agentCluster
<vertexId>4<
/
vertexId>
>
        <agentClusterVariable />
        <agentVariable />
<vertexX>560</vertexX>
    <businessServices/>
        <clusterBroadcast />
        
<clusterBroadcastVariable
<vertexY>50<
/
vertexY>
>
        <created>2023-01-12 17:24:46 -0500</created>
</workflowVertex>
   <createdBy>ops.admin</createdBy>
<workflowVertex>
<endTime>2022-01-08 10:03:41 -0500</endTime>
        <endTimeAccuracy>Medium</endTimeAccuracy>
        <launchTime>2022-01-08 10:03:11 -0500</launchTime>
<alias
   <runSkipEvalution>Run</
>
runSkipEvalution>
        <sysId>a7fa4a5b35854af297eb2f9197e63f97</sysId>
        <task>Sleep 30</task>
<task>uc
-
Windows
Sleep<
<taskType>Timer</
task>
taskType>
        <trigger>work-1 #TRIGGER#</trigger>
        <triggerTime>2022-01-08 10:03:00 -0500</triggerTime>
<vertexId>5</vertexId>
     <updated>2023-01-12 17:24:46 -0500</updated>
        <updatedBy>ops.admin</updatedBy>
<vertexX>390<
<vertexId>2</
vertexX>
vertexId>
        <workflow>work-1</workflow>
    </forecast>
    <forecast>
<vertexY>310</vertexY>
   <agent />
        <agentCluster />
</workflowVertex>
      <agentClusterVariable
<
/
workflowVertices
>
<workflowEdges>
 <agentVariable />
        <businessServices>
<workflowEdge>
       <businessService>A</businessService>
            <businessService>B</businessService>
<condition>Success</condition>
    </businessServices>
        <clusterBroadcast />
        
<clusterBroadcastVariable
<sourceId>2<
/
sourceId
>
        <created>2023-01-12 17:24:46 -0500</created>
        <createdBy>ops.admin</createdBy>
<straightEdge>true</straightEdge>
    <endTime>2022-01-08 10:03:05 -0500</endTime>
        <endTimeAccuracy>Medium</endTimeAccuracy>
<targetId>3</targetId>
<launchTime>2022-01-08 10:03:00 -0500</launchTime>
        <runSkipEvalution>Run</runSkipEvalution>
<
 <sysId>efea93a7ed804280b6fbee22a29a004c</
workflowEdge>
sysId>
        <task>Sleep 5</task>
<workflowEdge>
  <taskType>Timer</taskType>
        <trigger>work-1 #TRIGGER#</trigger>
        <triggerTime>2022-01-08 10:03:00 -0500</triggerTime>
<condition
type="Exit
Code">123</condition>
     <updated>2023-01-12 17:24:46 -0500</updated>
        <updatedBy>ops.admin</updatedBy>
<sourceId>3<
<vertexId>5</
sourceId>
vertexId>
        <workflow>work-1</workflow>
    </forecast>
    <forecast>
<straightEdge>true</straightEdge>
   <agent />
        <agentCluster />
        
<agentClusterVariable
<targetId>5<
/
targetId>
>
        <agentVariable />
</workflowEdge>
  <businessServices>
            <businessService>C</businessService>
<workflowEdge>
       </businessServices>
        <clusterBroadcast />
<condition
type="Step Condition">1:*:*:1</condition>
<clusterBroadcastVariable />
        <created>2023-01-12 17:24:46 -0500</created>
        <createdBy>ops.admin</createdBy>
<sourceId>4</sourceId>
   <endTime>2022-01-08 10:03:15 -0500</endTime>
        <endTimeAccuracy>Medium</endTimeAccuracy>
        <launchTime>2022-01-08
<straightEdge>true</straightEdge>
10:03:05 -0500</launchTime>
        <runSkipEvalution>Run</runSkipEvalution>
        <sysId>c0901a00837b46da99606d45998ba780</sysId>
<targetId>2</targetId>
  <task>Sleep 10</task>
        <taskType>Timer</taskType>
</workflowEdge>
</workflowEdges>
<trigger>work-1 #TRIGGER#</trigger>
<avgRunTime>3</avgRunTime>
  <triggerTime>2022-01-08 
10:03:00 -0500</triggerTime>
<avgRunTimeDisplay>3
Seconds</avgRunTimeDisplay>
      <updated>2023-01-12
<cpDuration />
17:24:46 -0500</updated>
<cpDurationUnit>Minutes</cpDurationUnit>
<updatedBy>ops.admin</updatedBy>
<customField1 label="Domain">web.com</customField1>
 <vertexId>6</vertexId>
<customField2 />
<workflow>work-1</workflow>
    </forecast>

<
efDayConstraint>Nth</efDayConstraint>
/workflowForecast>




Expand
titleJSON


Code Block
languagetext
[
    {
<efDuration>00:00:00:00</efDuration>
      "agent":
<efEnabled>false</efEnabled>
null,
<efNthAmount>10</efNthAmount>       <efOffsetDuration />
       <efOffsetDurationUnit>MInutes</efOffsetDurationUnit>
       <efOffsetPercentage>0</efOffsetPercentage>
       <efOffsetType>Percentage</efOffsetType>
       <efTime>00:00</efTime> 
"agentCluster": null,
        "agentClusterVariable": null,
<efType>Time</efType>
  
"agentVariable": null,
<executionRestriction>Run</executionRestriction>
     "businessServices":
<firstRun>2021-03-15 13:59:37 -0400</firstRun>
[],
        "clusterBroadcast":
<holdResources>false</holdResources>
null,
<lastRun>2021-03-16 17:12:42 -0400</lastRun>
 "clusterBroadcastVariable": null,
<lastRunTime>9</lastRunTime>
<lastRunTimeDisplay>9 seconds</lastRunTimeDisplay>
 "created": "2023-01-12 17:19:12 -0500",
        "createdBy": "ops.admin",
<lfDayConstraint>Nth</lfDayConstraint>
      "endTime":
<lfDuration>00:00:00:00</lfDuration> 
"2022-01-08 10:04:32 -0500",
<lfEnabled>false</lfEnabled>
  "endTimeAccuracy": "High",
<lfNthAmount>1</lfNthAmount>
  
    <lfOffsetDuration />
       <lfOffsetDurationUnit>MInutes</lfOffsetDurationUnit>
       <lfOffsetPercentage>0</lfOffsetPercentage>
       <lfOffsetType>Percentage</lfOffsetType>
       <lfTime>00:00</lfTime> <lfType>Time</lfType>
  "launchTime": "2022-01-08 10:03:00 -0500",
        "runSkipEvalution": "Run",
        "sysId":
<lsDayConstraint>Nth</lsDayConstraint>
"bca33d227d8d4bcda7e8ede5abe62994",
<lsDuration>00:00:00:00</lsDuration>
"task": "work-1",
<lsEnabled>false</lsEnabled> 
 "taskType": "Workflow",
<lsNthAmount>7</lsNthAmount>
   "trigger": "work-1 #TRIGGER#",
<lsTime>00:00</lsTime>
<lsType>Time</lsType>
"triggerTime": "2022-01-08 10:03:00 -0500",
<maxRunTime>9</maxRunTime>
    "updated": "2023-01-12
<maxRunTimeDisplay>9 Seconds</maxRunTimeDisplay>
17:19:12 -0500",
<minRunTime>3</minRunTime>
 "updatedBy": "ops.admin",
<minRunTimeDisplay>3
Seconds</minRunTimeDisplay>
   "vertexId": null,
<name>uc
-
Test
Email</name>
  "workflow": null
<opswiseGroups
},
/>
    {
<resolveNameImmediately>false</resolveNameImmediately>
    "agent": null,
<resPriority>10</resPriority>
      "agentCluster":
<restrictionPeriod>Span</restrictionPeriod>
null,
<restrictionPeriodAfterDate>2017-11-10</restrictionPeriodAfterDate> 
"agentClusterVariable": null,
<restrictionPeriodAfterTime>10:30</restrictionPeriodAfterTime>
  "agentVariable": null,
<restrictionPeriodBeforeDate>2017-11-20</restrictionPeriodBeforeDate>
    "businessServices": [],
<restrictionPeriodBeforeTime>15:00</restrictionPeriodBeforeTime>
      "clusterBroadcast": null,
<restrictionPeriodDateList
/>
<runCount>32</runCount>
"clusterBroadcastVariable": null,
<runTime>108</runTime>
   "created": "2023-01-12 17:19:12 -0500",
<skippedOption>Show
Skipped</skippedOption>
      "createdBy":
<startHeld>false</startHeld>
"ops.admin",
<startHeldReason /> 
"endTime": "2022-01-08 10:03:41 -0500",
<summary
/>
  "endTimeAccuracy": "Medium",
<sysId>c835007fc0a802650080dabfc04d4d67</sysId>
<timeZonePref>-- System Default --</timeZonePref>
"launchTime": "2022-01-08 10:03:41 -0500",
<twDelayAmount /> 
 "runSkipEvalution": "Run",
<twDelayDuration>00:00:00:00</twDelayDuration>
  "sysId": "57232f7ecb3b4dae9ff1367442036a81",
<twDelayType>None</twDelayType>
    "task": "Sleep 0",
<twWaitAmount
/>
      "taskType":
<twWaitDayConstraint>None</twWaitDayConstraint>
"Timer",
<twWaitDuration>00:00:00:00</twWaitDuration> 
"trigger": "work-1 #TRIGGER#",
<twWaitTime>00:00</twWaitTime>
   "triggerTime": "2022-01-08 10:03:00 -0500",
<twWaitType>None</twWaitType>
<twWorkflowOnly>-- System Default --</twWorkflowOnly>
"updated": "2023-01-12 17:19:12 -0500",
<userEstimatedDuration />
"updatedBy": "ops.admin",
<calculateCp>false</calculateCp> 
 "vertexId": "3",
<calendar
/>
  "workflow": "work-1"
<layoutOption>-- None --</layoutOption>
},
    {
<numberOfTasks>10</numberOfTasks> 
 "agent": null,
<overrideCalendar>false</overrideCalendar>
   "agentCluster": null,
<skippedOption>Show
Skipped</skippedOption>
</taskWorkflow> Expand
titleJSON
{
   "
type
agentClusterVariable":
"taskWorkflow"
null,
"actions":
{
     
"
abortActions
agentVariable":
[]
null,
        "
emailNotifications
businessServices": [],
        "
setVariableActions
clusterBroadcast":
[]
null,
        "
snmpNotifications
clusterBroadcastVariable":
[]
null,
        "
systemOperations
created":
[] },
"avgRunTime": 3,
"avgRunTimeDisplay": "3 Seconds",
"2023-01-12 17:19:12 -0500",
        "
calculateCp
createdBy":
false, "calendar": null,
"ops.admin",
"cpDuration":
null,
   "
cpDurationUnit
endTime": "
Minutes",
"criticalEndpoint": null
2022-01-08 10:03:41 -0500",
"customField1":
{
     "
label
endTimeAccuracy": "
Domain
Medium",
"value":
null
},
   "
customField2
launchTime":
{ 
"2022-01-08 10:03:11 -0500",
"label":
null,
     "
value
runSkipEvalution":
null
 "Run",
},
   "
efDayConstraint
sysId": "
Nth Day
f531aa964eb6495e8e7549e13d2f3ea1",
        "
efDuration
task": "
00:00:00:00
Sleep 30",
"efEnabled
      "taskType":
false
"Timer",
"efNthAmount":
10,
 
"efOffsetDuration":
null, 

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

  "efOffsetPercentage": 0,
  "efOffsetType

        "triggerTime": "
Percentage",
  "efTime": "00:00",
2022-01-08 10:03:00 -0500",
        "
efType
updated": "
Time
2023-01-12 17:19:12 -0500",
"excludeRelated
      "updatedBy":
false
"ops.admin",
"exclusiveTasks": [],
      "
executionRestriction
vertexId": "
Run
2",


        "
exportReleaseLevel
workflow": "
7.2.0.0",
"exportTable": "ops_task_manual",
"firstRun": "2021-03-15 13:59:37 -0400",
work-1"
    },
    {
        "
holdResources
agent":
false
null,
"lastRun":
"2021-03-16
17:12:42
-0400",
  "
lastRunTime
agentCluster":
9
null,
"lastRunTimeDisplay":
"9
Seconds",
   "
layoutOption
agentClusterVariable":
"--
null,
None
--",
"lfDayConstraint":
"Nth Day",
   "
lfDuration
agentVariable":
"00:00:00:00", 
null,
"lfEnabled":
false,
"lfNthAmount":
1,
 
 "
lfOffsetDuration
businessServices":
null, 
[

 
"lfOffsetDurationUnit":
"Minutes",
 
"lfOffsetPercentage":
0,
 
"lfOffsetType":
"Percentage",
 
"lfTime":
"00:00",
"lfType":
 "
Time
A",
"lsDayConstraint": "Nth Day",
          "
lsDuration
B"
:
"00:00:00:00",
"lsEnabled":
false,
"lsNthAmount":
7
],
"lsTime":
"00:00",
   "
lsType
clusterBroadcast":
"Time"
null,
"maxRunTime":
9,
"maxRunTimeDisplay":
"9
Seconds",
  "
minRunTime
clusterBroadcastVariable":
3
null,
"minRunTimeDisplay":
"3
Seconds",
   "
name
created": "
test
2023-
wkfl-web-service",
01-12 17:19:12 -0500",
"notes":
[],
   "
numberOfTasks
createdBy":
2,
"ops.admin",
"opswiseGroups":
[],
   "
overrideCalendar
endTime":
false, "resolveNameImmediately": false, "resPriority": 10,
"2022-01-08 10:03:05 -0500",
        "
restrictionPeriod
endTimeAccuracy": "
Span
Medium",
        "
restrictionPeriodAfterDate
launchTime": "
2017
2022-
11
01-08 10:03:00 -0500",
"restrictionPeriodAfterTime": "10:30",
    
"
restrictionPeriodBeforeDate
runSkipEvalution": "
2017-11-20
Run",
        "
restrictionPeriodBeforeTime
sysId": "
15:00
2f9fee276640457ba1c743dfb683b9a6",
"restrictionPeriodDateList":
[],
   "
retainSysIds
task":
true,
"runCount": 32,
"runCriteria": [],
"runTime": 108,
"Sleep 5",
        "
skippedOption
taskType": "
Show Skipped
Timer",
"startHeld": false,
     "
startHeldReason
trigger":
null
 "work-1 #TRIGGER#",
"stepActions":
[],
   "
stepConditions
triggerTime":
[], "summary": null, "sysId": "fb59a227517a421a92c15ff5aefe3b66",
"2022-01-08 10:03:00 -0500",
        "
timeZonePref
updated": "2023-01-
System Default
12 17:19:12 -
-
0500",
"twDelayAmount":
null,
   "
twDelayDuration
updatedBy": "
00:00:00:00
ops.admin",
        "
twDelayType
vertexId": "
None
5",
"twWaitAmount": null,
     "
twWaitDayConstraint
workflow": "
None
work-1"
,
"twWaitDuration": "00:00:00:00", "twWaitTime": "00:00",
 },
    {
        "
twWaitType
agent":
"None"
null,
"twWorkflowOnly":
"--
System
Default
--",
   "
userEstimatedDuration
agentCluster": null,
        "
variables
agentClusterVariable":
[]
null,
"version":
2,
"virtualResources":
[],
 "
workflowEdges
agentVariable":
[ {
null,
"condition":
{
     "
value
businessServices":
"Success"
[
},
"sourceId":
{
      "
taskName": "SB_ZOS_Task ",
C"
        ],
"value":
"2"
},
   "
straightEdge
clusterBroadcast":
true
null,
"targetId":
{
     "
taskAlias
clusterBroadcastVariable":
"Timer 0", 
null,
"taskName":
"Sleep
0",
     "
value
created": "
3"
2023-01-12 17:19:12 -0500",
} }
],
     "
workflowVertices
createdBy":
[ {
"ops.admin",
        "
alias
endTime":
null, 
"2022-01-08 10:03:15 -0500",
        "
task
endTimeAccuracy":
{
"Medium",
        
"
value
launchTime": "
SB_ZOS_Task" 
2022-01-08 10:03:05 -0500",
},
      
"
vertexId
runSkipEvalution": "
2
Run",
        "
vertexX
sysId": "
480
12ca3120496e48f5be1ff5a5a103b927",
        "
vertexY
task": "
90
Sleep 10",
},{ 
 
"
alias
taskType": "Timer
0
",
        "
task
trigger":
{ 
"work-1 #TRIGGER#",
        
"
value
triggerTime": "
Sleep 0"
2022-01-08 10:03:00 -0500",
}
"updated": "2023-01-12 17:19:12 -0500",
        "
vertexId
updatedBy": "
3
ops.admin",
        "
vertexX
vertexId": "
480
6",
        "
vertexY
workflow": "
270
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

GETExample

PUT

Description

Get Forecast Details

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://
localhost:8080
host_name/uc/resources/
workflow/forecast?workflowname=work_4
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&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

List Workflow Forecast: XML and JSON Examples

Examples

XMLJSONResponse Expand
titleXML
Code Block
languagetext
<?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

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
titleXML
<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>
<created>2023-01-12 17:24:45 -0500</created>
<createdBy>ops.admin</createdBy>
       <vertexY>60</vertexY>
<endTime>2022-01-08
10:04:32
-0500</endTime>
<endTimeAccuracy>High</endTimeAccuracy>
    </workflowVertex>
<launchTime>2022-01-08
10:03:00
-0500</launchTime>
<runSkipEvalution>Run</runSkipEvalution>
 <workflowVertex>
<sysId>3dd2ff81f3934898adba1396b44a7537</sysId>
<task>work-1</task>
        <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>
<forecast>
     <vertexX>360</vertexX>
<agent
/>
<agentCluster
/>
<agentClusterVariable
 <vertexY>170</
>
vertexY>
<agentVariable
/>
       </workflowVertex>
<businessServices/>
<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>
<runSkipEvalution>Run</runSkipEvalution>
<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>
<updated>2023-01-12 17:24:46 -0500</updated>
<vertexY>50</vertexY>
<updatedBy>ops.admin</updatedBy>
     </workflowVertex>
<vertexId>3</vertexId>
<workflow>work-1</workflow>
    <workflowVertex>
</forecast>
<forecast>
<agent
/>
<agentCluster
<alias />
<agentClusterVariable
/>
       <task>uc -
<agentVariable
Windows Sleep</
>
task>
<businessServices/>
<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>
<sysId>a7fa4a5b35854af297eb2f9197e63f97</sysId>
</workflowVertices>
       <workflowEdges>
<task>Sleep
30</task>
<taskType>Timer</taskType>
    <workflowEdge>
<trigger>work-1
#TRIGGER#</trigger>
<triggerTime>2022-01-08
10:03:00
-0500</triggerTime>
<updated>2023-01-12 17:24:46 -0500</updated>
<condition>Success</condition>
<updatedBy>ops.admin</updatedBy>
<vertexId>2</vertexId>
    <sourceId>2</sourceId>
<workflow>work-1</workflow>
</forecast>
<forecast>
<agent
 <straightEdge>true</straightEdge>
<agentCluster />
<agentClusterVariable
 <targetId>3</targetId>
<agentVariable
/>
      </workflowEdge>
<businessServices>
<businessService>A</businessService>
 <workflowEdge>
<businessService>B</businessService>
</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>
<sysId>efea93a7ed804280b6fbee22a29a004c</sysId>
       </workflowEdge>
<task>Sleep
5</task>
<taskType>Timer</taskType>
    <workflowEdge>
<trigger>work-1
#TRIGGER#</trigger>
<triggerTime>2022-01-08
10:03:00
-0500</triggerTime>
<updated>2023-01-12 17:24:46 -0500</updated>
<condition type="Step Condition">1:*:*:1</condition>
<updatedBy>ops.admin</updatedBy>
<vertexId>5</vertexId>
    <sourceId>4</sourceId>
<workflow>work-1</workflow>
</forecast>
<forecast>
<agent
/>
<straightEdge>true</straightEdge>
<agentCluster
/>
<agentClusterVariable
 <targetId>2</
>
targetId>
<agentVariable
/>
       </workflowEdge>
<businessServices>
      </workflowEdges>
<businessService>C</businessService>
<avgRunTime>3</avgRunTime>
       <avgRunTimeDisplay>3
<
Seconds</
businessServices>
avgRunTimeDisplay>
<clusterBroadcast
<cpDuration />
<clusterBroadcastVariable /
<cpDurationUnit>Minutes</cpDurationUnit>
<created>2023-01-12 17:24:46 -0500</created> 
<customField1 label="Domain">web.com</customField1>
       <customField2 />
<createdBy>ops.admin</createdBy>
   <efDayConstraint>Nth</efDayConstraint>
<endTime>2022-01-08 10:03:15 -0500</endTime>
  <efDuration>00:00:00:00</efDuration>
<endTimeAccuracy>Medium</endTimeAccuracy>
<efEnabled>false</efEnabled>
<launchTime>2022-01-08 10:03:05 -0500</launchTime> <runSkipEvalution>Run</runSkipEvalution>
<efNthAmount>10</efNthAmount>
       <efOffsetDuration />
       <efOffsetDurationUnit>MInutes</efOffsetDurationUnit>
       <efOffsetPercentage>0</efOffsetPercentage>
       <efOffsetType>Percentage</efOffsetType>
       <efTime>00:00</efTime>
<sysId>c0901a00837b46da99606d45998ba780</sysId>
<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>
<triggerTime>2022-01-08 10:03:00 -0500</triggerTime>
<lastRun>2021-03-16 17:12:42 -0400</lastRun>
<updated>2023-01-12 17:24:46 -0500</updated>
<lastRunTime>9</lastRunTime>
<updatedBy>ops.admin</updatedBy>
<lastRunTimeDisplay>9 seconds</lastRunTimeDisplay>
<vertexId>6</vertexId>
<lfDayConstraint>Nth</lfDayConstraint>
<workflow>work-1</workflow>
<lfDuration>00:00:00:00</lfDuration>
       <lfEnabled>false</
forecast> </workflowForecast> Expand
titleJSON
Code Block
languagetext
[
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
titleJSON
{
  "
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
 10
: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
16
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-
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", 
"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.

...