Get quick search results in a list format
GET {{baseUrl}}/api/searches/results?type=257&limit=100
Use the stored results of the Quick Search engine to return search results and display them as a list. The Quick Search engine periodically indexes the metadata and stores the results in memory, making Quick Search very fast but with results that may not be the most recent. You obtain the authorization token needed to execute the request using POST /auth/login; you obtain the project ID using GET /projects. You pass the authorization token and the project ID in the request header. You specify the search criteria using query parameters in the request; criteria can include the root folder ID, the type of object, whether to return ancestors of the object, a search pattern such as Begins With or Exactly, and the certified status of the object being searched for. You use the offset and limit query parameters to control paging behavior. The offset parameter specifies where to start returning search results, and the limit parameter specifies how many results to return.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
name | string | Value the search pattern is set to, which will be applied to the names of object types being searched. For example, search for all report objects (type) whose name begins with (pattern) B (name). | |
pattern | number | Pattern to search for, such as Begin With or Exactly. Possible values are defined in EnumDSSXMLSearchTypes. 2 is for "Exactly". | |
type | number | Type of object to be searched, such as Folder, Attribute or User. Possible values are defined in EnumDSSObjectType. To specify multiple types in API explorer, simply specify them with newline delimiter. 257 is for custom groups object subtype. | |
limit | number | Maximum number of items returned for a single request. Use -1 for no limit. | |
root | string | Folder ID of the root folder where the search will be performed. | |
getAncestors | boolean | Specifies whether to return the list of ancestors for each object | |
offset | number | Starting point within the collection of returned search results. Used to control paging behavior. | |
certifiedStatus | string | Defines a search criteria based on the certified status of the object | |
isCrossCluster | boolean | Perform search in all unique projects across the cluster, this parameter only takes affect for I-Server with cluster nodes. | |
viewMedia | null | ViewMedia of object to be searched, such as Dossier or Document. Possible values are defined in ViewMedia. To specify multiple viewMedias in API explorer, simply specify them with newline delimiter. | |
projectId | null | Project IDs where the search will be performed. X-MSTR-ProjectID will be ignored and isCrossCluster will be regarded as true if the project IDs are specified. | |
result.hidden | null | Filter the result based on the 'hidden' field of objects. If not passed, no filtering is applied. | |
fields | null | Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-MSTR-AuthToken | string | (Required) Authorization token | |
X-MSTR-ProjectID | string | Project ID |