Page Comparison

...

	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
Example	See List Workflow Forecast: Example ResponseXML and JSON Examples, below.
Properties	See List Workflow Forecast: URI Parameters, below.

...

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

Examples

XML

JSON

Response

Expand

title	XML

Code Block

language	text

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

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

...

Versions Compared

Old Version 9

New Version 10

Key

List Workflow Forecast:

XML and JSON Examples