Manual Task Instance Web Services

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

• Issue Set Completed Command for a Manual Task Instance
• Issue Set Started Command for a Manual Task Instance

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

Issue Set Completed Command for a Manual Task Instance

	Description
URI	http://host_name/uc/resources/taskinstance/setcompleted
HTTP Method	POST
Description	Issues a Set Completed command for a Manual Task instance.
Example URI	http://localhost:8080/uc/resources/taskinstance/setcompleted
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See Issue Set Completed Command for a Manual Task Instance: XML and JSON Examples.
Request Properties	See Issue Set Completed Command for a Manual Task Instance: Request Properties.
Example Response	See Issue Set Completed Command for a Manual Task Instance: XML and JSON Examples.

Issue Set Completed Command for a Manual Task Instance: XML and JSON Examples

JSON

Example Request

JSON

JSON

{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "Test"
}

Example Response

JSON

JSON

{
  "type": "set_manual_completed",
  "success": true,
  "info": "Command Set Completed executed successfully against task instance \"Task 1\".",
  "errors": ""
}

XML

Example Request

XML

XML

<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
</task-instance>

or

XML

<task-instance>
      <name>test manual</name>
      <criteria>Newest Instance</criteria>
      <workflowInstanceName>test</workflowInstanceName> 
</task-instance>

Example Response

XML

XML

<command-response>
    <type>set_manual_completed</type>
    <success>true</success>
    <info>Command Set Completed executed successfully against task instance "test".</info>
    <errors />
</command-response>

Issue Set Completed Command for a Manual Task Instance: Request Properties

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive With
criteria	n/a	Specific task instance with this task instance name that you want to issue a Set Completed command for.	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). info Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).	N
id	n/a	sys_id used within the Controller to identify this task instance.		Y (unless name is specified)	name
name	Instance Name	Name of the task instance.		Y (unless id is specified)	id
operationalMemo	Operational Memo	User-defined operational memo.		N
workflowInstanceName	Workflow	Name of the parent Workflow of the task instance.	You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.	N

Issue Set Started Command for a Manual Task Instance

	Description
URI	http://host_name/uc/resources/taskinstance/setstarted
HTTP Method	POST
Description	Issues a Set Started command for a Manual Task instance.
Example URI	http://localhost:8080/uc/resources/taskinstance/setstarted
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See Issue Set Started Command for a Manual Task Instance: XML and JSON Examples.
Request Properties	See Issue Set Started Command for a Manual Task Instance: Request Properties
Example Response	See Issue Set Started Command for a Manual Task Instance: XML and JSON Examples.

Issue Set Started Command for a Manual Task Instance: XML and JSON Examples

JSON

Example Request

JSON

JSON

{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "Test"
}

Example Response

JSON

JSON

{
  "type": "set_manual_started",
  "success": true,
  "info": "Command Set Started executed successfully against task instance \"Task 1\".",
  "errors": ""
}

XML

Example Request

XML

XML

<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
</task-instance>

or

XML

<task-instance>
      <name>test manual</name>
      <criteria>Newest Instance</criteria>
      <workflowInstanceName>test</workflowInstanceName> 
</task-instance>

Example Response

XML

XML

<command-response>
    <type>set_manual_started</type>
    <success>true</success>
    <info>Command Set Started executed successfully against task instance "test".</info>
    <errors />
</command-response>

Issue Set Started Command for a Manual Task Instance: Request Properties

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive With
criteria	n/a	Specific task instance with this task instance name that you want to issue a Set Started command for.	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). info Values with an underscore characters ( _ ) instead of spaces also are supported (for example, oldest_active_instance).	N
id	n/a	sys_id used within the Controller to identify this task instance.		Y (unless name is specified)	name
name	Instance Name	Name of the task instance.		Y (unless id is specified)	id
operationalMemo	Operational Memo	User-defined operational memo.		N
workflowInstanceName	Workflow	Name of the parent Workflow of the task instance.	You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.	N