Search for a dossier to be published

GET {{baseUrl}}/api/searches/results?name=dossier&type=55

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

| | 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. This allows client to selectively retrieve part of the response model. If specified, extra filtering will be applied, and for top-level object (if root model is an array, each array element), only the listed fields will be kept in the response. e.g. "id,elements" means to keep only the "id" field and the whole "elements" array field, omitting all other fields of top-level response model. |

HEADERS