...
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: XML and JSON Examples, below. |
Properties | See Workflow Forecast Properties. |
List Workflow Forecast: URI Parameters
Property | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify the workflow. | String; URI parameter. | Y |
|
| Name used within the Controller to identify the workflow. | String; URI parameter. | Y |
|
| Unique ID for the Calendar. | N |
| |
| Name used within the Controller to identify the Calendar. | Maximum 100 alphanumeric. | N |
|
| Unique ID for this trigger. | N |
| |
| Name used within the Controller to identify this trigger. | Maximum 255 alphanumeric. | N |
|
| Date of the forecast | Date (yyyy-mm-dd) | N | |
| Time of the forecast | Time(HH:mm) | N | |
| timezone | N | ||
| forecast timezone | N | ||
| exclude the forecast types in the response | Valid values:
| N | |
| override the variables | List of name:value variables |
List Workflow Forecast: XML and JSON Examples
Examples | XML | JSON | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Response |
|
|
...