IBM Business Process Manager, Version 8.5.6
GET /rest/bpm/federated/v1/tasks/query/{queryName}/attributes
None
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."
},
"federationResult":[
{
"systemID":{
"type":"string",
"description":"ID of the IBM BPM system that the request was sent to."
},
"statusCode":{
"type":"integer",
"description":"HTTP status code that was returned from this IBM BPM system."
},
"id":{
"type":"string",
"description":"The ID of this federated IBM BPM system"
},
"indexName":{
"type":"string",
"description":"The name of the index for this federated IBM BPM system."
},
"systemType":{
"type":[
"string"
],
"description":"The type of this federated IBM BPM system, either 'SYSTEM_TYPE_WLE', or 'SYSTEM_TYPE_WPS'."
},
"version":{
"type":"object",
"description":"The product version on this federated IBM BPM system."
}
}
],
"totalSystemTypeCount":{
"type":"integer",
"description":"The total number of different system types processed."
},
"items":[
{
"systemType":"either 'SYSTEM_TYPE_WLE' or 'SYSTEM_TYPE_WPS'",
"totalAttributesCount":nn,
"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 and attribute that provides the information about the attributes."
},
"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."
}
},
{
},
{
}
]
}
]
}
}
{
"federationResult": [{
"systemID": "2a4a7cd6-20fa-4c14-8fdb-7bcbea89cee2",
"statusCode": 200,
"id": "com.ibm.bpm.pfs.ds.federatedSystem_84",
"indexName": "lsystem02",
"systemType": "SYSTEM_TYPE_WLE",
"version": "8.5.6.0"
},
{
"systemID": "ca920a9e-f809-4076-9485-a05b6877f5cb",
"statusCode": 200,
"id": "com.ibm.bpm.pfs.ds.federatedSystem_83",
"indexName": "localsys01",
"systemType": "SYSTEM_TYPE_WLE",
"version": "8.5.6.0"
}],
"totalSystemTypeCount": 1,
"items": [{
"systemType": "SYSTEM_TYPE_WLE",
"totalAttributesCount": 30,
"attributeInfo": [{
"content": "task.state.key",
"sourceAttribute": "task.state.key",
"name": "STATE",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "instance.snapshotname.string",
"sourceAttribute": "instance.snapshotname.string",
"name": "SNAPSHOT_NAME",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "instance.snapshotid.key",
"sourceAttribute": "instance.snapshotid.key",
"name": "SNAPSHOT_ID",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "task.duetime.date",
"sourceAttribute": "task.duetime.date",
"name": "DUE",
"sourceQueryTableIdentifier": "n\/a",
"type": "date",
"isArray": false
},
{
"content": "task.status.key",
"sourceAttribute": "task.status.key",
"name": "STATUS",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "instance.processinstancename.string",
"sourceAttribute": "instance.processinstancename.string",
"name": "PI_DISPLAY_NAME",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "task.userid.key",
"sourceAttribute": "task.userid.key",
"name": "OWNER",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "instance.piid.key",
"sourceAttribute": "instance.piid.key",
"name": "PI_PIID",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "task.description.string",
"sourceAttribute": "task.description.string",
"name": "TAD_DESCRIPTION",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "instance.processinstancename.string",
"sourceAttribute": "instance.processinstancename.string",
"name": "PI_NAME",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "task.originator.key",
"sourceAttribute": "task.originator.key",
"name": "ORIGINATOR",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "process.processappacronym.string",
"sourceAttribute": "process.processappacronym.string",
"name": "PROCESS_APP_ACRONYM",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "task.isatrisk.boolean",
"sourceAttribute": "task.isatrisk.boolean",
"name": "IS_AT_RISK",
"sourceQueryTableIdentifier": "n\/a",
"type": "boolean",
"isArray": false
},
{
"content": null,
"sourceAttribute": null,
"name": "TASK.TKIID",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "task.kind.key",
"sourceAttribute": "task.kind.key",
"name": "KIND",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "task.completiontime.date",
"sourceAttribute": "task.completiontime.date",
"name": "COMPLETED",
"sourceQueryTableIdentifier": "n\/a",
"type": "date",
"isArray": false
},
{
"content": "process.processtemplateid.key",
"sourceAttribute": "process.processtemplateid.key",
"name": "PT_PTID",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "task.displayname.string",
"sourceAttribute": "task.displayname.string",
"name": "TAD_DISPLAY_NAME",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "task.atrisktime.date",
"sourceAttribute": "task.atrisktime.date",
"name": "AT_RISK_TIME",
"sourceQueryTableIdentifier": "n\/a",
"type": "date",
"isArray": false
},
{
"content": "task.groupid.key",
"sourceAttribute": "task.groupid.key",
"name": "GROUP_ID",
"sourceQueryTableIdentifier": "n\/a",
"type": "number",
"isArray": false
},
{
"content": "task.name.string",
"sourceAttribute": "task.name.string",
"name": "NAME",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "task.userid.key",
"sourceAttribute": "task.userid.key",
"name": "USER_ID",
"sourceQueryTableIdentifier": "n\/a",
"type": "number",
"isArray": false
},
{
"content": "task.priority.key",
"sourceAttribute": "task.priority.key",
"name": "PRIORITY",
"sourceQueryTableIdentifier": "n\/a",
"type": "number",
"isArray": false
},
{
"content": null,
"sourceAttribute": null,
"name": "PROCESS_INSTANCE.PIID",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "task.containmentcontextid.key",
"sourceAttribute": "task.containmentcontextid.key",
"name": "CONTAINMENT_CTX_ID",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "task.tkiid.key",
"sourceAttribute": "task.tkiid.key",
"name": "TKIID",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
},
{
"content": "task.activationtime.date ",
"sourceAttribute": "task.activationtime.date ",
"name": "ACTIVATED",
"sourceQueryTableIdentifier": "n\/a",
"type": "date",
"isArray": false
},
{
"content": "task.assignedtoroledisplayname.string",
"sourceAttribute": "task.assignedtoroledisplayname.string",
"name": "ASSIGNED_TO_ROLE_DISPLAY_NAME",
"sourceQueryTableIdentifier": "n\/a",
"type": "string",
"isArray": false
}]
}]
}
| Code | Description |
|---|---|
| 200 OK | The request completed successfully; the requested data was 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 occurred. |
| 503 Service Unavailable | The federated request could not be delivered to individual federation targets. |
| 504 Gateway Timeout | The federated response has partial content because of missing individual responses. |
8.5.6
Parent Topic: Task Instance Query Attributes Resource