POST /rest/bpm/wle/v1/process?action={string}&bpdId={string}[&snapshotId={string}][&branchId={string}][&processAppId={string}][¶ms={string}][&parts={string}][&eventSourceId={string}][&objectId={string}][&mode={string}]
snapshotId, branchId, or processAppId parameters.snapshotId parameter is specified, that specific snapshot is used and the branchId and processAppId parameters are ignored.branchId parameter is specified, the tip (current) snapshot of the specified branch (track) is used and the processAppId parameter is ignored.branchId parameter is ignored on a Process Server environment because it refers to the tip snapshot of the specified branch.processAppId parameter is specified, the tip (current) snapshot of the default branch (track) on Process Center or the default snapshot on Process Server of that process application is used.
| Name | Value Type | Description | ||||
|---|---|---|---|---|---|---|
| action | string | The action to perform on the process.
|
||||
| bpdId | string | The identifier of the business process definition to be used.
|
| Name | Value Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| snapshotId | string | The identifier of the snapshot that contains the business process definition.
You must set one of the
snapshotId, branchId, or processAppId parameters.
|
||||||
| branchId | string | The identifier of the branch that contains the business process definition.
If this parameter is specified, the tip snapshot of the specified branch is used.
You must set one of the
snapshotId, branchId, or processAppId parameters.
|
||||||
| processAppId | string | The identifier of the process application that contains the business process definition.
If this parameter is specified, the tip snapshot of the default branch within the specified
process application is used.
You must set one of the
snapshotId, branchId, or processAppId parameters.
|
||||||
| params | string |
A string containing a JSON expression that contains one or more input parameter settings.
Each of the variables isset in the context of the running process.
Example: ....params={"orderNumber":"5","customerName":{"firstName":"John","lastName":"Doe"}}
|
||||||
| parts | string | A string indicating which parts of the response data should be returned. You can specify multiple part names by separating the values with the '|' character. You can use the following values:
|
||||||
| eventSourceId | string | The ID of the ECM server repository. The ID is required to start a BPD instance using the external document start event. |
||||||
| objectId | string | The ID of the object instance. The ID is required to start a BPD instance using the external document start event. |
||||||
| mode | string | A string indicating whether the process should be started in run or debug mode.
|
Use this mime-type in situations where the length of the query string might cause the request URI to exceed the maximum length supported by the browser or HTTP client environment. With this mime-type, you can move all of your query parameters to the HTTP request body and avoid request URI length restrictions.
Example:
POST http://myhost.mycompany.com:9080/rest/bpm/wle/v1/process
HTTP Headers:
Content-Type: application/x-www-form-urlencoded
Accept: application/json
HTTP Request Body:
action=start&bpdId=<myBpdID>&snapshotId=<mySnapShotID>¶ms={"orderNumber":"5","customerName":{"firstName":"John","lastName":"Doe"}}
The default content type is application/json.
{
"description" : "WLE Process Details",
"type" : "object",
"properties" : {
"actionDetails" : {
"type" : "object",
"description" : "Details of the action performed if applicable"
},
"businessData" : {
"type" : "object",
"description" : "Business data defined for the instance, including name, alias, type and value."
},
"creationTime" : {
"type" : "string",
"format" : "date-time",
"description" : "Creation time of the process instance."
},
"comments" : {
"type" : "[object]",
"description" : "List of comments on this instance."
},
"data" : {
"type" : "string",
"description" : "Data of this instance in a json format."
},
"description" : {
"type" : "string",
"description" : "Description of the process instance."
},
"diagram" : {
"type" : "object",
"description" : "BPD diagram of this instance, including existing tokens and associated task for the instance."
},
"documents" : {
"type" : "[object]",
"description" : "List of documents on this instance.",
"properties" : {
"ID" : {
"type" : "string",
"description" : "The identifier of the document."
},
"ecmID" : {
"type" : "string",
"description" : "The ECM identifier of the document. Use it for Content Integration steps in services."
},
"type" : {
"type" : "string",
"description" : "The type of the document.",
"enum" : [
"FILE",
"URL"
]
},
"name" : {
"type" : "string",
"description" : "The name of the document."
},
"date" : {
"type" : "string",
"format" : "date-time",
"description" : "The date and time when the document was created."
},
"length" : {
"type" : "integer",
"description" : "The size of the document. Only applicable if this document is of type FILE."
},
"url" : {
"type" : "string",
"description" : "The URL of the document. Only applicable if the document is of type URL."
},
"version" : {
"type" : "integer",
"description" : "The version number of the document."
}
}
},
"executionState" : {
"type" : "string",
"description" : "Execution state of the process instance.",
"enum" : [
"Active",
"Completed",
"Failed",
"Suspended",
"Terminated"
]
},
"executionTree" : {
"type" : "object",
"description" : "Excution tree associated with the process."
},
"instanceError" : {
"type" : "string",
"description" : "Error message for failed instances."
},
"lastModificationTime" : {
"type" : "string",
"format" : "date-time",
"description" : "Last time a property of the process instance changed."
},
"name" : {
"type" : "string",
"description" : "Name of the process instance."
},
"piid" : {
"type" : "string",
"description" : "ID of the process instance."
},
"processTemplateID" : {
"type" : "string",
"description" : "ID of the process template this instance is derived from."
},
"processTemplateName" : {
"type" : "string",
"description" : "Name of the process template this instance is derived from."
},
"processAppName" : {
"type" : "string",
"description" : "Name of the process application."
},
"processAppAcronym" : {
"type" : "string",
"description" : "The process application acronym."
},
"snapshotName" : {
"type" : "string",
"description" : "Name of the snapshot associated with this process instance."
},
"snapshotID" : {
"type" : "string",
"description" : "ID of the snapshot associated with this process instance."
},
"dueDate" : {
"type" : "string",
"format" : "date-time",
"description" : "The due date associated with the process instance."
},
"predictedDueDate" : {
"type" : "string",
"format" : "date-time",
"description" : "The predicted due date associated with the process instance."
},
"tasks" : {
"type" : "[object]",
"description" : "List of tasks with the same data model."
},
"variables" : {
"type" : "object",
"description" : "Variable values in a json object."
},
"state" : {
"type" : "string",
"description" : "State of the process instance.",
"enum" : [
"STATE_COMPENSATED",
"STATE_COMPENSATION_FAILED",
"STATE_COMPENSATING",
"STATE_DELETED",
"STATE_FAILED",
"STATE_FAILING",
"STATE_FINISHED",
"STATE_INDOUBT",
"STATE_READY",
"STATE_RUNNING",
"STATE_SUSPENDED",
"STATE_TERMINATED",
"STATE_TERMINATING"
]
},
"actions" : {
"type" : "[string]",
"description" : "List of available actions for the process instance.",
"enum" : [
"ACTION_ABORT_INSTANCE",
"ACTION_ADD_COMMENT",
"ACTION_ADD_DOCUMENT",
"ACTION_ADD_HELP_REQUEST",
"ACTION_CHANGE_CRITICAL_PATH",
"ACTION_CHANGE_INSTANCE_DUEDATE",
"ACTION_DELETE_DOCUMENT",
"ACTION_DELETE_INSTANCE",
"ACTION_DELETE_TOKEN",
"ACTION_FIRE_TIMER",
"ACTION_INJECT_TOKEN",
"ACTION_MOVE_TOKEN",
"ACTION_RESPOND_HELP_REQUEST",
"ACTION_RESUME_INSTANCE",
"ACTION_SUSPEND_INSTANCE",
"ACTION_UPDATE_DOCUMENT",
"ACTION_VIEW_INSTANCE",
"ACTION_VIEW_PROCESS_AUDIT",
"ACTION_VIEW_PROCESS_DIAGRAM"
]
},
"relationship" : {
"type" : "[object]",
"description" : "The list of relationships this process instance is referenced.",
"properties" : {
"id" : {
"type" : "string",
"description" : "The ID of the relationship."
},
"type" : {
"type" : "string",
"description" : "The type of the relationship.",
"enum" : [
"INDEPENDENT",
"DEPENDENT"
]
},
"sourceId" : {
"type" : "string",
"description" : "The external form of the instance ID of the source."
},
"targetId" : {
"type" : "string",
"description" : "The external form of the instance ID of the target."
},
"description" : {
"type" : "string",
"description" : "The description of the relationship."
},
"creationDate" : {
"type" : "string",
"format" : "date-time",
"description" : "The date when the relationship was first created."
},
"lastModified" : {
"type" : "string",
"format" : "date-time",
"description" : "The date when the relationship was last modified."
},
"creator" : {
"type" : "object",
"description" : "The user who created the relationship.",
"properties" : {
"userID" : {
"type" : "integer",
"description" : "The user ID of the user that is described by this object."
},
"userName" : {
"type" : "string",
"description" : "The user name of the user that is described by this object."
},
"fullName" : {
"type" : "string",
"description" : "The full name of the user that is described by this object."
},
"isDisabled" : {
"type" : "boolean",
"description" : "States whether this user is disabled. This field is set to false and cannot be changed."
}
}
}
}
}
}
}
{
"status":"200",
"data":{
"creationTime":"2011-04-28T03:20:11Z",
"description":"",
"executionState":"Active",
"state":"STATE_RUNNING",
"lastModificationTime":"2011-04-28T03:20:13Z",
"name":"Employee Requisition for (53)",
"piid":"53",
"processTemplateID":"25.8403dd37-e049-46f5-8952-b7a46f0d198f",
"processTemplateName":"HR Open New Position",
"processAppName":"BPM REST JUNIT TEST MODEL 1",
"processAppAcronym":"BPMRES1",
"snapshotName":"1.0.1",
"snapshotID":"2064.73dd1d1a-b533-46ef-ba79-c94cb3b0de87",
"dueDate":"2011-05-12T03:20:11Z",
"comments":[
],
"tasks":[
{
"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":{
},
"serviceID":"1.0ff035eb-a37b-4f2f-8ca1-7db695410d5d"
}
],
"documents":[
],
"data":{
},
"diagram":{
"processAppID":"2066.931b0053-02bd-4f47-ac72-4eb527457383",
"milestone":null,
"step":[
{
"name":"Ad-hoc Event",
"type":"activity",
"activityType":"task",
"lane":"Ad-hoc Processes",
"x":226,
"y":31,
"color":"Default",
"attachedTimer":null,
"lines":[
{
"to":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dfb",
"points":""
}
],
"tokenID":null,
"taskID":null,
"ID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7e04"
},
{
"name":"End Ad-hoc Event",
"type":"event",
"lane":"Ad-hoc Processes",
"x":361,
"y":34,
"color":"Default",
"attachedTimer":null,
"lines":null,
"tokenID":null,
"taskID":null,
"ID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dfb"
},
{
"name":"Start Ad-hoc Event",
"type":"event",
"lane":"Ad-hoc Processes",
"x":117,
"y":33,
"color":"Default",
"attachedTimer":null,
"lines":[
{
"to":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7e04",
"points":""
}
],
"tokenID":null,
"taskID":null,
"ID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7df2"
},
{
"name":"Submit job requisition",
"type":"activity",
"activityType":"task",
"lane":"Hiring Manager",
"x":193,
"y":30,
"color":"Blue",
"attachedTimer":null,
"lines":[
{
"to":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd6",
"points":""
}
],
"tokenID":[
"2"
],
"taskID":"53",
"ID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9"
},
{
"name":"Need GM approval?",
"type":"gateway",
"lane":"Hiring Manager",
"x":325,
"y":45,
"color":"Default",
"attachedTimer":null,
"lines":[
{
"to":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7da5",
"points":""
},
{
"to":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d84",
"points":""
}
],
"tokenID":null,
"taskID":null,
"ID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd6"
},
{
"name":"Start",
"type":"event",
"lane":"Hiring Manager",
"x":10,
"y":17,
"color":"Default",
"attachedTimer":null,
"lines":[
{
"to":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9",
"points":""
}
],
"tokenID":null,
"taskID":null,
"ID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5"
},
{
"name":"Submit Timer",
"type":"event",
"lane":"Hiring Manager",
"x":13,
"y":117,
"color":"Default",
"attachedTimer":null,
"lines":[
{
"to":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9",
"points":""
}
],
"tokenID":null,
"taskID":null,
"ID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dc2"
},
{
"name":"Submit Message",
"type":"event",
"lane":"Hiring Manager",
"x":59,
"y":50,
"color":"Default",
"attachedTimer":null,
"lines":[
{
"to":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9",
"points":""
}
],
"tokenID":null,
"taskID":null,
"ID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7db9"
},
{
"name":"GM approved?",
"type":"gateway",
"lane":"General Manager",
"x":442,
"y":50,
"color":"Default",
"attachedTimer":null,
"lines":[
{
"to":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d84",
"points":""
},
{
"to":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d75",
"points":""
}
],
"tokenID":null,
"taskID":null,
"ID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7da6"
},
{
"name":" Approve/reject requisition",
"type":"activity",
"activityType":"task",
"lane":"General Manager",
"x":317,
"y":35,
"color":"Purple",
"attachedTimer":null,
"lines":[
{
"to":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7da6",
"points":""
}
],
"tokenID":null,
"taskID":null,
"ID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7da5"
},
{
"name":"End",
"type":"event",
"lane":"Human Resources",
"x":752,
"y":48,
"color":"Default",
"attachedTimer":null,
"lines":null,
"tokenID":null,
"taskID":null,
"ID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d91"
},
{
"name":"Find job candidates",
"type":"activity",
"lane":"Human Resources",
"x":618,
"y":28,
"color":"Yellow",
"attachedTimer":null,
"lines":[
{
"to":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d91",
"points":""
}
],
"tokenID":null,
"taskID":null,
"ID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d84"
},
{
"name":"Notify hiring manager",
"type":"activity",
"lane":"System",
"x":532,
"y":35,
"color":"Orange",
"attachedTimer":null,
"lines":[
{
"to":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d66",
"points":""
}
],
"tokenID":null,
"taskID":null,
"ID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d75"
},
{
"name":"Requisition terminiated",
"type":"event",
"lane":"System",
"x":665,
"y":55,
"color":"Default",
"attachedTimer":null,
"lines":null,
"tokenID":null,
"taskID":null,
"ID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d66"
}
],
"lanes":[
{
"name":"Ad-hoc Processes",
"height":140,
"system":false
},
{
"name":"Hiring Manager",
"height":187,
"system":false
},
{
"name":"General Manager",
"height":163,
"system":false
},
{
"name":"Human Resources",
"height":169,
"system":false
},
{
"name":"System",
"height":140,
"system":true
}
]
},
"actions":[
"ACTION_VIEW_PROCESS_DIAGRAM",
"ACTION_VIEW_PROCESS_AUDIT",
"ACTION_ABORT_INSTANCE",
"ACTION_CHANGE_CRITICAL_PATH",
"ACTION_SUSPEND_INSTANCE",
"ACTION_ADD_COMMENT",
"ACTION_ADD_HELP_REQUEST",
"ACTION_RESPOND_HELP_REQUEST",
"ACTION_CHANGE_INSTANCE_DUEDATE"
]
}
}
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/process"
elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://rest.bpm.ibm.com/v1/data/process"
xmlns:pref="http://rest.bpm.ibm.com/v1/data/root"
xmlns:common="http://rest.bpm.ibm.com/v1/data/common"
xmlns:execution="http://rest.bpm.ibm.com/v1/data/execution"
xmlns:task="http://rest.bpm.ibm.com/v1/data/task"
xmlns:activity="http://rest.bpm.ibm.com/v1/data/activity"
xmlns:relationship="http://rest.bpm.ibm.com/v1/data/relationship">
<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"/>
<import schemaLocation="Task.xsd" namespace="http://rest.bpm.ibm.com/v1/data/task"></import>
<import schemaLocation="ExecutionTree.xsd" namespace="http://rest.bpm.ibm.com/v1/data/execution"></import>
<import schemaLocation="Activity.xsd" namespace="http://rest.bpm.ibm.com/v1/data/activity"/>
<import schemaLocation="Relationship.xsd" namespace="http://rest.bpm.ibm.com/v1/data/relationship"/>
<complexType name="ProcessSearchResult">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="overview" type="common:Map"/>
<element name="processes" type="tns:ProcessSummary" maxOccurs="unbounded" minOccurs="0" />
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="ProcessSummary">
<complexContent>
<extension base="pref:Data">
<sequence>
<!-- The process instance ID -->
<element name="piid" type="string" />
<!-- The name of the process -->
<element name="name" type="string" />
<!-- The name of the BPD -->
<element name="bpdName" type="string" />
<!-- The snapshot ID -->
<element name="snapshotID" type="string" nillable="true" />
<!-- The due date associated with the process -->
<element name="dueDate" type="dateTime" />
<!-- The at risk date associated with the process -->
<element name="atRiskDate" type="dateTime" />
<!-- The current status of the process instance
Valid values are:
"Active",
"Completed",
"Failed",
"Suspended",
"Terminated" -->
<element name="executionState" type="string" />
<!-- Error message for failed process instance -->
<element name="instanceError" type="string" />
<!-- The timestamp for when the process instance was created -->
<element name="creationDate" type="dateTime" />
<!-- The timestamp when the process was last modified -->
<element name="lastModificationTime" type="dateTime" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type contains details related to a process instance.
-->
<complexType name="ProcessDetails">
<complexContent>
<extension base="pref:Data">
<sequence>
<!-- The timestamp when the process instance was created -->
<element name="creationTime" type="dateTime" />
<!-- The description of the process -->
<element name="description" type="string" nillable="true" />
<element name="richDescription" type="string" nillable="true" />
<!-- The current status of the process instance
Valid values are:
"Active",
"Completed",
"Failed",
"Suspended",
"Terminated" -->
<element name="executionState" type="string" />
<!-- The current state of the process instance. -->
<element name="state" type="string" />
<!-- The timestamp when the process was last modified -->
<element name="lastModificationTime" type="dateTime" />
<!-- The name of the process -->
<element name="name" type="string" />
<!-- The process instance ID -->
<element name="piid" type="string" />
<!-- The case folder ID -->
<element name="caseFolderID" type="string" />
<!-- The case folder server name -->
<element name="caseFolderServerName" type="string" nillable="true"/>
<!-- The process template (BPD) ID -->
<element name="processTemplateID" type="string" />
<!-- The process template (BPD) name -->
<element name="processTemplateName" type="string" />
<!-- The name of the process application -->
<element name="processAppName" type="string" nillable="true" />
<!-- The process application acronym -->
<element name="processAppAcronym" type="string" nillable="true" />
<!-- The ID of the process app -->
<element name="processAppID" type="string" nillable="true" />
<!-- The name of the snapshot -->
<!-- The result of script execution -->
<element name="result" type="string" nillable="true" />
<element name="snapshotName" type="string" nillable="true" />
<!-- The snapshot ID -->
<element name="snapshotID" type="string" nillable="true" />
<!-- The branch (track) ID -->
<element name="branchID" type="string" />
<!-- The name of the branch (track) -->
<element name="branchName" type="string" />
<!-- The snapshot tip -->
<element name="snapshotTip" type="boolean" />
<!-- The starting document ID -->
<element name="startingDocumentID" type="string" />
<!-- The starting document server name -->
<element name="startingDocumentServerName" type="string" nillable="true"/>
<!-- The parent case ID -->
<element name="parentCaseId" type="string" nillable="true"/>
<!-- The parent activity ID -->
<element name="parentActivityId" type="string" nillable="true"/>
<!-- The workflow application -->
<element name="workflowApplication" type="string" nillable="true"/>
<!-- Error message for failed process instance -->
<element name="instanceError" type="string" />
<!-- The due date associated with the process -->
<element name="dueDate" type="dateTime" />
<!-- The predicted due date associated with the process -->
<element name="predictedDueDate" type="dateTime" />
<!-- Comments associated with the process instance -->
<element name="comments" type="tns:CommentsType" maxOccurs="unbounded" minOccurs="0" />
<!-- A list of zero or more tasks associated with the process -->
<element name="tasks" type="task:TaskDetails" maxOccurs="unbounded" minOccurs="0"/>
<!-- A list of zero or more documents associated with the process -->
<element name="documents" type="tns:documentsType" maxOccurs="unbounded" minOccurs="0"/>
<!-- The details of the action performed if applicable -->
<element name="actionDetails" type="tns:ActionDetails" minOccurs="0" />
<!--
The data associated with the process instance in a json String.
To understand this, you'll need the data model associated with the BPD.
-->
<element name="data" type="string" />
<!--
Data information stored in an actual Map like the TaskDetails information
-->
<element name="variables" type="common:Map" />
<!--
List of all relationships referencing this particular process instance either as target or source.
-->
<element name="relationship" type="relationship:RelationshipDetails" maxOccurs="unbounded" minOccurs="0"/>
<!--
Business data information stored as list of variables.
-->
<element name="businessData" type="common:Variable" maxOccurs="unbounded" />
<!-- The execution tree associated with the process -->
<element name="executionTree" type="execution:ExecutionTree" />
<!-- The diagram associated with the process instance -->
<element name="diagram" type="tns:DiagramType" />
<!-- The list of applicable actions of the process instance -->
<element name="actions" type="string" maxOccurs="unbounded" minOccurs="0"/>
<!-- The name of the BPD -->
<element name="bpdName" type="string" />
<!-- The Id of the User who started the process instance -->
<element name="starterId" type="string" />
</sequence>
</extension>
</complexContent>
</complexType>
<!-- This type is used to return a list of process details. -->
<complexType name="ProcessDetailsList">
<complexContent>
<extension base="pref:Data">
<sequence>
<!-- This is a list of zero or more process details. -->
<element name="processInstance" type="tns:ProcessDetails" minOccurs="0" maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type contains information about a Business Process Definition Model.
-->
<complexType name="BPDModel">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="Header" type="tns:HeaderType"/>
<element name="DataModel" type="tns:DataModelType"/>
<element name="Diagram" type="tns:DiagramType"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type contains the "header" type information associated with a BPD Model.
-->
<complexType name="HeaderType">
<sequence>
<!-- The BPD ID -->
<element name="ID" type="string"/>
<!-- The BPD name -->
<element name="name" type="string"/>
<!-- The BPD description -->
<element name="description" type="string"/>
<element name="richDescription" type="string"/>
</sequence>
</complexType>
<!--
This type contains information about a BPD's "data model".
This includes the inputs and outputs associated with a BPD.
-->
<complexType name="DataModelType">
<sequence>
<!-- A list of variables that are defined by the BPD model -->
<element name="properties" type="common:Map"/>
<!-- A list of inputs to the process -->
<element name="inputs" type="common:Map"/>
<!-- A list of outputs produced by the process -->
<element name="outputs" type="common:Map"/>
<!-- A structure explaining the BPD's data model -->
<element name="validation" type="common:Map"/>
</sequence>
</complexType>
<!--
This type contains information about a diagram associated
with a BPD or Process instance.
-->
<complexType name="DiagramType">
<sequence>
<!-- The process application ID (short name) -->
<element name="processAppID" type="string"/>
<!--
A list of zero or more phases associated with the process.
A phase represents a phase of process execution.
-->
<element name="milestone" type="tns:milestoneType" minOccurs="0" maxOccurs="unbounded"/>
<!-- A list of zero or more steps associated with the process -->
<element name="step" type="tns:stepType" maxOccurs="unbounded" minOccurs="0"/>
<!--
A list of zero or more lanes associated with the process.
A "lane" typically represents a department within a business organization.
-->
<element name="lanes" type="tns:lanesType" maxOccurs="unbounded" minOccurs="0"/>
<!--
A list of zero or more tokens associated with the process but not to a specific step or attached element.
-->
<element name="orphaned" type="tns:orphanType" maxOccurs="unbounded" minOccurs="0"/>
</sequence>
</complexType>
<!--
This type represents a "phase" which models a
phase of execution within a process.
-->
<complexType name="milestoneType">
<sequence>
<!-- The name of the phase -->
<element name="name" type="string"/>
<!-- The "width" of the phase (in pixels) -->
<element name="width" type="int"/>
</sequence>
</complexType>
<!--
This type contains the detailed information associated with a "step" within a process.
-->
<complexType name="stepType">
<sequence>
<!-- The step ID -->
<element name="ID" type="string"/>
<!-- The name of the step -->
<element name="name" type="string"/>
<!--
The step type associated with this step.
Examples: event, gateway, activity, etc.
-->
<element name="type" type="string"/>
<!--
If the type is "activity", this field specifies the type of activity.
Examples: task, externalActivity, subBpd, etc.
-->
<element name="activityType" type="string" minOccurs="0" />
<!--
If the activity type is "subBpd", the externalID is the Process id
of the subBpd.
If the activity type is "task", the externalID is the Service id of the task's service.
If the activity type is "externalTask", the externalID is the External Activity id of
the external task.
-->
<element name="externalID" type="string" minOccurs="0" />
<!-- A diagram for subprocesses -->
<element name="diagram" type="tns:DiagramType" minOccurs="0"/>
<!-- The name of the phase to which the step belongs. -->
<element name="milestone" type="string"/>
<!-- The name of the lane to which the step belongs -->
<element name="lane" type="string"/>
<!-- The X,Y coordinate of the centerpoint of this step within the diagram -->
<element name="x" type="int"/>
<element name="y" type="int"/>
<!-- The color associated with the step within the diagram -->
<element name="color" type="string"/>
<!-- A list of zero or more timers attached to this step -->
<element name="attachedTimer" type="tns:attachedTimerType" maxOccurs="unbounded" minOccurs="0"/>
<!-- An optional pre-tracking point attached to this step -->
<element name="preTrackingPoint" type="tns:trackingPointType" maxOccurs="1" minOccurs="0"/>
<!-- An optional post-tracking point attached to this step -->
<element name="postTrackingPoint" type="tns:trackingPointType" maxOccurs="1" minOccurs="0"/>
<!-- A list of zero or more event handler attached to this step -->
<element name="attachedEventHandler" type="tns:attachedEventHandlerType" maxOccurs="unbounded" minOccurs="0"/>
<!-- A list of zero of more lines which extend out from this step in the diagram -->
<element name="lines" type="tns:linesType" maxOccurs="unbounded" minOccurs="0"/>
<!-- A list of token IDs associated with this step -->
<element name="tokenID" type="string" maxOccurs="unbounded" minOccurs="0"/>
<!-- Task ID associated with this step if there is any associated task -->
<element name="taskID" type="string" maxOccurs="1" minOccurs="0"/>
</sequence>
</complexType>
<!--
-->
<complexType name="attachedTimerType">
<sequence>
<element name="ID" type="string"/>
<element name="name" type="string"/>
<element name="description" type="string"/>
<element name="richDescription" type="string"/>
<element name="tokenID" type="string" maxOccurs="unbounded" minOccurs="0"/>
</sequence>
</complexType>
<!--
-->
<complexType name="trackingPointType">
<sequence>
<element name="ID" type="string"/>
<element name="name" type="string"/>
<element name="description" type="string"/>
<element name="richDescription" type="string"/>
<element name="tokenID" type="string" maxOccurs="unbounded" minOccurs="0"/>
<element name="eventID" type="string"/>
</sequence>
</complexType>
<!--
-->
<complexType name="attachedEventHandlerType">
<sequence>
<element name="ID" type="string"/>
<element name="name" type="string"/>
<element name="description" type="string"/>
<element name="richDescription" type="string"/>
<!-- Type of event message end message or intermediate message -->
<element name="eventType" type="string" minOccurs="0" />
<element name="tokenID" type="string" maxOccurs="unbounded" minOccurs="0"/>
</sequence>
</complexType>
<!--
This type represents a single line which extends out from a particular step within a BPD diagram.
-->
<complexType name="linesType">
<sequence>
<!-- The step ID of the step to which this line extends -->
<element name="to" type="string"/>
<!--
A string containing a comma-separated list of coordinates through which this line extends.
The list of points must contain the first point (coordinate of the "fromPort")
and the last point (coordinate of the "toPort").
-->
<element name="points" type="string"/>
<element name="tokenID" type="string" maxOccurs="unbounded" minOccurs="0"/>
<element name="name" type="string"/>
</sequence>
</complexType>
<!--
This type represents a lane which is associated with a BPD diagram.
-->
<complexType name="lanesType">
<sequence>
<!-- The name of the lane -->
<element name="name" type="string"/>
<!-- The height of the lane (in pixels) -->
<element name="height" type="int"/>
<!-- Indicates whether or not this lane is a "system" lane -->
<element name="system" type="boolean"/>
</sequence>
</complexType>
<!--
This type represents a orphan token which is associated with a BPD diagram.
-->
<complexType name="orphanType">
<sequence>
<!-- A token IDs associated with this process instance -->
<element name="tokenID" type="string" maxOccurs="unbounded" minOccurs="0"/>
<element name="snapshotID" type="string" nillable="true" />
<element name="bpdID" type="string"/>
<element name="stepID" type="string"/>
<element name="step" type="tns:stepType" maxOccurs="1" minOccurs="0"/>
</sequence>
</complexType>
<!--
This type represents a comment associated with a process instance.
-->
<complexType name="CommentsType">
<sequence>
<!-- The username of the user that entered the comment -->
<element name="who" type="string"/>
<!-- The timestamp when the comment was entered -->
<element name="date" type="dateTime"/>
<!-- The message associated with the comment -->
<element name="message" type="string"/>
</sequence>
</complexType>
<!--
This type represents a document that is associated with a process instance.
-->
<complexType name="documentsType">
<sequence>
<!-- The ID associated with the document; this is used for "update" and "delete" -->
<element name="ID" type="string"/>
<!-- The ECM ID associated with the document; this is used for Content Integration steps -->
<element name="ecmID" type="string"/>
<!-- The name of the document -->
<element name="name" type="string"/>
<!-- The content type of the document (file, url) -->
<element name="type" type="string"/>
<!-- The timestamp when the document was added -->
<element name="date" type="dateTime"/>
<!-- The length (in bytes) of the document content -->
<element name="length" type="int"/>
<!--
For a document of type "url" this specifies the URL associated with the document.
Note that for a "url" type document, we store the URL and not the document
contents.
-->
<element name="url" type="string"/>
<!-- The version of the document -->
<element name="version" type="int"/>
</sequence>
</complexType>
<!--
This type is used to return the status from the "sendMessage" action.
-->
<complexType name="SendMessageStatus">
<complexContent>
<extension base="pref:Data">
<sequence>
<!-- A flag which indicates whether or not the message was successfully sent -->
<element name="messageSent" type="boolean"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type is used to return the result of evaluating a javascript expression.
-->
<complexType name="JSReturnData">
<complexContent>
<extension base="pref:Data">
<sequence>
<!-- The "result" consists of a list of attribute/value pairs -->
<element name="result" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!-- Trigger Action Hander Result -->
<complexType name="ActionResult">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="tkiid" type="string" maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<!-- Actions may have specific details -->
<complexType name="ActionDetails">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="actionName" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!-- Adhoc Action Details-->
<complexType name="AdhocActionDetails">
<complexContent>
<extension base="tns:ActionDetails">
<sequence>
<element name="createdTaskIDs" type="string" maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="diagramInstanceType">
<sequence>
<element name="diagram" type="tns:DiagramType"/>
<element name="tokenID" type="string"/>
<element name="taskID" type="string"/>
</sequence>
</complexType>
<complexType name="Action">
<sequence>
<element name="ID" type="string"/>
<element name="displayName" type="string"/>
<element name="description" type="string"/>
<element name="richDescription" type="string"/>
</sequence>
</complexType>
<complexType name="Event">
<complexContent>
<extension base="pref:Data">
<sequence>
<sequence>
<element name="actions" type="tns:Action" minOccurs="0" maxOccurs="unbounded" />
</sequence>
<sequence>
<element name="standardActions" type="string" minOccurs="0" maxOccurs="unbounded" />
</sequence>
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type contains the list of available actions available for a particular process instance.
-->
<complexType name="tProcessWithActions">
<sequence>
<!-- The process instance ID -->
<element name="piid" type="string" />
<!-- A list of zero or more available actions associated with the process instance -->
<sequence>
<element name="actions" type="string" minOccurs="0" maxOccurs="unbounded" />
</sequence>
</sequence>
</complexType>
<complexType name="ProcessActions">
<complexContent>
<extension base="pref:Data">
<sequence>
<!--
This field specifies the primary identifier of the process instance;
this will be set to "piid" .
-->
<element name="identifier" type="string" />
<!-- A list of zero or more "ProcessWithActions" structures -->
<element name="process" type="tns:tProcessWithActions" minOccurs="0" maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type describes a failed operation during a bulk process-related operation.
-->
<complexType name="FailedOperations">
<sequence>
<!-- The process instance ID -->
<element name="instanceId" 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 is used to return the results from performing a bulk operation on multiple process instances.
-->
<complexType name="ProcessBulkOperationResponse">
<complexContent>
<extension base="pref:Data">
<sequence>
<!-- A list of zero or more failed operations -->
<element name="failedOperations" type="tns:FailedOperations" minOccurs="0" maxOccurs="unbounded" />
<!-- A list of zero or more objects which contain the updated process details
after the operation has been performed. -->
<element name="processDetails" type="tns:ProcessDetails" minOccurs="0" maxOccurs="unbounded" />
<!-- Gives the count of instances upon which we successfully took the requested action -->
<element name="succeeded" type="int" minOccurs="0" maxOccurs="1"/>
<!-- Gives the count of instances upon which we failed to take the requested action -->
<element name="failed" type="int" minOccurs="0" maxOccurs="1"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type is used to represent the runtime error information associated with a single process instance.
-->
<complexType name="RuntimeError">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="instanceId" type="string" minOccurs="0" maxOccurs="1" />
<element name="taskId" type="string" minOccurs="0" maxOccurs="1" />
<element name="errorMessage" type="string" minOccurs="0" maxOccurs="1" />
<element name="javaTrace" type="string" minOccurs="0" maxOccurs="1" />
<element name="jsTrace" type="string" minOccurs="0" maxOccurs="1" />
<element name="twTrace" type="string" minOccurs="0" maxOccurs="1" />
<element name="timestamp" type="dateTime" minOccurs="0" maxOccurs="1" />
<element name="branchId" type="string" minOccurs="0" maxOccurs="1" />
<element name="snapshotId" type="string" minOccurs="0" maxOccurs="1" />
<element name="rootSnapshotId" type="string" minOccurs="0" maxOccurs="1" />
<element name="sourceGuid" type="string" minOccurs="0" maxOccurs="1" />
<element name="errorCode" type="string" minOccurs="0" maxOccurs="1" />
<element name="errorData" type="string" minOccurs="0" maxOccurs="1" />
<element name="BPMN2Style" type="boolean" minOccurs="0" maxOccurs="1" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type is used to return the runtime error detail for one or more instance id.
-->
<complexType name="RuntimeErrorResponse">
<complexContent>
<extension base="pref:Data">
<sequence>
<!-- A list of zero or more failed operations -->
<element name="failedOperations" type="tns:FailedOperations" minOccurs="0" maxOccurs="unbounded" />
<!-- A list of zero or more objects containing runtime error information for a process instance -->
<element name="runtimeErrors" type="tns:RuntimeError" minOccurs="0" maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type represents a list of currently executing processes
-->
<complexType name="CurrentlyExecuting">
<complexContent>
<extension base="pref:Data">
<sequence>
<!-- A list of processes IDs are currently executing -->
<element name="instanceIDs" type="string" minOccurs="0" maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<!-- A list of ad hoc activities. -->
<complexType name="adHocActivities">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="activities" type="activity:Activity" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
</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='prc:ProcessDetails' xmlns:prc='http://rest.bpm.ibm.com/v1/data/process'>
<creationTime>2011-04-28T03:23:42Z</creationTime>
<description></description>
<executionState>Active</executionState>
<state>STATE_RUNNING</state>
<lastModificationTime>2011-04-28T03:23:43Z</lastModificationTime>
<name>Employee Requisition for (54)</name>
<piid>54</piid>
<processTemplateID>25.8403dd37-e049-46f5-8952-b7a46f0d198f</processTemplateID>
<processTemplateName>HR Open New Position</processTemplateName>
<processAppName>BPM REST JUNIT TEST MODEL 1</processAppName>
<processAppAcronym>BPMRES1</processAppAcronym>
<snapshotName>1.0.1</snapshotName>
<snapshotID>2064.73dd1d1a-b533-46ef-ba79-c94cb3b0de87</snapshotID>
<dueDate>2011-05-12T03:23:42Z</dueDate>
<tasks>
<activationTime>2011-04-28T03:23:43Z</activationTime>
<clientTypes>IBM_WLE_Coach</clientTypes>
<completionTime xsi:nil='true' />
<containmentContextID>54</containmentContextID>
<description>Task: Submit requisition</description>
<displayName>Task: Submit requisition</displayName>
<dueTime>2011-04-28T04:23:43Z</dueTime>
<kind>KIND_PARTICIPATING</kind>
<lastModificationTime>2011-04-28T03:23:43Z</lastModificationTime>
<name>Submit job requisition</name>
<originator>tw_admin</originator>
<owner>tw_user</owner>
<priority>30</priority>
<startTime>2011-04-28T03:23:43Z</startTime>
<state>STATE_CLAIMED</state>
<tkiid>54</tkiid>
<piid>54</piid>
<status>Received</status>
<priorityName>Normal</priorityName>
<assignedTo>tw_user</assignedTo>
<assignedToType>user</assignedToType>
<data />
<serviceID>1.0ff035eb-a37b-4f2f-8ca1-7db695410d5d</serviceID>
</tasks>
<data />
<diagram>
<processAppID>2066.931b0053-02bd-4f47-ac72-4eb527457383</processAppID>
<step>
<ID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7e04</ID>
<name>Ad-hoc Event</name>
<type>activity</type>
<activityType>task</activityType>
<lane>Ad-hoc Processes</lane>
<x>226</x>
<y>31</y>
<color>Default</color>
<lines>
<to>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dfb</to>
<points></points>
</lines>
</step>
<step>
<ID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dfb</ID>
<name>End Ad-hoc Event</name>
<type>event</type>
<lane>Ad-hoc Processes</lane>
<x>361</x>
<y>34</y>
<color>Default</color>
</step>
<step>
<ID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7df2</ID>
<name>Start Ad-hoc Event</name>
<type>event</type>
<lane>Ad-hoc Processes</lane>
<x>117</x>
<y>33</y>
<color>Default</color>
<lines>
<to>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7e04</to>
<points></points>
</lines>
</step>
<step>
<ID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9</ID>
<name>Submit job requisition</name>
<type>activity</type>
<activityType>task</activityType>
<lane>Hiring Manager</lane>
<x>193</x>
<y>30</y>
<color>Blue</color>
<lines>
<to>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd6</to>
<points></points>
</lines>
<tokenID>2</tokenID>
<taskID>54</taskID>
</step>
<step>
<ID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd6</ID>
<name>Need GM approval?</name>
<type>gateway</type>
<lane>Hiring Manager</lane>
<x>325</x>
<y>45</y>
<color>Default</color>
<lines>
<to>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7da5</to>
<points></points>
</lines>
<lines>
<to>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d84</to>
<points></points>
</lines>
</step>
<step>
<ID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5</ID>
<name>Start</name>
<type>event</type>
<lane>Hiring Manager</lane>
<x>10</x>
<y>17</y>
<color>Default</color>
<lines>
<to>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9</to>
<points></points>
</lines>
</step>
<step>
<ID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dc2</ID>
<name>Submit Timer</name>
<type>event</type>
<lane>Hiring Manager</lane>
<x>13</x>
<y>117</y>
<color>Default</color>
<lines>
<to>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9</to>
<points></points>
</lines>
</step>
<step>
<ID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7db9</ID>
<name>Submit Message</name>
<type>event</type>
<lane>Hiring Manager</lane>
<x>59</x>
<y>50</y>
<color>Default</color>
<lines>
<to>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9</to>
<points></points>
</lines>
</step>
<step>
<ID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7da6</ID>
<name>GM approved?</name>
<type>gateway</type>
<lane>General Manager</lane>
<x>442</x>
<y>50</y>
<color>Default</color>
<lines>
<to>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d84</to>
<points></points>
</lines>
<lines>
<to>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d75</to>
<points></points>
</lines>
</step>
<step>
<ID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7da5</ID>
<name>Approve/reject requisition</name>
<type>activity</type>
<activityType>task</activityType>
<lane>General Manager</lane>
<x>317</x>
<y>35</y>
<color>Purple</color>
<lines>
<to>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7da6</to>
<points></points>
</lines>
</step>
<step>
<ID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d91</ID>
<name>End</name>
<type>event</type>
<lane>Human Resources</lane>
<x>752</x>
<y>48</y>
<color>Default</color>
</step>
<step>
<ID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d84</ID>
<name>Find job candidates</name>
<type>activity</type>
<lane>Human Resources</lane>
<x>618</x>
<y>28</y>
<color>Yellow</color>
<lines>
<to>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d91</to>
<points></points>
</lines>
</step>
<step>
<ID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d75</ID>
<name>Notify hiring manager</name>
<type>activity</type>
<lane>System</lane>
<x>532</x>
<y>35</y>
<color>Orange</color>
<lines>
<to>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d66</to>
<points></points>
</lines>
</step>
<step>
<ID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7d66</ID>
<name>Requisition terminiated</name>
<type>event</type>
<lane>System</lane>
<x>665</x>
<y>55</y>
<color>Default</color>
</step>
<lanes>
<name>Ad-hoc Processes</name>
<height>140</height>
<system>false</system>
</lanes>
<lanes>
<name>Hiring Manager</name>
<height>187</height>
<system>false</system>
</lanes>
<lanes>
<name>General Manager</name>
<height>163</height>
<system>false</system>
</lanes>
<lanes>
<name>Human Resources</name>
<height>169</height>
<system>false</system>
</lanes>
<lanes>
<name>System</name>
<height>140</height>
<system>true</system>
</lanes>
</diagram>
<actions>ACTION_ABORT_INSTANCE</actions>
<actions>ACTION_SUSPEND_INSTANCE</actions>
<actions>ACTION_ADD_COMMENT</actions>
<actions>ACTION_ADD_HELP_REQUEST</actions>
<actions>ACTION_RESPOND_HELP_REQUEST</actions>
<actions>ACTION_CHANGE_INSTANCE_DUEDATE</actions>
<actions>ACTION_MOVE_TOKEN</actions>
<actions>ACTION_INJECT_TOKEN</actions>
<actions>ACTION_VIEW_PROCESS_DIAGRAM</actions>
<actions>ACTION_VIEW_PROCESS_AUDIT</actions>
<actions>ACTION_CHANGE_CRITICAL_PATH</actions>
<actions>ACTION_DELETE_TOKEN</actions>
<actions>ACTION_ADD_DOCUMENT</actions>
<actions>ACTION_UPDATE_DOCUMENT</actions>
<actions>ACTION_DELETE_DOCUMENT</actions>
<actions>ACTION_FIRE_TIMER</actions>
<actions>ACTION_VIEW_CRITICAL_PATH</actions>
<actions>ACTION_VIEW_INSTANCE"</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 process 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: Process Resource