Workflow Task Web Services

Workflow Task Web Services

Overview

 

Universal Controller supports the following RESTful-based web services for Workflow Task operations.

  • Create a Workflow Task

  • List Workflow Forecast

  • Modify a Workflow Task

  • Read a Workflow Task

Formatting specifications for each web service, including details about parameter requirements, are provided.

Links to detailed information about the properties used in these web services also is located on this page.
 

For informaion on Workflow Task web services that are applicable to all task types, see:

For a list of Workflow Vertex and Edge web services, see:

Create a Workflow Task

 

Description

 

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

 

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.