...
Links to detailed information about the properties used in these web services also is located on this page.
...
Anchor | ||||
---|---|---|---|---|
|
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 |
|
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 |
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 |
---|---|---|---|---|
| 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 |
|
|
Anchor | ||||
---|---|---|---|---|
|
Modify a Workflow Task
Description | |
---|---|
URI | http://host_name/uc/resources/task |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
HTTP Method | PUT |
Description | Modifies the task specified by the sysId in the request. |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
Read a Workflow Task
Description | |
---|---|
URI | http://host_name/uc/resources/task |
HTTP Method | GET |
Description | Retrieves information on the specified task. |
Request Parameters |
|
Mutually Exclusive Parameters |
|
Example URI | |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
Workflow Task: XML and JSON Examples
The retainSysIds
and version
properties are specified as attributes in XML.
...
Examples | XML | JSON | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
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 | ||||
---|---|---|---|---|
|