Jump to

• Request
• Response
• Examples

Update the default search name for the specified search type

put

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

Updates the default search name 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 : UserDefaultSearchName

Type: object

Show Source

• defaultSearchName(optional): string
  Default Value: false

  The name of the default search. Empty string if default search not set.

{
    "type":"object",
    "properties":{
        "defaultSearchName":{
            "type":"string",
            "description":"The name of the default search. Empty string if default search not set.",
            "default":"false"
        }
    }
}

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 update the name of the default saved search for a resource 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 @search-name.json
https://example.com/apiplatform/administration/v1/preferences/user/searches/{type}/default

Where {type} is a resource type, like api, application, gateway, etc.

Example of Request Body

The following example shows the contents of the request body to change the name of the default saved search in JSON format, included with the request above in a file named searche-name.json.

{
	"defaultSearchName":"weather forecast APIs"
}

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