IBM Business Process Manager, Version 8.5.5

REST interface for BPD-related resources - Performance Query Resource - GET Method

Use this method to perform a custom search against the performance server.

Sample method invocation

GET /rest/bpm/wle/v1/performance/query?filter={string}[&columns={string}][&condition={string}][&sort={string}][&secondSort={string}][&onlyRollup={string}][&rollupRule={string}]

Usage Notes

Parameters

Required parameters
NameValue TypeDescription
filter string
A string representing a filter to be used with the search. A filter string is specified using the form: "<column-name>|<value>". For example: 
bpd|<bpd-id-value>
A performance query is performed against a particular snapshot of a BPD; therefore, the user must specify both a "bpd" and "snapshot" filter.

For example: 

...v1/performance/query?filter=bpd|<my-bpd-id>&filter=snapshot|<my-shapshot-id
Optional parameters
NameValue TypeDescription
columns string
A comma-separated list of column names that should be returned by the search. Note that the actual columns returned by the search are limited to those that are tracked in the performance server. For tasks, you should be able to use the taskId returned by the search and then retrieve the details associated with that task by using the v1/task/{taskId} API.

Valid column names are: "taskId", "instanceId", "bpdName", "taskSubject", "taskArrived", "taskStarted", "taskFinished", plus any columns associated with tracked business data. If this parameter is not specified, then the following columns are returned by default: "taskId", "instanceId", "bpdName" and "taskSubject".
condition string
A simple conditional expression to be used with the query. An expression of the form <field>|<value> means "if <field> equals <value>". An expression of the form <field>|<operation>|<value> means "if <field> <operation> <value>".

For example, A|1 means "if A equals 1", and B|GREATER|2 means "if B is greater than 2". This parameter can be specified multiple times within the query string in order to specify multiple conditions which are logically "ANDed" together. The valid operations are: "EQUALS", "NOT_EQUALS", "GREATER_EQUAL", "GREATER", "LESS_EQUAL", "LESS", "CONTAINS", "STARTS_WITH". All the listed column names mentioned above in the discussion of the "columns" parameter can be used in a conditional expression.

sort string
The name of the column on which to base the primary sort of the search results.
secondSort string
The name of the column on which to base the secondary sort of the search results.
onlyRollup string
Indicates which type of data should be returned in the result.
ValueDescription
true
Only the summarized data is returned.
false
Only the raw data is returned. This is the default.
rollupRule string
A string which indicates how to summarize the raw data. The value specified for the parameter is a string of the form "<fieldName>|<function>", where "<fieldname>" is the name of a column returned by the search, and "<function>" is the function to be applied to that column. Valid functions are: COUNT, MAX, MIN, AVG, SUM. Note that for columns of type string, only the COUNT function is valid. For columns of type DATE only the COUNT, MIN and MAX functions are valid.

Request content

None

Response content

Performance search details (PerformanceSearchDetails complexType).

The default content type is application/json.

MIME type: application/json


+ View schema
{  "description": "WLE Performance Search Details", 
   "type": "object",
   "properties":
   { 
      "data": {"type": "[object]",
         "description": "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."
      },
      "rollupResult": {"type": "string",
         "description": "The summarized (rolled up) result."
      },
      "firstColumnSort": {"type": "string",
         "description": "The primary sort column."
      },
      "secondColumnSort": {"type": "string",
         "description": "The secondary sort column."
      },
      "autoColumns": {"type": "[string]",
         "description": "A list of zero or more names of columns that were automatically added to the search results."
      }
   }
}
+ View example content
{
   "status":"200",
   "data":{
      "data":[
         {
            "taskId":"130",
            "bpdName":"HR Open New Position",
            "taskSubject":"Submit job requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"131",
            "bpdName":"HR Open New Position",
            "taskSubject":" Approve/reject requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"132",
            "bpdName":"HR Open New Position",
            "taskSubject":"Submit job requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"133",
            "bpdName":"HR Open New Position",
            "taskSubject":" Approve/reject requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"134",
            "bpdName":"HR Open New Position",
            "taskSubject":"Submit job requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"136",
            "bpdName":"HR Open New Position",
            "taskSubject":" Approve/reject requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"135",
            "bpdName":"HR Open New Position",
            "taskSubject":"Submit job requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"137",
            "bpdName":"HR Open New Position",
            "taskSubject":" Approve/reject requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"138",
            "bpdName":"HR Open New Position",
            "taskSubject":"Submit job requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"140",
            "bpdName":"HR Open New Position",
            "taskSubject":" Approve/reject requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"139",
            "bpdName":"HR Open New Position",
            "taskSubject":"Submit job requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"141",
            "bpdName":"HR Open New Position",
            "taskSubject":" Approve/reject requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"142",
            "bpdName":"HR Open New Position",
            "taskSubject":"Submit job requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"144",
            "bpdName":"HR Open New Position",
            "taskSubject":" Approve/reject requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"143",
            "bpdName":"HR Open New Position",
            "taskSubject":"Submit job requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"145",
            "bpdName":"HR Open New Position",
            "taskSubject":" Approve/reject requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"146",
            "bpdName":"HR Open New Position",
            "taskSubject":"Submit job requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"148",
            "bpdName":"HR Open New Position",
            "taskSubject":" Approve/reject requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"147",
            "bpdName":"HR Open New Position",
            "taskSubject":"Submit job requisition",
            "hiringManager":"tw_admin"
         },
         {
            "taskId":"149",
            "bpdName":"HR Open New Position",
            "taskSubject":" Approve/reject requisition",
            "hiringManager":"tw_admin"
         }
      ],
      "rollupResult":null,
      "autoColumns":[
         "bpdName",
         "hiringManager",
         "instanceId",
         "taskId",
         "taskSubject"
      ]
   }
}

MIME type: application/xml


+ View schema
<?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>
+ View example content
<?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:PerformanceSearchDetails' xmlns:srch='http://rest.bpm.ibm.com/v1/data/search'>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>130</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Submit job requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>131</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Approve/reject requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>132</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Submit job requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>133</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Approve/reject requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>134</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR
					Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Submit
					job requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>136</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR
					Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Approve/reject requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>135</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Submit job requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>137</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Approve/reject requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>138</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Submit job requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>140</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Approve/reject requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>139</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Submit job requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>141</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Approve/reject requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>142</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Submit job requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>144</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Approve/reject requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>143</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Submit job requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>145</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Approve/reject requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>146</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Submit job requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>148</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Approve/reject requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>147</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Submit job requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <data>
      <item key='taskId'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>149</value>
      </item>
      <item key='bpdName'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>HR Open New Position</value>
      </item>
      <item key='taskSubject'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Approve/reject requisition</value>
      </item>
      <item key='hiringManager'>
        <value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
      </item>
    </data>
    <autoColumns>bpdName</autoColumns>
    <autoColumns>hiringManager</autoColumns>
    <autoColumns>instanceId</autoColumns>
    <autoColumns>taskId</autoColumns>
    <autoColumns>taskSubject</autoColumns>
  </data>
</bpm:ResponseData>

MIME type: application/x-javascript

Error Response content

Detailed error information.

The default content type is application/json.

MIME type: application/json


+ View schema
{  "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."
      }
   }
}

MIME type: application/xml


+ View schema
<?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>

MIME type: application/x-javascript

Status codes

The method returns one of the following status codes:
CodeDescription
200 OKSuccess completion.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
406 Not AcceptableThe requested content type or content encoding is not supported.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available since

7.5.0

Parent Topic: Performance Query Resource



Feedback

This information center is powered by Eclipse technology. (http://www.eclipse.org)