IBM Business Process Manager, Version 8.5.5
GET /rest/bpm/wle/v1/performance/instance/{piid}
None
None
The default content type is application/json.
{ "description": "WLE Performance Instance Details",
"type": "object",
"properties":
{
"data": {"type": "[object]",
"description": "This field contains a list of zero or more tracked business data values that have changed."
[
{
"when": {"type": "string", "format": "date-time",
"description": "The timestamp when the field's value changed."
},
"stepID": {"type": "string",
"description": "The ID of the step in which the field's value changed."
},
"stepName": {"type": "string",
"description": "The name of the step in which the field's value changed."
},
"field": {"type": "string",
"description": "The name of the tracked field whose value changed."
},
"value": {"type": "object",
"description": "The new value of the field."
}
}
]
},
"progress": {"type": "[object]",
"description": "This field contains a list of zero or more tracked progress data values."
[
{
"stepID": {"type": "string",
"description": "The ID of the step."
},
"stepName": {"type": "string",
"description": "The name of the step in which the field's value changed."
},
"arrived": {"type": "string", "format": "date-time",
"description": "The timestamp when the step was reached."
},
"started": {"type": "string", "format": "date-time",
"description": "The timestamp when the step was started (if it was a task)."
},
"startedWho": {"type": "string",
"description": "The user name of the user that started the task (if it was a task)."
},
"finished": {"type": "string", "format": "date-time",
"description": "The timestamp when the step was finished (if it was a task)."
}
}
]
}
}
}
{
"status":"200",
"data":{
"data":[
{
"when":"2011-05-03T19:44:37Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5",
"stepName":"Start",
"field":"NODE_ID",
"value":"2"
},
{
"when":"2011-05-03T19:44:45Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9",
"stepName":"Submit job requisition",
"field":"NODE_ID",
"value":"3"
},
{
"when":"2011-05-03T19:44:45Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd6",
"stepName":"Need GM approval?",
"field":"NODE_ID",
"value":"4"
},
{
"when":"2011-05-03T19:44:37Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5",
"stepName":"Start",
"field":"department",
"value":""
},
{
"when":"2011-05-03T19:44:45Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9",
"stepName":"Submit job requisition",
"field":"department",
"value":"Finance"
},
{
"when":"2011-05-03T19:44:37Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5",
"stepName":"Start",
"field":"empNum",
"value":""
},
{
"when":"2011-05-03T19:44:45Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9",
"stepName":"Submit job requisition",
"field":"empNum",
"value":"2"
},
{
"when":"2011-05-03T19:44:37Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5",
"stepName":"Start",
"field":"employmentStatus",
"value":""
},
{
"when":"2011-05-03T19:44:45Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9",
"stepName":"Submit job requisition",
"field":"employmentStatus",
"value":"Full time"
},
{
"when":"2011-05-03T19:44:37Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5",
"stepName":"Start",
"field":"gmApproval",
"value":""
},
{
"when":"2011-05-03T19:44:37Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5",
"stepName":"Start",
"field":"hiringManager",
"value":""
},
{
"when":"2011-05-03T19:44:45Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9",
"stepName":"Submit job requisition",
"field":"hiringManager",
"value":"tw_admin"
},
{
"when":"2011-05-03T19:44:37Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5",
"stepName":"Start",
"field":"location",
"value":""
},
{
"when":"2011-05-03T19:44:45Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9",
"stepName":"Submit job requisition",
"field":"location",
"value":"Austin"
},
{
"when":"2011-05-03T19:44:37Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5",
"stepName":"Start",
"field":"reqDate",
"value":""
},
{
"when":"2011-05-03T19:44:45Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9",
"stepName":"Submit job requisition",
"field":"reqDate",
"value":"2011-05-03T19:44:38Z"
},
{
"when":"2011-05-03T19:44:37Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5",
"stepName":"Start",
"field":"reqNum",
"value":""
},
{
"when":"2011-05-03T19:44:45Z",
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9",
"stepName":"Submit job requisition",
"field":"reqNum",
"value":"1"
}
],
"progress":[
{
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9",
"stepName":"Submit job requisition",
"arrived":"2011-05-03T19:44:37Z",
"started":"2011-05-03T19:44:38Z",
"startedWho":"tw_admin",
"finished":"2011-05-03T19:44:44Z"
},
{
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd6",
"stepName":"Need GM approval?",
"arrived":"2011-05-03T19:44:45Z",
"started":null,
"startedWho":null,
"finished":null
},
{
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5",
"stepName":"Start",
"arrived":"2011-05-03T19:44:37Z",
"started":null,
"startedWho":null,
"finished":null
},
{
"stepID":"bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7da5",
"stepName":" Approve/reject requisition",
"arrived":"2011-05-03T19:44:45Z",
"started":null,
"startedWho":null,
"finished":null
}
]
}
}
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/search"
elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://rest.bpm.ibm.com/v1/data/search"
xmlns:common="http://rest.bpm.ibm.com/v1/data/common"
xmlns:pref="http://rest.bpm.ibm.com/v1/data/root">
<import schemaLocation="Common.xsd" namespace="http://rest.bpm.ibm.com/v1/data/common"/>
<import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root"/>
<!--
This type is used to return metadata related to searches.
-->
<complexType name="SearchMetaResult">
<complexContent>
<extension base="pref:Data">
<sequence>
<!--
A list of strings that represent the requested metadata.
This could be a list of all possible task status values,
a list of all possible priority values, etc.
The data returned in this structure will depend on the
type of metadata requested.
-->
<element name="result" type="string" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type is used to return metadata related to a search,
when the requested type of metadata is specified as "savedSearch".
-->
<complexType name="SearchMetaTypedResult">
<complexContent>
<extension base="pref:Data">
<sequence>
<!--
This field represents a list of zero or more saved searches.
-->
<element name="result" type="tns:TypedString" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type models an element of type string which also contains
a string attribute named "type".
This type is used to represent a saved search, where the
element value contains the name of the saved search,
and the "type" attribute indicates whether the saved search
is for tasks or processes.
-->
<complexType name="TypedString">
<simpleContent>
<extension base="string">
<attribute name="type" type="string" />
</extension>
</simpleContent>
</complexType>
<!--
This type contains the results of performing a search.
-->
<complexType name="SearchDetails">
<complexContent>
<extension base="pref:Data">
<sequence>
<!--
This field contains a list of zero or more Map objects.
Each Map object represents a single row in the search result data,
and contains a key/value pair for each column of data within the row.
-->
<element name="data" type="common:Map" minOccurs="0"
maxOccurs="unbounded" />
<!-- The name of the primary sort column -->
<element name="firstColumnSort" type="string" />
<!-- The name of the secondary sort column -->
<element name="secondColumnSort" type="string" />
<!--
A string which indicates how the search results are organized.
This will be set to "byTask" or "byInstance".
-->
<element name="organization" type="string" />
<!-- A list of columns that were added automatically to the query -->
<element name="autoColumns" type="string" minOccurs="0"
maxOccurs="unbounded" />
<!-- Begin index of returned results -->
<element name="offset" type="int" />
<!-- Number of results returned -->
<element name="size" type="int" />
<!-- Number of results requested -->
<element name="requestedSize" type="int" />
<!-- Number of results available -->
<element name="totalCount" type="int" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type represents the result from executing a performance query
-->
<complexType name="PerformanceSearchDetails">
<complexContent>
<extension base="pref:Data">
<sequence>
<!--
This field contains a list of zero or more Map objects.
Each Map object represents a single row in the search result data,
and contains a key/value pair for each column of data within the row.
-->
<element name="data" type="common:Map" minOccurs="0" maxOccurs="unbounded"/>
<!-- The summarized (rolled up) result -->
<element name="rollupResult" type="string" minOccurs="0"/>
<!-- The primary sort column -->
<element name="firstColumnSort" type="string"/>
<!-- The secondary sort column -->
<element name="secondColumnSort" type="string"/>
<!-- The names of columns that were automatically added to the query results -->
<element name="autoColumns" type="string" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type represents the result from performing a performance instance query.
-->
<complexType name="PerformanceInstanceDetails">
<complexContent>
<extension base="pref:Data">
<sequence>
<!-- A list of tracked business data values that have changed -->
<element name="data" type="tns:TrackedBusinessData" minOccurs="0" maxOccurs="unbounded"/>
<!-- A list of tracked progress data -->
<element name="progress" type="tns:TrackedProgress" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type represents a tracked business data element that has changed.
-->
<complexType name="TrackedBusinessData">
<sequence>
<!-- The timestamp when the field's value changed -->
<element name="when" type="dateTime"/>
<!-- The ID of the step in which the field's value changed -->
<element name="stepID" type="string"/>
<!-- The name of the step in which the field's value changed -->
<element name="stepName" type="string"/>
<!-- The name of the tracked field whose value changed -->
<element name="field" type="string"/>
<!-- The new value of the field -->
<element name="value" type="anyType"/>
</sequence>
</complexType>
<!--
This type represents tracked progress information for a step within a process instance
-->
<complexType name="TrackedProgress">
<sequence>
<!-- The ID of the step -->
<element name="stepID" type="string"/>
<!-- The name of the step -->
<element name="stepName" type="string"/>
<!-- The timestamp when the step was reached -->
<element name="arrived" type="dateTime"/>
<!-- The timestamp when the step was started (if it was a task) -->
<element name="started" type="dateTime" minOccurs="0"/>
<!-- The user name of the user that started the task (if it was a task) -->
<element name="startedWho" type="string" minOccurs="0"/>
<!-- The timestamp when the step was finished (if it was finished) -->
<element name="finished" type="dateTime" minOccurs="0"/>
</sequence>
</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='srch:PerformanceInstanceDetails' xmlns:srch='http://rest.bpm.ibm.com/v1/data/search'>
<data>
<when>2011-05-03T19:44:37Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5</stepID>
<stepName>Start</stepName>
<field>NODE_ID</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>2</value>
</data>
<data>
<when>2011-05-03T19:44:45Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9</stepID>
<stepName>Submit job requisition</stepName>
<field>NODE_ID</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>3</value>
</data>
<data>
<when>2011-05-03T19:44:45Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd6</stepID>
<stepName>Need GM approval?</stepName>
<field>NODE_ID</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>4</value>
</data>
<data>
<when>2011-05-03T19:44:37Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5</stepID>
<stepName>Start</stepName>
<field>department</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'></value>
</data>
<data>
<when>2011-05-03T19:44:45Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9</stepID>
<stepName>Submit job requisition</stepName>
<field>department</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Finance</value>
</data>
<data>
<when>2011-05-03T19:44:37Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5</stepID>
<stepName>Start</stepName>
<field>empNum</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'></value>
</data>
<data>
<when>2011-05-03T19:44:45Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9</stepID>
<stepName>Submit job requisition</stepName>
<field>empNum</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>2</value>
</data>
<data>
<when>2011-05-03T19:44:37Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5</stepID>
<stepName>Start</stepName>
<field>employmentStatus</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'></value>
</data>
<data>
<when>2011-05-03T19:44:45Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9</stepID>
<stepName>Submit job requisition</stepName>
<field>employmentStatus</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Full
time</value>
</data>
<data>
<when>2011-05-03T19:44:37Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5</stepID>
<stepName>Start</stepName>
<field>gmApproval</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'></value>
</data>
<data>
<when>2011-05-03T19:44:37Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5</stepID>
<stepName>Start</stepName>
<field>hiringManager</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'></value>
</data>
<data>
<when>2011-05-03T19:44:45Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9</stepID>
<stepName>Submit job requisition</stepName>
<field>hiringManager</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
</data>
<data>
<when>2011-05-03T19:44:37Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5</stepID>
<stepName>Start</stepName>
<field>location</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'></value>
</data>
<data>
<when>2011-05-03T19:44:45Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9</stepID>
<stepName>Submit job requisition</stepName>
<field>location</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Austin</value>
</data>
<data>
<when>2011-05-03T19:44:37Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5</stepID>
<stepName>Start</stepName>
<field>reqDate</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'></value>
</data>
<data>
<when>2011-05-03T19:44:45Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9</stepID>
<stepName>Submit job requisition</stepName>
<field>reqDate</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>2011-05-03T19:44:38Z</value>
</data>
<data>
<when>2011-05-03T19:44:37Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5</stepID>
<stepName>Start</stepName>
<field>reqNum</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'></value>
</data>
<data>
<when>2011-05-03T19:44:45Z</when>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9</stepID>
<stepName>Submit job requisition</stepName>
<field>reqNum</field>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>1</value>
</data>
<progress>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7de9</stepID>
<stepName>Submit job requisition</stepName>
<arrived>2011-05-03T19:44:37Z</arrived>
<started>2011-05-03T19:44:38Z</started>
<startedWho>tw_admin</startedWho>
<finished>2011-05-03T19:44:44Z</finished>
</progress>
<progress>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd6</stepID>
<stepName>Need GM approval?</stepName>
<arrived>2011-05-03T19:44:45Z</arrived>
</progress>
<progress>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7dd5</stepID>
<stepName>Start</stepName>
<arrived>2011-05-03T19:44:37Z</arrived>
</progress>
<progress>
<stepID>bpdid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7da5</stepID>
<stepName>Approve/reject requisition</stepName>
<arrived>2011-05-03T19:44:45Z</arrived>
</progress>
</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>
</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. |
| 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: Performance Instance Query Resource