GET /rest/bpm/wle/v1/taskTemplates/query/{queryName}/attributes[?processAppName={string}]
| Name | Value Type | Description |
|---|---|---|
| processAppName | string | Name of the process application, used for additional filtering. This parameter is intended for future use and has currently no effect on the returned query metadata.
|
None
The default content type is application/json.
{ "description": "WLE Query Attribute List",
"type": "object",
"properties":
{ "identifier" : {"type": "string"},
"query": {"type": "string",
"description": "Query name."
},
"displayName": {"type": "string",
"description": "Query display name (localized)."
},
"description": {"type": "string",
"description": "Query description (localized)."
},
"kind": {"type": "string",
"description": "Query kind.",
"enum":
[
"SAVED_SEARCH"
]
},
"authorizationType": {"type": "string",
"description": "Type of authorization required for performing queries using this query.",
"enum":
[
"INSTANCE_BASED",
"ROLE_BASED"
]
},
"entityTypeName": {"type": "string",
"description": "Type of entities that are returned as the result of the query."
},
"keyAttribute": {"type": "string",
"description": "Name of the attribute uniquely identifying an entity."
},
"locales": {"type": ["string"],
"description": "List of locales defined for the display names and descriptions of this query."
},
"sortAttributes": {
[
{
"name": {"type": "string",
"description": "Sort attribute name."
},
"sortOrder": {"type": "string",
"description": "Sort order.",
"enum":
[
"ASC",
"DESC"
]
}
}
], "optional": true,
"description": "Ordered list of default sort attribute names."
},
"size": {"type": "integer", "optional": true,
"description": "Default number of entities that are returned as the result of the query."
},
"items":
[
{ "name": {"type": "string",
"description": "Attribute name."
},
"displayName": {"type": "string",
"description": "Attribute display name (localized)."
},
"description": {"type": "string",
"description": "Attribute description (localized)."
},
"type": {"type": "string",
"description": "Attribute type."
},
"isArray": {"type": "boolean",
"description": "Specifies whether the attribute has an array of values."
},
"isFilterable": {"type": "boolean", "optional": true,
"description": "Specifies whether the attribute can be used as a filter attribute (default: true)."
},
"isSortable": {"type": "boolean", "optional": true,
"description": "Specifies whether the attribute can be used as a sort attribute (default: true)."
},
"sourceAttribute": {"type": "string",
"description": "The related query and attribute which provides this attributes' information."
},
"content": {"type": "string",
"description": "A string that identifies attributes with a well-known value range."
},
"sourceQueryTableIdentifier": {"type": "string", "optional": true,
"description": "The ID of the source attribute's table, as defined in the query table definition."
}
}
]
}
}
{
"status":"200",
"data":{
"identifier":"name",
"query":"IBM.DEFAULTALLTASKDEFLIST_75",
"displayName":"All",
"description":"",
"kind":"SAVED_SEARCH",
"authorizationType":"ROLE_BASED",
"entityTypeName":"TASK_TEMPL",
"keyAttribute":"TASK_TEMPL.TKTID",
"locales":[
],
"sortAttributes":[
],
"size":null,
"items":[
{
"name":"SNAPSHOT_NAME",
"displayName":"Snapshot",
"description":"",
"type":"STRING",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKDEFLIST_75.favorite.getSnapshotName",
"content":"TASK_TEMPL.SNAPSHOT_NAME",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"SNAPSHOT_ID",
"displayName":"Snapshot ID",
"description":"",
"type":"STRING",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKDEFLIST_75.favorite.getSnapshotId",
"content":"TASK_TEMPL.SNAPSHOT_ID",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"TATD_DISPLAY_NAME",
"displayName":"Name",
"description":"",
"type":"STRING",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKDEFLIST_75.favorite.getDisplayName",
"content":"TASK_TEMPL_DESC.DISPLAY_NAME",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"TOP_LEVEL_TOOLKIT_ACRONYM",
"displayName":"Top-level toolkit acronym",
"description":"",
"type":"STRING",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKDEFLIST_75.favorite.getVersionDetails.getShortName",
"content":"TASK_TEMPL.TOP_LEVEL_TOOLKIT_ACRONYM",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"TAT_STATE",
"displayName":"Status",
"description":"",
"type":"STRING",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKDEFLIST_75.favorite.getEnabled",
"content":"TASK_TEMPL.STATE",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"TAT_TKTID",
"displayName":"Definition ID",
"description":"",
"type":"ID",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKDEFLIST_75.favorite.getId",
"content":"TASK_TEMPL.TKTID",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"PROCESS_APP_ACRONYM",
"displayName":"Process App acronym",
"description":"",
"type":"STRING",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKDEFLIST_75.favorite.getVersionDetails.getShortName",
"content":"TASK_TEMPL.PROCESS_APP_ACRONYM",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"TOP_LEVEL_TOOLKIT_NAME",
"displayName":"Top-level toolkit",
"description":"",
"type":"STRING",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKDEFLIST_75.favorite.getVersionDetails.getProjectName",
"content":"TASK_TEMPL.TOP_LEVEL_TOOLKIT_NAME",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"TAT_KIND",
"displayName":"Kind",
"description":"",
"type":"STRING",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKDEFLIST_75.special_mapping",
"content":"TASK_TEMPL.KIND",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"IS_DEFAULT",
"displayName":"Default",
"description":"",
"type":"BOOLEAN",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKDEFLIST_75.favorite.getSnapshot.getIsDefault",
"content":"TASK_TEMPL.IS_DEFAULT",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"TAT_NAME",
"displayName":"Definition name",
"description":"",
"type":"STRING",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKDEFLIST_75.favorite.getName",
"content":"TASK_TEMPL.NAME",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"IS_TIP",
"displayName":"Tip",
"description":"",
"type":"BOOLEAN",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKDEFLIST_75.favorite.getTip",
"content":"TASK_TEMPL.IS_TIP",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"TRACK_NAME",
"displayName":"Track",
"description":"",
"type":"STRING",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKDEFLIST_75.n/a",
"content":"TASK_TEMPL.TRACK_NAME",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"PROCESS_APP_NAME",
"displayName":"Process App",
"description":"",
"type":"STRING",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKDEFLIST_75.favorite.getVersionDetails.getProjectName",
"content":"TASK_TEMPL.PROCESS_APP_NAME",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"TATD_DESCRIPTION",
"displayName":"Description",
"description":"",
"type":"STRING",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKDEFLIST_75.favorite.getDisplayName",
"content":"TASK_TEMPL_DESC.DESCRIPTION",
"sourceQueryTableIdentifier":"n/a"
}
]
}
}
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/query"
elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://rest.bpm.ibm.com/v1/data/query" xmlns:cmn="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 a list of saved queries. -->
<complexType name="QueryList">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="identifier" type="string" />
<!-- This is a list of zero or more saved queries -->
<element name="items" type="tns:QueryItem" minOccurs="0"
maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<!-- This type represents a single saved query. -->
<complexType name="QueryItem">
<sequence>
<!-- The name of the query -->
<element name="name" type="string" />
<!-- The display name associated with the query; this will contain the
same value as the name -->
<element name="displayName" type="string" />
<!-- The query's description -->
<element name="description" type="string" />
<!-- The "kind" associated with the query; this will be set to "SAVED_SEARCH" -->
<element name="kind" type="string" />
<!-- The id number associated with a saved search -->
<element name="savedSearchID" type="long" nillable="true" />
<!-- The autorization type associated with the query; this will be set
to "INSTANCE_BASED" -->
<element name="authorizationType" type="string" />
<!-- This field indicates the type of objects are returned by this query.
This will be one of "PROCESS_INSTANCE", "TASK", "TASK_TEMPL". -->
<element name="entityTypeName" type="string" />
<!-- This field specifies the name of the attribute which serves as the
key for the objects returned by this query. -->
<element name="keyAttribute" type="string" />
<!-- not used -->
<element name="locales" type="string" minOccurs="0"
maxOccurs="unbounded" />
<!-- The pre-selected sort attributes for the query. -->
<element name="sortAttributes" type="tns:SortAttribute"
minOccurs="0" maxOccurs="unbounded" />
<!-- The pre-predefined size of items to be retrieved. -->
<element name="size" type="integer" nillable="true" />
</sequence>
</complexType>
<!-- This type is used to return the stats for rows (items) in the result
set that would be returned by executing a particular saved query. -->
<complexType name="QueryStats">
<sequence>
<!-- The size of the result set (number of rows) -->
<element name="total" type="integer" />
<element name="open" type="integer" />
<element name="onTrack" type="integer" />
<element name="atRisk" type="integer" />
<element name="overdue" type="integer" />
<!-- comment out these two elements since not used by any code, so it means they are not part of
response since day one.
<element name="active" type="integer" />
<element name="completed" type="integer" />
-->
</sequence>
</complexType>
<!-- This type is used to return the set of attributes (data columns) that
would be returned as the result of executing a particular saved query. -->
<complexType name="QueryAttributes">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="identifier" type="string" />
<!-- The name of the query associated with this set of attributes -->
<element name="query" type="string" />
<!-- The diplay name of the query; this is the same value as the name -->
<element name="displayName" type="string" />
<!-- not used -->
<element name="description" type="string" />
<!-- The "kind" associated with the query; this will be set to "SAVED_SEARCH" -->
<element name="kind" type="string" />
<!-- The autorization type associated with the query. This will be set
to one of: "INSTANCE_BASED", "ROLE_BASED" -->
<element name="authorizationType" type="string" />
<!-- This field indicates the type of objects returned by this query.
This will be one of "PROCESS_INSTANCE", "TASK", "TASK_TEMPL". -->
<element name="entityTypeName" type="string" />
<!-- This field specifies the name of the attribute which serves as
the key for the objects returned by this query. -->
<element name="keyAttribute" type="string" />
<!-- not used -->
<element name="locales" type="string" minOccurs="0"
maxOccurs="unbounded" />
<!-- The pre-selected sort attributes for the query. -->
<element name="sortAttributes" type="tns:SortAttribute"
minOccurs="0" maxOccurs="unbounded" />
<!-- The pre-predefined size of items to be retrieved. -->
<element name="size" type="integer" nillable="true" />
<!-- A list of zero or more attributes -->
<element name="items" type="tns:QueryAttributeItem"
minOccurs="0" maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<!-- This type describes a single attribute that would be returned as the
result of executing a particular saved query. -->
<complexType name="QueryAttributeItem">
<sequence>
<!-- The attribute name -->
<element name="name" type="string" />
<!-- A localized display name for the attribute -->
<element name="displayName" type="string" />
<!-- not used -->
<element name="description" type="string" />
<!-- The attribute's datatype -->
<element name="type" type="string" />
<!-- not used; set to false -->
<element name="isArray" type="boolean" />
<!-- The related query and attribute which provides this attributes' information -->
<element name="sourceAttribute" type="string" />
<!-- A string that identifies attributes with a well-known value range -->
<element name="content" type="string" />
<!-- The ID of the source attribute's table, as defined in the query table
definition -->
<element name="sourceQueryTableIdentifier" type="string" />
<!-- Specifies whether the attribute can be used as a sort attribute -->
<element name="isSortable" type="boolean" minOccurs="0"
maxOccurs="1" default="true" />
<!-- Specifies whether the attribute can be used as a filter attribute -->
<element name="isFilterable" type="boolean" minOccurs="0"
maxOccurs="1" default="true" />
</sequence>
</complexType>
<!-- This type is used to return the results of executing a particular saved
query. -->
<complexType name="QueryResultSet">
<complexContent>
<extension base="pref:Data">
<sequence>
<!-- The key attribute associated with this set of query results. This
will depend on the type of objects being returned by the query, and will
be one of: "TASK.TKIID", "TASK_TEMPL.TKTID", "PROCESS_INSTANCE.PIID" -->
<element name="identifier" type="string" />
<!-- The name of the saved query for which these results were generated -->
<element name="query" type="string" />
<!-- This field indicates the type of objects are returned by this query.
This will be one of "PROCESS_INSTANCE", "TASK", "TASK_TEMPL". -->
<element name="entityTypeName" type="string" />
<!-- The list of attributes (columns) returned by this query -->
<element name="attributeInfo" type="tns:AttributeInfo"
minOccurs="0" maxOccurs="unbounded" />
<!-- The offset value that was specified on the original request. This
value represents the index (within the overall query result set) of the first
item being returned. -->
<element name="offset" type="integer" />
<!-- The number of items being returned -->
<element name="size" type="integer" />
<!-- The number of items requested in the original request -->
<element name="requestedSize" type="integer" />
<!-- Total number of results -->
<element name="totalCount" type="integer" />
<!-- True if total number of results exceeds a search limit and is actually
unknown -->
<element name="countLimitExceeded" type="boolean" />
<!-- Specifies the search limit used if any or 0 if it's not set -->
<element name="countLimit" type="integer" />
<!-- The set of results returned by this query. This is represented
as a list of zero or more "items", where each item represents a row in the
result set. Each item is represented by a Map, where the Map contains the
various columns of data associated with that item (row). -->
<element name="items" type="cmn:Map" minOccurs="0"
maxOccurs="unbounded" />
<element name="stats" type="tns:QueryStats" />
</sequence>
</extension>
</complexContent>
</complexType>
<!-- This type contains the information for a single attribute that is returned
as the result of executing a saved query. -->
<complexType name="AttributeInfo">
<sequence>
<!-- The name of the attribute -->
<element name="name" type="string" />
<!-- The datatype of the attribute -->
<element name="type" type="string" />
<!-- A string that identifies attributes with a well-known value range -->
<element name="content" type="string" />
<!-- not used; set to false -->
<element name="isArray" type="boolean" />
<!-- The related query and attribute which provides this attributes' information -->
<element name="sourceAttribute" type="string" />
<!-- The ID of the source attribute's table, as defined in the query table
definition -->
<element name="sourceQueryTableIdentifier" type="string" />
</sequence>
</complexType>
<!-- This type is used to return the number of rows (items) in the result
set that would be returned by executing a particular saved query. -->
<complexType name="QueryResultSetCount">
<complexContent>
<extension base="pref:Data">
<sequence>
<!-- The size of the result set (number of rows) -->
<element name="count" type="integer" />
</sequence>
</extension>
</complexContent>
</complexType>
<!-- A container used to describe a sort attribute by its name and sort
order. -->
<complexType name="SortAttribute">
<sequence>
<element name="name" type="string" />
<element name="sourceAttribute" type="string" />
<element name="sortOrder" type="string" /> <!-- ASC, DESC -->
</sequence>
</complexType>
<complexType name="ProcessInstanceCount">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="overview" type="cmn:Map"/>
</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' xmlns:qry='http://rest.bpm.ibm.com/v1/data/query' xsi:type='qry:QueryAttributes'>
<identifier>name</identifier>
<query>IBM.DEFAULTALLTASKDEFLIST_75</query>
<displayName>All</displayName>
<description></description>
<kind>SAVED_SEARCH</kind>
<authorizationType>ROLE_BASED</authorizationType>
<entityTypeName>TASK_TEMPL</entityTypeName>
<keyAttribute>TASK_TEMPL.TKTID</keyAttribute>
<size xsi:nil='true' />
<items>
<name>SNAPSHOT_NAME</name>
<displayName>Snapshot</displayName>
<description></description>
<type>STRING</type>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKDEFLIST_75.favorite.getSnapshotName</sourceAttribute>
<content>TASK_TEMPL.SNAPSHOT_NAME</content>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</items>
<items>
<name>SNAPSHOT_ID</name>
<displayName>Snapshot ID</displayName>
<description></description>
<type>STRING</type>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKDEFLIST_75.favorite.getSnapshotId</sourceAttribute>
<content>TASK_TEMPL.SNAPSHOT_ID</content>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</items>
<items>
<name>TATD_DISPLAY_NAME</name>
<displayName>Name</displayName>
<description></description>
<type>STRING</type>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKDEFLIST_75.favorite.getDisplayName</sourceAttribute>
<content>TASK_TEMPL_DESC.DISPLAY_NAME</content>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</items>
<items>
<name>TOP_LEVEL_TOOLKIT_ACRONYM</name>
<displayName>Top-level toolkit acronym</displayName>
<description></description>
<type>STRING</type>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKDEFLIST_75.favorite.getVersionDetails.getShortName</sourceAttribute>
<content>TASK_TEMPL.TOP_LEVEL_TOOLKIT_ACRONYM</content>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</items>
<items>
<name>TAT_STATE</name>
<displayName>Status</displayName>
<description></description>
<type>STRING</type>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKDEFLIST_75.favorite.getEnabled</sourceAttribute>
<content>TASK_TEMPL.STATE</content>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</items>
<items>
<name>TAT_TKTID</name>
<displayName>Definition ID</displayName>
<description></description>
<type>ID</type>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKDEFLIST_75.favorite.getId</sourceAttribute>
<content>TASK_TEMPL.TKTID</content>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</items>
<items>
<name>PROCESS_APP_ACRONYM</name>
<displayName>Process App acronym</displayName>
<description></description>
<type>STRING</type>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKDEFLIST_75.favorite.getVersionDetails.getShortName</sourceAttribute>
<content>TASK_TEMPL.PROCESS_APP_ACRONYM</content>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</items>
<items>
<name>TOP_LEVEL_TOOLKIT_NAME</name>
<displayName>Top-level toolkit</displayName>
<description></description>
<type>STRING</type>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKDEFLIST_75.favorite.getVersionDetails.getProjectName</sourceAttribute>
<content>TASK_TEMPL.TOP_LEVEL_TOOLKIT_NAME</content>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</items>
<items>
<name>TAT_KIND</name>
<displayName>Kind</displayName>
<description></description>
<type>STRING</type>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKDEFLIST_75.special_mapping</sourceAttribute>
<content>TASK_TEMPL.KIND</content>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</items>
<items>
<name>IS_DEFAULT</name>
<displayName>Default</displayName>
<description></description>
<type>BOOLEAN</type>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKDEFLIST_75.favorite.getSnapshot.getIsDefault</sourceAttribute>
<content>TASK_TEMPL.IS_DEFAULT</content>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</items>
<items>
<name>TAT_NAME</name>
<displayName>Definition name</displayName>
<description></description>
<type>STRING</type>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKDEFLIST_75.favorite.getName</sourceAttribute>
<content>TASK_TEMPL.NAME</content>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</items>
<items>
<name>IS_TIP</name>
<displayName>Tip</displayName>
<description></description>
<type>BOOLEAN</type>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKDEFLIST_75.favorite.getTip</sourceAttribute>
<content>TASK_TEMPL.IS_TIP</content>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</items>
<items>
<name>TRACK_NAME</name>
<displayName>Track</displayName>
<description></description>
<type>STRING</type>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKDEFLIST_75.n/a</sourceAttribute>
<content>TASK_TEMPL.TRACK_NAME</content>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</items>
<items>
<name>PROCESS_APP_NAME</name>
<displayName>Process App</displayName>
<description></description>
<type>STRING</type>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKDEFLIST_75.favorite.getVersionDetails.getProjectName</sourceAttribute>
<content>TASK_TEMPL.PROCESS_APP_NAME</content>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</items>
<items>
<name>TATD_DESCRIPTION</name>
<displayName>Description</displayName>
<description></description>
<type>STRING</type>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKDEFLIST_75.favorite.getDisplayName</sourceAttribute>
<content>TASK_TEMPL_DESC.DESCRIPTION</content>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</items>
</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 | Successful completion - requested data returned.
|
| 404 Not Found | The query 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. |
| Release | Description |
|---|---|
| 7.5.1 | The returned query attribute entries contains new properties:
|
| 7.5.1 | A new parameter has been added to this method to allow additional filtering by using a process application name.
|
7.5.0
Parent Topic: Task Template Query Attributes Resource