REST interface for BPD-related resources - Reusable Search Query Resource - GET Method

Get a specific reusable search query.

Sample method invocation

GET /rest/bpm/wle/v2/search/queries/{id}

Usage Notes

Use this method to retrieve a reusable search query from its id.

Parameters

None

Request content

None

Response content

A reusable search query.

The default content type is application/json.

MIME type: application/json

Example content

{
  "jsonFormat": "v2",
  "metadata": {
    "owner": {
      "id": "uid=fdadmin,o=defaultWIMFileBasedRealm"
    },
    "creator": {
      "id": "uid=fdadmin,o=defaultWIMFileBasedRealm"
    },
    "lastUpdateDate": "2025-06-25T09:21:34.976Z",
    "lastUpdater": {
      "id": "uid=fdadmin,o=defaultWIMFileBasedRealm"
    },
    "name": "my tasks list v2",
    "description": "A search query that returns my tasks list",
    "sharing": {
      "shared": false
    },
    "creationDate": "2025-06-25T09:21:34.976Z"
  },
  "output": {
    "alphabeticalSort": false,
    "size": 25,
    "includeAllBusinessData": false,
    "stats": {
      "type": "Basic"
    },
    "usersFullName": true,
    "sort": [
      {
        "field": {
          "kind": "System",
          "name": "taskDueDate"
        },
        "order": "ASC"
      },
      {
        "field": {
          "kind": "Instance",
          "name": "variable1"
        },
        "order": "DESC"
      },
      {
        "field": {
          "kind": "Task",
          "name": "variable2"
        },
        "order": "DESC"
      }
    ],
    "fields": [
      {
        "kind": "System",
        "name": "instanceProcessApp"
      },
      {
        "kind": "Instance",
        "name": "amount"
      },
      {
        "kind": "Task",
        "name": "awaitingReview"
      }
    ]
  },
  "datasource": {
    "datatype": "TASKS",
    "systemFilter": {
      "excludes": [],
      "includes": []
    },
    "systemTypes": [
      "Process",
      "BPEL"
    ]
  },
  "id": "3",
  "filters": {
    "json_query": {
      "and": [
        {
          "field": {
            "kind": "System",
            "name": "taskPriority"
          },
          "value": 50,
          "operator": "LessThan"
        },
        {
          "field": {
            "kind": "Instance",
            "name": "amount"
          },
          "value": 10000,
          "operator": "GreaterThan"
        }
      ]
    },
    "interaction": "all"
  },
  "population": {
    "target": "SELF"
  }
}

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.
500 Internal Server Error	Internal Server Error. See the details provided.

Available since

24.0.0.0

Parent Topic: Reusable Search Query Resource