Get the name of the default search for the specified type
/apiplatform/administration/v1/preferences/user/searches/{type}/default
Returns the name of the default search for the specified type. The response also contains HATEOAS links to related operations.
All authenticated users can access this resource.
Request
- application/json
-
type: string
Specifies the search type, valid values are:
api
,application
,gateway
,service_account
androle
.
-
fields(optional): array
Collection Format:
csv
Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values. - links(optional): array
Response
- application/json
200 Response
object
-
defaultSearchName(optional):
string
Default Value:
false
The name of the default search. Empty string if default search not set.
object
-
links(optional):
array links
Includes 'canonical'.
object
-
href(optional):
string
Link href.
-
method(optional):
string
HTTP Operation GET, POST, PUT
-
rel(optional):
string
Link relation.
403 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
500 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
Examples
The following example shows how to retrieve the default saved search for a resource type by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -i -X GET -u apicsadmin:password https://example.com/apiplatform/administration/v1/preferences/user/searches/{type}/default
Where {type}
is a resource type, like api
, application
, gateway
, etc.
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 200 OK Server: Oracle-Traffic-Director/12.2.1.2.0 Date: Wed, 26 Jul 2017 17:10:11 GMT Transfer-encoding: chunked Content-type: application/json X-oracle-dms-ecid: kKFfG1P0000000000 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc-config Proxy-agent: Oracle-Traffic-Director/12.2.1.2.0 Content-encoding: gzip Vary: accept-encoding
Example of Response Body
The following example shows the contents of the response body in JSON format, including details about each saved search for the resource type and HATEOAS links to related operations.
{ "defaultSearchName": "weather", "links": [ { "templated": "true", "method": "GET", "rel": "canonical", "href": "https://example.com:443/apiplatform/administration/v1/preferences/user/searches/api/default" }, { "templated": "true", "method": "PUT", "rel": "edit", "href": "https://example.com:443/apiplatform/administration/v1/preferences/user/searches/api/default" } ] }