REST interface for BPD-related resources - Search Resource - POST Method

Search for tasks or instances matching a query that can be provided:

as is in the body of the request (ad hoc search execution)
as a reference using the query parameter of this REST API (reusable search execution)

Sample method invocation

POST /rest/bpm/wle/v2/search[?query={string}][&size={integer}][&offset={integer}]

Usage Notes

When the query is provided using the query parameter, it can be extended / refined using another query in the body of the request. In this situation:

The datasource section of the query provided in the body is processed as following:
- if the datatype attribute is provided and is different than the one from the referenced query, an error is returned
- if the systemType attribute contains a subset of the ones listed by the referenced query it replaces the initial one. If it contains system types not in the referenced query then an error is returned.
- if a systemsFilter attribute is provided, then it replaces the one from the referenced query
The population section of the query provided in the body, if it not empty, replaces the one of the referenced query
The filters section of the query provided in the body is is processed as following:
- if an interaction attribute is provided, it replaces the one of the referenced query
- if a caseScope attribute is provided, it replaces the one of the referenced query
- if an v1_queryFilter attribute is provided, it replaces the one of the referenced query
- if an v1_searchFilter attribute is provided, it replaces the one of the referenced query
- if any other filters are provided, they are added to the existing list: only items that match all the provided filters will be returned
The output section of the query is merged with the one from the referenced query: any provided attribute replaces the original one. Note: to request no stats from the results, use stats: {} in the output extension.

Parameters

Optional parameters

Name	Value Type	Description
query	string	id of a reusable search query.
size	integer	Specifies the maximum number of results to be returned. Use this parameter with the offset parameter to provide paging in the results. This value, when provided, will override any existing size value defined in the output section of the search query. Default value : 25
offset	integer	Specifies the index (origin 0) of the first result to return. Offset 0 refers to the first result; offset 1 to the second one, and so on. Use this parameter with the size parameter to provide paging in the results. Default value : 0

Request content

A search query.

The default content type is application/json.

MIME type: application/json

Example content

{
    "datasource": {
      "datatype": "TASKS",
      "systemTypes": [
        "Process",
        "BPEL"
      ]
    },
    "population": {
      "target": "SELF"
    },
    "filters": {
      "interaction": "all",
      "v1_conditions": []
    },
    "output": {
      "includeAllBusinessData": false,
      "usersFullName": true,
      "sort": [
        {
          "field": "taskDueDate",
          "order": "ASC"
        },
        {
          "field": "taskPriority",
          "order": "DESC"
        }
      ],
      "alphabeticalSort": false,
      "size": 25,
      "stats": {
        "type": "Basic"
      }
    }
  }

Response content

The search response

The default content type is application/json.

MIME type: application/json

Schema

{
	"title": "JSON search response",
	"description": "A JSON search response",
	"type": "object",
	"properties": {
		"datatype": {
			"description": "The type of data that has been retrieved",
			"required": false,
			"type": "string",
			"enum": ["TASKS",
			"INSTANCES"]
		},
		"systems": {
			"description": "The systems against which the search was run",
			"type": "array",
			"items": {
				"type": "object",
				"properties": {
					"systemID": {
						"type": "string",
						"description": "ID of the IBM Business Automation Workflow system that the request was sent to."
					},
					"index": {
						"type": "string",
						"description": "The name of the Federated Data Repository index in which the data for this system is indexed."
					},
					"restUrlPrefix": {
						"type": "string",
						"description": "The prefix to use for processes in this federated IBM Business Automation Workflow system."
					},
					"taskCompletionUrlPrefix": {
						"type": "string",
						"description": "The prefix to use for services in this federated IBM Business Automation Workflow system."
					},
					"version": {
						"type": "object",
						"description": "The product version on this federated IBM Business Automation Workflow system."
					},
					"systemType": {
						"type": "string",
						"description": "The type of this federated IBM Business Automation Workflow system, either \"SYSTEM_TYPE_WLE\", \"SYSTEM_TYPE_WPS\" or \"SYSTEM_TYPE_CASE\"."
					},
					"portalSupportUrlPrefix": {
						"type": "string",
						"description": "The prefix to use for access to the portal for this federated IBM Business Automation Workflow system (BPD only)."
					},
					"targetObjectStoreName": {
						"type": "string",
						"description": "The name of the target object store for this system (Case only)."
					},
					"statusCode": {
						"type": "integer",
						"description": "HTTP status code that was returned from this IBM Business Automation Workflow system."
					}
				}
			}
		},
		"queryExecuteTime": {
			"type": "string",
			"description": "The date and time at which the search was performed"
		},
		"requestedSize": {
			"type": "number",
			"description": "The maximum number of results that were requested in the response"
		},
		"responseSize": {
			"type": "number",
			"description": "The actual number of results in the response"
		},
		"offset": {
			"type": "integer",
			"description": "The offset into the entire result set where this query response has begin."
		},
		"totalCount": {
			"type": "integer",
			"description": "The total number of results in the Federated Data Repository"
		},
		"fieldsMetadata": {
			"type": "array",
			"description": "Metadata describing the fields included in the results",
			"items": {
				"type": "object",
				"properties": {
					"name": {
						"type": "string",
						"description": "The name of the field"
					},
					"type": {
						"type": "string",
						"description": "The type of the field"
					},
					"isArray": {
						"type": "boolean",
						"description": "true if the field is an array, false otherwise"
					},
					"isBusinessData": {
						"type": "boolean",
						"description": "true if the field is a business data, false otherwise"
					},
					"source": {
						"type": "string",
						"description": "The name of the field in the Federated Data Repository index"
					}
				}
			}
		},
		"results": {
			"type": "array",
			"description": "The results",
			"items": {
				"type": "object"
			}
		},
		"stats": {
			"type": "object",
			"description": "Statistics that were requested in the search query"
		}
	}
}

Error Response content

None

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Successful operation.
400 Bad Request	Bad Request
403 Forbidden	The caller is not authorized to perform this operation.
404 Not Found	The saved search definition does not exist.
406 Not Acceptable	The requested content type or content encoding is not supported.
409 Conflict	Bad Request. See the details provided.
415 Unsupported Media Type	The content type or content encoding of the request is not supported.
500 Internal Server Error	Internal Server Error. See the details provided.

Available since

24.0.0.0

Parent Topic: Search Resource