Search for cubes
GET {{baseUrl}}/api/searches/results?type=776
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 | null | Pattern to search for, such as Begin With or Exactly. Possible values are defined in EnumDSSXMLSearchTypes. |
Default value : 4
|
| root | null | | Folder ID of the root folder where the search will be performed. |
| 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. |
| 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.
|
| getAncestors | null | | Specifies whether to return the list of ancestors for each object
Default value : false |
| offset | null | | Starting point within the collection of returned search results. Used to control paging behavior.
Default value : 0 |
| limit | null | | Maximum number of items returned for a single request. Used to control paging behavior. Use -1 for no limit.
Default value : -1 |
| certifiedStatus | null | | Defines a search criteria based on the certified status of the object
Available values : ALL, NOT_CERTIFIED_ONLY, CERTIFIED_ONLY, OFF
Default value : ALL |
| isCrossCluster | null | | Perform search in all unique projects across the cluster, this parameter only takes affect for I-Server with cluster nodes.
Default value : false |
| 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 | ||
X-MSTR-ProjectID | string |