Get Saved Searches
get
/rest/v16/searchResources/{resourceVarName}
Use this endpoint to retrieve a list of saved searches for the specified resource.
Request
Path Parameters
-
resourceVarName(required): string
The unique variable name to identify the process.
Query Parameters
-
limit: integer
The pagination limit.
-
offset: integer
The pagination offset.
-
showAll: string
Parameter specifying whether to show all searches or the hidden onesAllowed Values:
[ "ALL", "HIDDEN", "VISIBLE", "INACTIVE" ]
Response
Default Response
The response for getting the saved searches.
Root Schema : SavedSearchItemModelResponse
Type:
Show Source
object
-
count:
integer
-
hasMore:
boolean
Default Value:
false
-
items:
array items
-
limit:
integer
-
links:
array links
-
offset:
integer
-
totalResutls:
integer
Nested Schema : links
Type:
Show Source
array
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : savedSearchItem
Type:
Show Source
object
-
active:
boolean
-
aggregations:
object SavedSearchGroupByModel
-
default:
boolean
-
deletable:
string
-
description:
string
Example:
This is a dummy description
-
fields:
array fields
- hidden: boolean
-
links:
array links
-
mongoQuery:
object mongoQuery
Additional Properties Allowed: additionalProperties
-
name:
string
Example:
savedSearchDummy
-
orderBy:
array orderBy
-
queryUuid:
number
-
savedSearchNumber:
number
-
searchType:
string
Allowed Values:
[ "_user_defined_search", "_my_quotes_search", "_my_approval_search" ]
- shared: boolean
-
siteLevelDefault:
boolean
-
updatable:
boolean
-
userId:
number
-
userKey:
string
-
userLevelDefault:
boolean
-
userName:
string
Nested Schema : SavedSearchGroupByModel
Type:
Show Source
object
-
attribute:
string
-
sort:
string
Default Value:
desc
Allowed Values:[ "asc", "desc" ]
Nested Schema : links
Type:
Show Source
array
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : reference links
Type:
object
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
URL to the related object
URL to the related object -
name:
string
-
rel:
string
Title:
Link Relationship to the current object
Default Value:self
Link Relationship to the current object