Jump to

• Request
• Response
• Examples

Replace the collection of saved searches for the specified type

put

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

Replaces the collection of saved searches for the specified search type

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.

Body ()

Root Schema : UserSearchRequestCollection

Type: object

Show Source

• searches(optional): array searches
  An array of searches, each array entry is a client-defined JSON object.

{
    "properties":{
        "searches":{
            "type":"array",
            "description":"An array of searches, each array entry is a client-defined JSON object.",
            "items":{
                "$ref":"#/definitions/SavedSearchItem"
            }
        }
    }
}

Nested Schema : searches

Type: array

An array of searches, each array entry is a client-defined JSON object.

Show Source

• Array of: object SavedSearchItem

{
    "type":"array",
    "description":"An array of searches, each array entry is a client-defined JSON object.",
    "items":{
        "$ref":"#/definitions/SavedSearchItem"
    }
}

Nested Schema : SavedSearchItem

Type: object

Back to Top

Response

Supported Media Types

• application/json

204 Response

Preferences successfully updated.

403 Response

Forbidden.

Body ()

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.

Body ()

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"
    }
}

Back to Top

Examples

The following example shows how to replace the collection of saved searches for the specified type by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X PUT 
-u apicsadmin:password
-d @searches.json
https://example.com/apiplatform/administration/v1/preferences/user/searches/{type}/default

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

Example of Request Body

The following example shows the contents of the request body to replace the collection of saved searches in JSON format , included with the request above in a file named searches.json.

{
	"searches":[
        {
            "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\""
                }
            ]
        }
    ]
}

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 204 OK
Server: Oracle-Traffic-Director/12.2.1.2.0
Date: Thu, 05 Jan 2017 18:32:20 GMT
Content-type: application/json
X-oracle-dms-ecid: UShgJ1E3000000000
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.2.0
Transfer-encoding: chunked

Back to Top