REST API for the Administration Service in Oracle API Platform Cloud Service

Get the collection of saved searches for the for the specified type

get

/apiplatform/administration/v1/preferences/user/searches/{type}

Returns a collection of saved searches for the specified type. The response also contains HATEOAS links to related operations.

All authenticated users can access this resource.

Request

Supported Media Types

application/json

Path Parameters

type: string

Specifies the search type, valid values are: api, application, gateway, service_account and role.

Query Parameters

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.

[0]: string

{
    "name":"fields",
    "in":"query",
    "description":"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.",
    "required":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "collectionFormat":"csv"
}

links(optional): array

Collection Format: csv

Filter the specified link rel's.

[0]: string

{
    "name":"links",
    "in":"query",
    "description":"Filter the specified link rel's.",
    "required":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "collectionFormat":"csv"
}

Response

Supported Media Types

application/json

200 Response

The user's saved searches for the specified type.

Root Schema : UserSearchCollectionResponse

Match All

Show Source

object UserSearchCollectionResponse-allOf[0]
object CollectionResponseFeature
object LinksResponseFeature

{
    "allOf":[
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "description":"User saved searches. Array of JSON Objects defined by client.",
                    "items":{
                        "$ref":"#/definitions/SavedSearchItem"
                    }
                }
            }
        },
        {
            "$ref":"#/definitions/CollectionResponseFeature"
        },
        {
            "$ref":"#/definitions/LinksResponseFeature"
        }
    ]
}

Nested Schema : UserSearchCollectionResponse-allOf[0]

Type: object

Show Source

items(optional): array items

User saved searches. Array of JSON Objects defined by client.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"User saved searches. Array of JSON Objects defined by client.",
            "items":{
                "$ref":"#/definitions/SavedSearchItem"
            }
        }
    }
}

Nested Schema : CollectionResponseFeature

Type: object

Show Source

count(optional): integer(int32)

The number of items in this collection.

{
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of items in this collection."
        }
    }
}

Nested Schema : LinksResponseFeature

Type: object

Show Source

links(optional): array links

Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : items

Type: array

User saved searches. Array of JSON Objects defined by client.

Show Source

Array of: object SavedSearchItem

{
    "type":"array",
    "description":"User saved searches. Array of JSON Objects defined by client.",
    "items":{
        "$ref":"#/definitions/SavedSearchItem"
    }
}

Nested Schema : SavedSearchItem

Type: object

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

Nested Schema : HATEOASLink

Type: object

Show Source

href(optional): string

Link href.
method(optional): string

HTTP Operation GET, POST, PUT
rel(optional): string

Link relation.

{
    "type":"object",
    "properties":{
        "method":{
            "type":"string",
            "description":"HTTP Operation GET, POST, PUT"
        },
        "rel":{
            "type":"string",
            "description":"Link relation."
        },
        "href":{
            "type":"string",
            "description":"Link href."
        }
    }
}

403 Response

Forbidden.

Root Schema : Error

Type: object

Show Source

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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Root Schema : Error

Type: object

Show Source

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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Examples

The following example shows how to retrieve details about saved searches 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}

Where {type} is a resource type, like api, application, gateway, service, or service_account.

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.

{
    "count": 2,
    "links": [
        {
            "templated": "true",
            "method": "GET",
            "rel": "self",
            "href": "https://example.com:443/apiplatform/administration/v1/preferences/user/searches/api"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "canonical",
            "href": "https://example.com:443/apiplatform/administration/v1/preferences/user/searches/api"
        },
        {
            "templated": "true",
            "method": "PUT",
            "rel": "edit",
            "href": "https://example.com:443/apiplatform/administration/v1/preferences/user/searches/api"
        }
    ],
    "items": [
        {
            "scim": "( name sw \"Weather\" or name co \" Weather\" or name co \".Weather\" or name co \"-Weather\" )",
            "name": "weather",
            "conditions": [
                {
                    "scim": "( name sw \"Weather\" or name co \" Weather\" or name co \".Weather\" or name co \"-Weather\" )",
                    "id": "name",
                    "value": "\"Weather\""
                }
            ]
        },
        {
            "scim": "(( name sw \"Real\" or name co \" Real\" or name co \".Real\" or name co \"-Real\" ) or ( name sw \"Estate\" or name co \" Estate\" or name co \".Estate\" or name co \"-Estate\" ))",
            "name": "Real Estate",
            "conditions": [
                {
                    "scim": "(( name sw \"Real\" or name co \" Real\" or name co \".Real\" or name co \"-Real\" ) or ( name sw \"Estate\" or name co \" Estate\" or name co \".Estate\" or name co \"-Estate\" ))",
                    "id": "name",
                    "value": "\"Real Estate\""
                }
            ]
        }
    ]
}