Get a Saved Search
get
/rest/v19/searchResources/{resourceVarName}/{searchId}
Use this endpoint to retrieve the specified saved search.
Request
Path Parameters
-
resourceVarName(required): string
The unique variable name to identify the process.
-
searchId(required): number
The unique id of the search.
Response
200 Response
The response for getting a single saved search.
Root 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:
descAllowed Values:[ "asc", "desc" ]
Nested Schema : links
Type:
Show Source
array-
Array of:
object reference links
Title:
reference linksReference links for the Parent, Self, Children and Related as applicable
Nested Schema : reference links
Type:
objectTitle:
reference linksReference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
URL to the related objectURL to the related object -
name:
string
-
rel:
string
Title:
Link Relationship to the current objectDefault Value:selfLink Relationship to the current object
404 Response
Search with id not be found
Examples
The following example shows how to retrieve the specified saved search by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET -H "Authorization: Bearer <token>" -H "Accept: application/json" https://sitename.oracle.com/rest/v19/searchResources/commerceDocumentsOraclecpqoTransaction/38678835
Response Body Sample
{
"_entity": "Quote",
"name": "Vision Quotes In Process",
"description": "",
"updatable": true,
"deletable": true,
"queryUuid": 38678835,
"savedSearchNumber": 38678835,
"default": false,
"shared": false,
"active": true,
"userId": 4119220,
"userName": "superuser",
"userKey": "ecde4a3c-1924-488f-821c-d4defcfafce3",
"fields": [
"transactionID_t",
"version_t",
"version_number_versionTransaction_t",
"_customer_t_company_name",
"transactionName_t",
"status_t",
"totalContractValue_t",
"owner_t",
"createdDate_t",
"lastUpdatedDate_t",
"totalAnnualValue_t"
],
"orderBy": [
"lastUpdatedDate_t:desc"
],
"mongoQuery": {
"$and": [{
"_customer_t_company_name": {
"$regex": "Vision"
}
}, {
"status_t": {
"$eq": "OPEN"
}
}
]
},
"searchType": "user_defined_search",
"siteLevelDefault": false,
"userLevelDefault": false,
"hidden": false,
"links": [{
"rel": "self",
"href": "http://sitename.oracle.comrest/v16/searchResources/commerceDocumentsOraclecpqoTransaction/38678835",
"name": "self"
}, {
"rel": "canonical",
"href": "http://sitename.oracle.comrest/v16/searchResources/commerceDocumentsOraclecpqoTransaction/38678835",
"name": "canonical"
}, {
"rel": "parent",
"href": "http://sitename.oracle.comrest/v16/searchResources/commerceDocumentsOraclecpqoTransaction",
"name": "parent"
}
]
}