Search the metadata and store an instance of search results
POST {{baseUrl}}/api/metadataSearches/results?name=Sales
Search the metadata for objects in a specific project that match specific search criteria, and save the results in IServer memory. Saving the results in memory supports incremental fetch by other requests. 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 search domain, the type of object, and a search pattern such as Begins With or Exactly. The response includes an instance ID for the search results stored in memory, which can be used as the search ID by other requests.
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. | |
domain | number | Domain where the search will be performed, such as Local or Project. Possible values are defined in EnumDSSXMLSearchDomain. | |
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 EnumDSSXMLObjectTypes. | |
usesObject | null | Constrain the search to only return objects which use the given object. The value should be: object Id;object type, for example: 'E02FE6DC430378A8BBD315AA791FC580;3'. It is not allowed to use both 'usesObject' and 'usedByObject' in one request. | |
usesRecursive | boolean | Control the Intelligence server to also find objects that use the given objects indirectly. Default value is false. | |
usesOneOf | boolean | Control the Intelligence server to also find objects that use one of or all of given objects indirectly. Default value is false. | |
usedByRecursive | boolean | Control the Intelligence server to also find objects that are used by the given objects indirectly. Default value is false. | |
usedByOneOf | boolean | Control the Intelligence server to also find objects that are used by one of or all of given objects indirectly. Default value is false. | |
visibility | string | 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 |
RESPONSES
status: OK
{"id":"B9272468E64273EF6BE84D93BDF183C6","totalItems":245}