GET /rest/bpm/federated/htm/v1/tasks/queries[?domain={string}|systemID={string}][&all={boolean}][&processAppName={string}][&content={string}]| Name | Value Type | Description |
|---|---|---|
| domain | string | Name of the domain containing the IBM Business Process Manager (BPEL runtime and/or BPD runtime) systems that host the distributed resource (mutually exclusive with the systemID parameter). |
| systemID | string | ID of the IBM Business Process Manager (BPEL runtime and/or BPD runtime) system hosting the resource (mutually exclusive with the domain parameter). If specified then this request is treated like any other request for a resource hosted by a single system, that is, the request and the response are just routed, and no pre/post-processing of parameters and results is performed by the federation layer. |
| Name | Value Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| all | boolean | If set to true then metadata is also returned for queries that are not supported by all systems in the federation domain.
|
||||||
| processAppName | string | Name of the process application, used for additional filtering.
|
||||||
| content | string | Specifies a comma-separated list of content values; only queries with the specified content values are returned. For example: TASK.STATE or TASK.NAME.
|
None.
The default content-type is application/json.
{ "description": "Queries",
"type": "object",
"properties":
{ "identifier" : {"type": "string"},
"federationResult":
[
{ "systemID": {"type": "string",
"description": "ID of the individual system the request was sent to."
},
"statusCode": {"type": "integer",
"description": "HTTP Status Code returned from this system."
},
"errorNumber": {"type": "string", "optional": true,
"description":"Message ID of the exception."
},
"errorMessage": {"type": "string", "optional": true,
"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."
}
}
],
"items":
[
{ "name": {"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":
[
"FEDERATED"
]
},
"authorizationType": {"type": "string",
"description": "Type of authorization required for performing queries using this query.",
"enum":
[
"INSTANCE_BASED",
"MIXED"
]
},
"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."
},
"systemIDs": {"type": "[string]",
"description": "List of IDs of the systems supporting the query."
}
}
]
}
}
The default content-type is application/json.
{ "description": "Error Response",
"type": "object",
"properties":
{ "federationResult":
[
{ "systemID": {"type": "string",
"description": "ID of the individual system the request was sent to."
},
"statusCode": {"type": "integer",
"description": "HTTP Status Code returned from this system."
},
"errorNumber": {"type": "string", "optional": true,
"description": "Message ID of the exception."
},
"errorMessage": {"type": "string", "optional": true,
"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."
},
"status": {"type": "string", "optional": true,
"description": "Status of the request."
},
"exceptionType": {"type": "string", "optional": true,
"description": "Type of 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."
},
"status": {"type": "string", "optional": true,
"description": "Status of the request."
},
"exceptionType": {"type": "string", "optional": true,
"description": "Type of the exception."
}
}
}
| 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. |
| 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. |
| 503 Service Unavailable | The federated request could not be delivered to individual federation targets. |
| 504 Gateway Timeout | The federated response has partial content due to missing individual responses. |
| Release | Description |
|---|---|
| 7.5.1 | New parameters have been added to this method.
|
| 7.5.1 | The returned query metadata entries contain a new property:
|
7.5
Parent Topic: Task Instance Queries Resource