WebSphere Process Server, Version 6.2.0.1
Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, i5/OS, z/OS
GET /v1/processTemplates/query?{parameters}
Name | Value Type | Description |
---|---|---|
queryTableName | string | The name of the query table that is queried. For predefined query tables, this is the name of the predefined query table. For composite and supplemental query tables, this is prefix.name.
|
Name | Value Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
selectedAttributes | string | Comma-separated list of attributes, in uppercase letters, which specifies the attributes that are retrieved by the query. If no selected attributes are specified, all of the attributes that are defined on the query table are returned.
|
||||||
queryFilter | string | A query table condition language expression that performs additional filtering on the result set. All attributes defined on the query table can be referenced. Constants are available for some attributes of predefined query tables, for example, STATE_STARTED is available for attribute STATE on query table PROCESS_TEMPLATE (for available constants, see Database views for Business Process Choreographer).
|
||||||
sortAttributes | string | Comma-separated list of sort criteria applied to the list of returned process template entities. Each list entry has the form attribute [ASC|DESC] where ascending is the default.
|
||||||
offset | integer | Specifies the number of entities to be skipped in the result set.
|
||||||
size | integer | Limits the number of entities returned. The threshold setting might not be accurate.
|
||||||
admin | boolean | Administration authorization option specifying whether the request is performed by an administrator.
|
None.
The default content-type is application/json.
{ "description": "BFM Entity Result Set", "type": "object", "properties": { "identifier" : {"type": "string", "description": "Name of query table attribute identifying an entity." }, "queryTableName": {"type": "string", "description": "Name of the query table that is associated with this query result." }, "entityTypeName": {"type": "string", "description": "Type of entities that are returned as the result of the query." }, "attributeInfo": [ { "name": {"type": "string", "description": "Attribute name." }, "type": {"type": "string", "description": "Attribute type." }, "isArray": {"type": "boolean", "description": "Specifies whether the attribute has an array of values." }, "sourceAttribute": {"type": "string", "description": "The related query table and attribute which provides this attributes' information. Notation: queryTableName.attributeName." }, "sourceQueryTableIdentifier": {"type": "string", "description": "The identifier of the source attribute's table, as defined in the query table definition." } } ], "items": [ { "type": "object", "description": "Entities contained in this result set; list of attribute names and values, as selected by selectedAttributes, plus the entities' key (using its source attribute name)." } ] } }
The default content-type is application/json.
{ "description": "BFM Error Response", "type": "object", "properties": { "errorNumber": {"type": "string", "description":"Message ID of the exception." }, "errorMessage": {"type": "string", "description":"Message text of the exception." }, "programmersDetails": {"type": "object", "optional": true, "description":"Additional, exception details, for example, a stack trace." } } }
Code | Description |
---|---|
200 OK | Successful completion - requested data returned. Note that the list may be empty.
|
400 Bad Request | The parameters are not valid or they are missing. |
401 Unauthorized | The caller is not authorized for this request. |
500 Internal Server Error | A severe problem has occurred, programmer's details are provided. |
6.2.0.1
Parent Topic: Process Template Entity List Resource