Versions Compared

Old Version 2

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 3

changes.mady.by.user Stonebranch

Saved on

Key

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

...

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



Expand
titleJSON
{
  "type": "taskWorkflow",
  "actions": {
     "abortActions": [],
     "emailNotifications": [],
     "setVariableActions": [],
     "snmpNotifications": [],
     "systemOperations": []
  },
  "avgRunTime": 3,
  "avgRunTimeDisplay": "3 Seconds",
  "calculateCp": false,
  "calendar": null,
  "cpDuration": null,
  "cpDurationUnit": "Minutes",
  "criticalEndpoint": null
  "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"
       }]
}


List Workflow Forecast


Description

URI

http://host_name/uc/resources/workflow/forecast

Authentication

HTTP Basic

HTTP Method

GET

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

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

XMLJSON
Response


Expand
titleXML


Code Block
languagetext
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<workflowForecast>
    <forecast>
        <agent />
        <agentCluster />
        <agentClusterVariable />
        <agentVariable />
        <businessServices/>
        <clusterBroadcast />
        <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>
        <runSkipEvalution>Run</runSkipEvalution>
        <sysId>3dd2ff81f3934898adba1396b44a7537</sysId>
        <task>work-1</task>
        <taskType>Workflow</taskType>
        <trigger>work-1 #TRIGGER#</trigger>
        <triggerTime>2022-01-08 10:03:00 -0500</triggerTime>
        <updated>2023-01-12 17:24:45 -0500</updated>
        <updatedBy>ops.admin</updatedBy>
        <vertexId />
        <workflow />
    </forecast>
    <forecast>
        <agent />
        <agentCluster />
        <agentClusterVariable />
        <agentVariable />
        <businessServices/>
        <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>
        <runSkipEvalution>Run</runSkipEvalution>
        <sysId>088f8283fcdf42d7858bc991d42e8e66</sysId>
        <task>Sleep 0</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>3</vertexId>
        <workflow>work-1</workflow>
    </forecast>
    <forecast>
        <agent />
        <agentCluster />
        <agentClusterVariable />
        <agentVariable />
        <businessServices/>
        <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</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>
        <workflow>work-1</workflow>
    </forecast>
    <forecast>
        <agent />
        <agentCluster />
        <agentClusterVariable />
        <agentVariable />
        <businessServices>
            <businessService>A</businessService>
            <businessService>B</businessService>
        </businessServices>
        <clusterBroadcast />
        <clusterBroadcastVariable />
        <created>2023-01-12 17:24:46 -0500</created>
        <createdBy>ops.admin</createdBy>
        <endTime>2022-01-08 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 17:24:46 -0500</updated>
        <updatedBy>ops.admin</updatedBy>
        <vertexId>5</vertexId>
        <workflow>work-1</workflow>
    </forecast>
    <forecast>
        <agent />
        <agentCluster />
        <agentClusterVariable />
        <agentVariable />
        <businessServices>
            <businessService>C</businessService>
        </businessServices>
        <clusterBroadcast />
        <clusterBroadcastVariable />
        <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</vertexId>
        <workflow>work-1</workflow>
    </forecast>
</workflowForecast>




Expand
titleJSON


Code Block
languagetext
[
    {
        "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",
        "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"
    }
]



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.

...