Get search results in a list format
GET {{baseUrl}}/api/metadataSearches/results?searchId={{rd_searchId}}
Get search results previously stored in an instance in IServer memory and display them in a list. 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 identify the search results by specifying the search ID as a query parameter in the request; you obtain the search ID using POST /metadataSearches/results. 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.
Body
PARAM
| Key | Datatype | Required | Description |
searchId
|
string | (Required) Search ID (identifies the results of a previous search stored in IServer memory) | |
offset
|
number | Starting point within the collection of returned search results. Used to control paging behavior. | |
limit
|
number | Maximum number of items returned for a single request. Used to control paging behavior. Use -1 for no limit. | |
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 | Curl curl -X GET 'baseUrl/api/metadataSearches/results?searchId=rd_searchId?searchId=rd_searchId&offset=0&limit=-1&fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' ENDPOINTS |