/
Workflow Task Instance Web Services

Workflow Task Instance Web Services

Overview

Universal Controller supports the following RESTful-based web services for Workflow Task Instance operations, which are listed alphabetically on this page.

  • Insert a Task into a Workflow with Dependencies
  • List Predecessors / Successors of a Task Instance in a Workflow

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

Insert a Task into a Workflow with Dependencies


Description

URI

http://host_name/uc/resources/taskinstance/ops-task-insert

HTTP Method

POST

Description

Insert a task into a Workflow with dependencies.

Authentication

HTTP Basic

Example URI

http://localhost:8080/uc/resources/taskinstance/ops-task-insert

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Request Example

See Insert a Task into a Workflow with Dependencies: XML and JSON Examples.

Request Properties

See Insert a Task into a Workflow with Dependencies: Request Properties.

Response Example

See Insert a Task into a Workflow with Dependencies: XML and JSON Examples.

Insert a Task into a Workflow with Dependencies: XML and JSON Examples

Examples

XML

JSON

Example Request

 XML
<task-insert>
    <name>Sleep 30</name>
    <alias>Test</alias>
    <workflowInstanceId>ac2cfdd14c8c4238a4a6ecd03db41e87</workflowInstanceId>
    <predecessors> 
        <predecessor>Sleep 30</predecessor>
    </predecessors>
    <successors> 
        <successor>Sleep 60</successor>
    </successors>
    <vertexX>25</vertexX>
    <inheritTriggerTime>true</inheritTriggerTime>
    <vertexY>25</vertexY>
</task-insert>
 JSON
{
"name": "Sleep 10",
"alias": "Test",
"workflowInstanceId": "1513717759915306953T5FNZB71S6OUF",
"predecessors": [ "Task 1" ],
"successors": [ "Sleep 60" ],
"vertexX": "25",
"inheritTriggerTime": "true",
"vertexY": "25"
}

Example Response

 XML
<command-response>
    <type>create_task</type>
    <success>true</success>
    <info>Command Insert Task executed successfully against task instance "test workflow".</info>
    <errors />
</command-response>
 JSON
{
  "type": "create_task",
  "success": true,
  "info": "Command Insert Task executed successfully against task instance \"Test Workflow\".",
  "errors": ""
}

Insert a Task into a Workflow with Dependencies: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

alias

n/a

Alias used for the task within the Workflow; specifically, the value of ops_exec_workflow_vertex.name.


N


id

n/a

sys_id of the task to be inserted.


Y
(unless name
is specified)

name

name

Task Name

Name of the task to be inserted.


Y
(unless id
is specified)

id

predecessors

Predecessors

Comma-separated list of predecessor task instances within the workflow for the task to be inserted.


N


successors

Successors

Comma-separated list of successor task instances within the workflow for the task to be inserted.


N


vertexX

n/a

x-coordinate of the task to be inserted within the workflow.

Default is 0.

N


vertexY

n/a

y-coordinate of the task to be inserted within the workflow.

Default is 0.

N


inheritTriggerTime

n/a

Specification for whether or not the inserted task will inherit the Trigger Time of the Workflow task instance.

Boolean; Valid values (not case-sensitive):

  • Yes,Y,true
  • No, N, false

Default is Yes, Y, true.

N


workflowInstanceCriteria

n/a

If search is by workflowInstanceName; Specific Workflow task instance with this task instance name which you want to insert the task into.

Valid values:

  • As String = oldest active instance, As Value = 1
  • As String = newest active instance, As Value = 2
  • As String = oldest instance, As Value = 3
  • As String = newest instance, As Value = 4

Default is oldest active instance (1).