IBM Business Process Manager, Version 8.5.7
PUT /rest/bpm/wle/v1/task/{taskId}?action={string}[&parts={string}][&toMe={boolean}][&back={boolean}][&toUser={string}][&toGroup={string}][&parts={string}]POST /rest/bpm/wle/v1/task/{taskId}?action={string}[&parts={string}][&toMe={boolean}][&back={boolean}][&toUser={string}][&toGroup={string}][&parts={string}]
| Name | Value Type | Description | ||||
|---|---|---|---|---|---|---|
| action | string | Action to be performed for the specified task instance.
|
| Name | Value Type | Description |
|---|---|---|
| parts | string | A string indicating which parts of the response data should be returned.
You can use the following values:
data part refers to the external task information. |
| toMe | boolean | If this parameter is set to
true, the task is assigned to the current user. |
| back | boolean | If this parameter is set to
true, the task is assigned back to the original owner. |
| toUser | string | The name of the user to whom the task should be assigned. Note that assigning
the task by using the
toUser parameter is specifically targeted to assigning the task to another user,
not to the calling user itself. This operation is subject to authorization control that is distinct
from the one applied to the "assign toMe" operation. |
| toGroup | string | The name of the group to which the task should be assigned.
|
| parts | string | A string indicating which parts of the response data should be returned.
You can use the following values:
data part refers to the external task information. |
None
The default content type is application/json.
{ "description": "WLE Task",
"type": "object",
"properties":
{ "activationTime": {"type": "string", "format": "date-time",
"description": "Time the task instance is set into the ready state - this also happens when the task is restarted or when a claim is canceled."
},
"assignedTo": {"type": "string",
"description": "The task owner."
},
"assignedToDisplayName": {"type": "string",
"description": "The name of the assigned user or role suitable for displaying in a user interface."
},
"assignedToType": {"type": "string",
"description": "'group' or 'user'"
},
"clientTypes": {"type": ["string"],
"description": "A user-defined client type to specify UI client information, fixed value IBM_WLE_COACH."
},
"completionTime": {"type": "string", "format": "date-time",
"description": "Time when the task instance reached an end state."
},
"containmentContextID": {"type": "string",
"description": "ID of the context which embraces the task instance."
},
"data": {"type": "object",
"description": "Task instance data."
},
"description": {"type": "string",
"description": "Description of the task."
},
"displayName": {"type": "string",
"description": "Display name of the task."
},
"dueTime": {"type": "string", "format": "date-time",
"description": "Time when the task is due."
},
"externalActivityID": {"type": "object",
"description": "ID of the external activity."
},
"kind": {"type": "string",
"description": "Kind of the task."
},
"lastModificationTime":{"type": "string", "format": "date-time",
"description": "The latest time at which the task was created, started or completed."
},
"milestone": {"type": "string",
"description": "The phase (milestone) the task is associated with. This is reserved for future use."
},
"name": {"type": "string",
"description": "Name of the task instance."
},
"namespace": {"type": "string",
"description": "Namespace that categorizes the task instance."
},
"originator": {"type": "string",
"description": "ID of the user that created the task instance or on whose behalf the task instance was created."
},
"owner": {"type": "string",
"description": "Owner of the task instance."
},
"priority": {"type": "integer",
"description": "Priority of the task instance."
},
"priorityName": {"type": "string",
"description": "Task priority (e.g., Low, Normal, High)."
},
"processData": {"type": "object",
"description": "Data of the process instance containing the task, currently business data."
},
"runURL": {"type": "object",
"description": "An URL that defines how to run the service/task...This is reserved for future use."
},
"serviceID": {"type": "object",
"description": "ID of the service."
},
"startTime": {"type": "string", "format": "date-time",
"description": "Time when the task was claimed or when an invocation task enters the running state."
},
"state": {"type": "string",
"description": "State of the task instance.",
"enum":
[
"STATE_CLAIMED",
"STATE_FINISHED",
"STATE_INACTIVE,
"STATE_RUNNING",
"STATE_SUSPENDED_BY_PARENT",
"STATE_TERMINATED"
]
},
"status": {"type": "string",
"description": "Status of the task."
},
"tktid": {"type": "string",
"description": "ID of the task template this instance is derived from."
},
"tkiid": {"type": "string",
"description": "Task instance ID."
},
"externalActivityID": {"type": "string",
"description": "If the task is an external activity, this field contains the activity's ID"
},
"externalActivitySnapshotID": {"type": "string",
"description": "Snapshot ID of the external implementation"
},
"serviceID": {"type": "string",
"description": "If the task is a service, this field contains the service's ID"
},
"serviceSnapshotID": {"type": "string",
"description": "Snapshot ID of the external implementation"
},
"actions": {"type": ["string"],
"description": "List of available actions for the task instance.",
"enum":
[
"ACTION_CANCELCLAIM",
"ACTION_CLAIM",
"ACTION_COMPLETE",
"ACTION_CREATEMESSAGE",
"ACTION_GETTASK",
"ACTION_GETUISETTINGS",
"ACTION_UPDATEDUEDATE",
"ACTION_UPDATEPRIORITY",
"ACTION_REASSIGNTOUSER",
"ACTION_REASSIGNTOGROUP",
"ACTION_VIEW_TASK",
"ACTION_VIEW_TASK_DETAILS",
"ACTION_SETTASK"
]
}
}
}
{
"status":"200",
"data":{
"activationTime":"2011-04-28T03:20:13Z",
"clientTypes":[
"IBM_WLE_Coach"
],
"completionTime":null,
"containmentContextID":"53",
"description":"Task: Submit requisition",
"displayName":"Task: Submit requisition",
"dueTime":"2011-04-28T04:20:12Z",
"kind":"KIND_PARTICIPATING",
"lastModificationTime":"2011-04-28T03:20:13Z",
"name":"Submit job requisition",
"originator":"tw_admin",
"owner":"tw_user",
"priority":30,
"startTime":"2011-04-28T03:20:13Z",
"state":"STATE_CLAIMED",
"tkiid":"53",
"piid":"53",
"status":"Received",
"priorityName":"Normal",
"assignedTo":"tw_user",
"assignedToType":"user",
"data":{
},
"actions":[
"ACTION_CANCELCLAIM",
"ACTION_CLAIM",
"ACTION_COMPLETE",
"ACTION_CREATEMESSAGE",
"ACTION_GETTASK",
"ACTION_GETUISETTINGS",
"ACTION_UPDATEDUEDATE",
"ACTION_UPDATEPRIORITY",
"ACTION_REASSIGNTOUSER",
"ACTION_REASSIGNTOGROUP",
"ACTION_VIEW_TASK",
"ACTION_VIEW_TASK_DETAILS"
],
"serviceID":"1.0ff035eb-a37b-4f2f-8ca1-7db695410d5d",
"serviceSnapshotID":"2064.d841529d-5d60-4905-9b8e-1361901380bd",
"collaboration" : {
"status" : true,
"allowedUsers" : [ "tw_admin", "tw_user"],
"currentUsers" : [ "tw_user"],
"taskURL" : "/rest/bpm/wle/v1/task/53/action=join"
}
}
}
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/task"
elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://rest.bpm.ibm.com/v1/data/task"
xmlns:data="http://rest.bpm.ibm.com/v1/data/root"
xmlns:cmn="http://rest.bpm.ibm.com/v1/data/common">
<import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root"/>
<import schemaLocation="Common.xsd" namespace="http://rest.bpm.ibm.com/v1/data/common"/>
<!--
This type represents a task template.
-->
<complexType name="TaskTemplate">
<complexContent>
<extension base="data:Data">
<sequence>
<!-- The task template id -->
<element name="tktid" type="string" />
<!-- The name of the task template -->
<element name="name" type="string" />
<!-- The task template's display name -->
<element name="displayName" type="string" nillable="true" />
<!-- The task template's description -->
<element name="description" type="string" nillable="true" />
<!-- The "kind" associated with the task template; this is set to "KIND_ORIGINATING" -->
<element name="kind" type="string" />
<!-- The task template's state; this will be one of: "STARTED", "STOPPED" -->
<element name="state" type="string" />
<!-- The client types associated with this task template; this will be {"IBM_WLE_COACH"} -->
<element name="clientTypes" type="string" minOccurs="0" maxOccurs="unbounded"/>
<!-- The timestamp representing the task templates effective date -->
<element name="effectiveDate" type="dateTime" />
<!-- The snapshot ID associated with the task template -->
<element name="snapshotID" type="string" nillable="true" />
<!-- The snapshot name associated with the task template -->
<element name="snapshotName" type="string" nillable="true" />
<!--
If the task template's VersionDetails represents a toolkit, then these fields will be set
to the top-level toolkit's acronym (short name) and name .
-->
<element name="topLevelToolkitAcronym" type="string" nillable="true" />
<element name="topLevelToolkitName" type="string" nillable="true" />
<!--
If the task template's VersionDetails represents a process app, then these fields will be set
to the process app's acronym (short name) and name.
-->
<element name="processAppName" type="string" nillable="true" />
<element name="processAppAcronym" type="string" nillable="true" />
<!--
If the task template's VersionDetails represents a toolkit, then this field will be set
to the top-level toolkit's branch name.
-->
<element name="trackName" type="string" nillable="true" />
<!-- A flag which indicates whether or not this task template represents a "tip" -->
<element name="isTip" type="boolean" />
<!-- A flag which indicates whether or not this is a default task template -->
<element name="isDefault" type="boolean" />
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="TaskSummaryList">
<complexContent>
<extension base="data:Data">
<sequence>
<!-- Total number of results (useful when pagination is applied) -->
<element name="total" type="long" />
<!-- A list of zero or more tasks associated with the process -->
<element name="tasks" type="tns:TaskSummary" maxOccurs="unbounded" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type represents summary information for a task. The intent is to provide a response
as quickly as possible by avoiding joins.
-->
<complexType name="TaskSummary">
<complexContent>
<extension base="data:Data">
<sequence>
<!-- The task instance ID -->
<element name="tkiid" type="string" />
<!-- The task's activity name -->
<element name="name" type="string" nillable="true" />
<!--
The task status. This will be one of:
- "New"
- "Received"
- "Replied"
- "Forwarded"
- "Sent"
- "Actioned"
- "Closed"
- "Special"
- "Deleted"
- "Alert"
- "Help_Request"
- "Comment"
- "Answered_Help_Request"
- "Ignored_Help_Request"
-->
<element name="status" type="string" />
<!-- The userName of the task's owner -->
<element name="owner" type="string" nillable="true" />
<!-- The name of the user or group to which this task is assigned -->
<element name="assignedTo" type="string" />
<element name="assignedToDisplayName" type="string" />
<!--
The type of the assignedTo element. This will be one of:
- "user"
- "group"
-->
<element name="assignedToType" type="string" />
<!-- The due date associated with the task -->
<element name="dueTime" type="dateTime" nillable="true" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type contains information about a task instance, and contains
information from both the Federation layer and the BPM Standard (WLE) layer.
-->
<complexType name="TaskDetails">
<complexContent>
<extension base="tns:TaskSummary">
<sequence>
<!-- BPM Standard (WLE) and Advanced (WPS) common properties -->
<!-- The timestamp when this task was activated -->
<element name="activationTime" type="dateTime" />
<!-- The at risk date associated with the task -->
<element name="atRiskTime" type="dateTime" nillable="true" />
<!-- The client types associated with this task; set to {"IBM_WLE_COACH"} -->
<element name="clientTypes" type="string" minOccurs="0" maxOccurs="unbounded"/>
<!-- The timestamp when the task was completed -->
<element name="completionTime" type="dateTime" nillable="true" />
<!-- If the task has a process attached, this will contain the process instance id -->
<element name="containmentContextID" type="string" nillable="true" />
<!-- The task's "narrative" -->
<element name="description" type="string" nillable="true" />
<!-- The task's "subject" -->
<element name="displayName" type="string" nillable="true" />
<!-- The flag indicating that the task is at risk -->
<element name="isAtRisk" type="boolean" />
<!--
The task's "kind". This will be one of:
- "KIND_HUMAN"
- "KIND_ORIGINATING"
- "KIND_PARTICIPATING"
- "KIND_ADMINISTRATIVE"
-->
<element name="kind" type="string" />
<!-- The latest time at which the task was created, started or completed -->
<element name="lastModificationTime" type="dateTime" />
<!-- The userName of the user that originated the task -->
<element name="originator" type="string" nillable="true" />
<!-- The priority associated with the task -->
<element name="priority" type="integer" nillable="true" />
<!-- The start time of the task -->
<element name="startTime" type="dateTime" nillable="true" />
<!--
The task state. This will be one of:
- "STATE_INACTIVE"
- "STATE_FINISHED"
- "STATE_TERMINATED"
- "STATE_SUSPENDED_BY_PARENT"
- "STATE_READY"
- "STATE_CLAIMED"
- "STATE_RUNNING"
-->
<element name="state" type="string" />
<!-- BPM Standard (WLE) specific properties -->
<!-- If the task has a process attached, this will contain the process instance id -->
<element name="piid" type="string" nillable="true" />
<!-- If the task has a process attached, this will contain the process instance name -->
<element name="processInstanceName" type="string" nillable="true" />
<!-- -->
<element name="priorityName" type="string" />
<!-- The external task data associated with this task -->
<element name="data" type="tns:ExternalTaskData" />
<!-- Process data associated with the instance containing the task -->
<element name="processData" type="tns:ProcessData" />
<!-- The name of the phase to which this task belongs..reserved for future use -->
<element name="milestone" type="string" />
<!-- If the task is an external activity, this field contains the activity's ID -->
<element name="externalActivityID" type="string" />
<element name="externalActivitySnapshotID" type="string" nillable="true" />
<!-- If the task is a service, this field contains the service's ID -->
<element name="serviceID" type="string" />
<element name="serviceSnapshotID" type="string" nillable="true" />
<element name="flowObjectID" type="string" />
<!-- not used -->
<element name="runURL" type="string" />
<!-- Contains ID of the next task if autoflow is enabled and next task was found -->
<element name="nextTaskId" type="integer" nillable="true" minOccurs="0" maxOccurs="unbounded" />
<element name="collaboration" type="tns:Collaboration"/>
<!--
The list of applicable actions of the task. Valid values:
- "ACTION_CANCELCLAIM"
- "ACTION_CLAIM"
- "ACTION_COMPLETE"
- "ACTION_CREATEMESSAGE"
- "ACTION_GETTASK"
- "ACTION_SETTASK"
- "ACTION_GETUISETTINGS"
- "ACTION_UPDATEDUEDATE"
- "ACTION_UPDATEPRIORITY"
- "ACTION_REASSIGNTOUSER"
- "ACTION_REASSIGNTOGROUP"
- "ACTION_VIEW_TASK"
- "ACTION_VIEW_TASK_DETAILS"
-->
<element name="actions" type="string" maxOccurs="unbounded" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type contains collaboration details about the task.
-->
<complexType name="Collaboration">
<sequence>
<!-- The task is under collaboration or not -->
<element name="status" type="boolean" />
<!-- If the service status is "coach", this field contains a list of available currentUsers (end point) -->
<element name="currentUsers" type="string" minOccurs="0" maxOccurs="unbounded" />
<!-- This will hold the url for invited user for any collaborated task -->
<element name="taskURL" type="string" />
</sequence>
</complexType>
<!--
This type contains details about the task.
For legacy reasons it is named ExternalTaskData even though
it is used for all tasks.
-->
<complexType name="ExternalTaskData">
<sequence>
<element name="bpdToken" type="cmn:BPDToken"/>
<element name="variables" type="cmn:Map"/>
<element name="reference" type="cmn:Reference"/>
</sequence>
</complexType>
<!--
This type contains details about the instance containing the task.
-->
<complexType name="ProcessData">
<sequence>
<element name="businessData" type="cmn:Variable" maxOccurs="unbounded" />
</sequence>
</complexType>
<!--
This type is used to return the available actions for a list of tasks.
-->
<complexType name="TaskActions">
<complexContent>
<extension base="data:Data">
<sequence>
<!--
This field specifies the primary identifier of the tasks;
this will be set to "tkiid" .
-->
<element name="identifier" type="string" />
<!-- A list of zero or more "TasksWithActions" structures -->
<element name="tasks" type="tns:tTasksWithActions" minOccurs="0" maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type contains the list of available actions available for a particular task instance.
-->
<complexType name="tTasksWithActions">
<sequence>
<!-- The task instance ID -->
<element name="tkiid" type="string" />
<!-- A list of zero or more available actions associated with the task instance -->
<element name="actions" type="string" minOccurs="0" maxOccurs="unbounded" />
</sequence>
</complexType>
<!--
This type is used to return the URL which specifies
the location of a coach associated with a particular task
-->
<complexType name="TaskClientSettings">
<complexContent>
<extension base="data:Data">
<sequence>
<!-- The URL pointing to the coach -->
<element name="url" type="string" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type is used to return the URL which specifies
the location of a coach associated with a particular service.
-->
<complexType name="TaskTemplateClientSettings">
<complexContent>
<extension base="data:Data">
<sequence>
<!-- The URL pointing to the coach -->
<element name="url" type="string" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type is used to return a task instance ID which is the result
of performing a task claim operation.
-->
<complexType name="TaskClaimResult">
<complexContent>
<extension base="data:Data">
<sequence>
<element name="tkiid" type="string" nillable="true" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type contains a list of task IDs to be passed to a
bulk operation on tasks.
-->
<complexType name="TaskBulkOperation">
<complexContent>
<extension base="data:Data">
<sequence>
<element name="taskIDs" type="string" minOccurs="0" maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type is used to return the results from performing a bulk operation on multiple tasks.
-->
<complexType name="TaskBulkOperationResponse">
<complexContent>
<extension base="data:Data">
<sequence>
<!-- A list of zero or more failed operations -->
<element name="failedOperations" type="tns:tFailedOperations" minOccurs="0" maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type is used to return the results from performing a bulk operation on multiple tasks.
-->
<complexType name="TaskDetailsBulkOperationResponse">
<complexContent>
<extension base="data:Data">
<sequence>
<!-- A list of zero or more task details objects -->
<element name="tasks" type="tns:TaskDetails" minOccurs="0" maxOccurs="unbounded" />
<!-- A list of zero or more failed operations -->
<element name="failedOperations" type="tns:tFailedOperations" minOccurs="0" maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type describes a failed operation during a bulk task-related operation.
-->
<complexType name="tFailedOperations">
<sequence>
<!-- The task instance ID -->
<element name="tkiid" type="string" />
<!-- The error message prefix associated with the error -->
<element name="errorNumber" type="string" />
<!-- The error message associated with the error -->
<element name="errorMessage" type="string" />
</sequence>
</complexType>
<!--
This type describes the model of an external activity.
-->
<complexType name="ExternalActivityModel">
<complexContent>
<extension base="data:Data">
<sequence>
<!-- The ID of the external activity -->
<element name="ID" type="string"/>
<!-- The name of the external activity -->
<element name="name" type="string"/>
<!-- The external activity's description -->
<element name="description" type="string"/>
<element name="richDescription" type="string"/>
<!-- The snapshot this external activity belongs to -->
<element name="snapshotId" type="string"/>
<!-- Warning -->
<element name="warning" type="string" />
<!-- The customProperties associated with the external activity
The key is the name of the property.
The value containing a description of the property:
* type (name of the type)
* isList
* description
* richDescription
-->
<element name="customProperties" type="cmn:Map"/>
<!-- The input variables associated with the external activity
The key is the name of the variable.
The value containing a description of the parameter:
* type (name of the type)
* isList
* description
* richDescription
-->
<element name="inputs" type="cmn:Map"/>
<!-- The output variables associated with the external activity
The key is the name of the variable.
TThe value containing a description of the parameter:
* type (name of the type)
* isList
* description
* richDescription
-->
<element name="outputs" type="cmn:Map"/>
<!-- Detailed information about the types referenced by the service.
Each type referenced above and nested types are described.
The key is the name of the type.
The value is an map of information about the type Here are some of the fields:
* ID, pattern, properties, isShared, options, min, max, description, fixedLength
-->
<element name="validations" type="cmn:Map"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type is used to return response data resulting from a task start operation.
-->
<complexType name="TaskStartData">
<complexContent>
<extension base="data:Data">
<sequence>
<!-- A list of attribute/value pairs which make up the task start.
The "data" key has a value that isjson string representing the variables and values of the task.
the "dataMap" key has a value that is a map containing the variables and values of the task.
-->
<element name="return" type="cmn:Map"/>
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="ID"/>
</schema>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bpm:ResponseData xmlns:bpm='http://rest.bpm.ibm.com/v1/data'>
<status>200</status>
<data xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:type='tsk:TaskDetails' xmlns:tsk='http://rest.bpm.ibm.com/v1/data/task'>
<activationTime>2011-04-28T03:20:13Z</activationTime>
<clientTypes>IBM_WLE_Coach</clientTypes>
<completionTime xsi:nil='true' />
<containmentContextID>53</containmentContextID>
<description>Task: Submit requisition</description>
<displayName>Task: Submit requisition</displayName>
<dueTime>2011-04-28T04:20:12Z</dueTime>
<kind>KIND_PARTICIPATING</kind>
<lastModificationTime>2011-04-28T03:20:13Z</lastModificationTime>
<name>Submit job requisition</name>
<originator>tw_admin</originator>
<owner>tw_user</owner>
<priority>30</priority>
<startTime>2011-04-28T03:20:13Z</startTime>
<state>STATE_CLAIMED</state>
<tkiid>53</tkiid>
<piid>53</piid>
<status>Received</status>
<priorityName>Normal</priorityName>
<assignedTo>tw_user</assignedTo>
<assignedToType>user</assignedToType>
<data />
<serviceID>1.0ff035eb-a37b-4f2f-8ca1-7db695410d5d</serviceID>
<serviceSnapshotID>2064.d841529d-5d60-4905-9b8e-1361901380bd</serviceSnapshotID>
<collaboration>
<status>true</status>
<allowedUsers>tw_admin</allowedUsers>
<allowedUsers>tw_user</allowedUsers>
<currentUsers>tw_user</currentUsers>
<taskURL>/rest/bpm/wle/v1/task/53/action=join</taskURL>
</collaboration>
<actions>ACTION_GETTASK</actions>
<actions>ACTION_GETUISETTINGS</actions>
<actions>ACTION_CREATEMESSAGE</actions>
<actions>ACTION_VIEW_TASK</actions>
<actions>ACTION_VIEW_TASK_DETAILS</actions>
<actions>ACTION_INVITE</actions>
</data>
</bpm:ResponseData>
The default content type is application/json.
{ "description": "WLE Error Response",
"type": "object",
"properties":
{ "status": {"type": "string",
"description": "The status of the previous API call."
},
"exceptionType": {"type": "string",
"description": "The classname associated with the exception."
},
"errorNumber": {"type": "string",
"description": "Message ID of the exception."
},
"errorMessage": {"type": "string",
"description": "Message text of the exception."
},
"errorMessageParameters": {"type": ["string"], "optional": true,
"description":"Message text parameters of the exception."
},
"programmersDetails": {"type": "object", "optional": true,
"description":"Additional exception details, for example, a stack trace."
}
}
}
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/exception"
elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://rest.bpm.ibm.com/v1/data/exception"
xmlns:dat="http://rest.bpm.ibm.com/v1/data/root">
<import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root" />
<!--
This type represents an error response.
-->
<element name="RestRuntimeException">
<complexType>
<sequence>
<element name="status" type="string"/>
<element name="Data" type="tns:ExceptionData">
</element>
</sequence>
</complexType>
</element>
<!--
This type contains detailed error information associated with an exception.
-->
<complexType name="ExceptionData">
<sequence>
<element name="status" type="string"/>
<!-- This specifies the java class name of the exception -->
<element name="exceptionType" type="string"/>
<!-- The message ID of the error message -->
<element name="errorNumber" type="string" minOccurs="0"/>
<!-- The complete error message -->
<element name="errorMessage" type="string"/>
<!-- The list of strings inserted into the error message -->
<element name="errorMessageParameters" type="string" minOccurs="0" maxOccurs="unbounded"/>
<!--
The stacktrace associated with the exception.
Note that this will be omitted unless the "server-stacktrace-enabled" property
is enabled in the server's 100Custom.xml file.
-->
<element name="programmersDetails" type="string"></element>
<!-- Prior responses. Set if a bulk command was used -->
<element name="responses" type="dat:BulkCommandResponses" minOccurs="0"></element>
<element name="errorData" type="tns:ErrorData" minOccurs="0" />
</sequence>
</complexType>
<complexType name="ErrorData">
<sequence>
<element name="code" type="string" />
<element name="data" type="string" minOccurs="0" />
</sequence>
</complexType>
</schema>
| Code | Description |
|---|---|
| 200 OK | Success completion. |
| 400 Bad Request | The parameters are not valid or they are missing. |
| 401 Unauthorized | The caller is not authorized for this request. |
| 404 Not Found | The task does not exist.
|
| 406 Not Acceptable | The requested content type or content encoding is not supported. |
| 500 Internal Server Error | A severe problem has occurred, programmer's details are provided. |
7.5.0
Parent Topic: Task Instance Resource