Update Plan Identity
put
/apiplatform/management/v1/plans/{planId}/identity
Updates the name, version or vanityName of the plan.
Users requesting this resource must be assigned the Plan Manager role and must be issued the Manage Plan grant for the specified plan.
Request
Supported Media Types
- application/json
Path Parameters
-
planId: string
A unique ID referencing a specific plan.
Root Schema : UpdatePlanIdentityRequest
Type:
Show Source
object
-
name(optional):
string
The Plan's name.
-
vanityName(optional):
string
The updated Plan vanity name. Plan vanity names can include only letters, digits, spaces, underscores, hyphens, and periods.
-
version(optional):
string
The Plan's version.
Response
Supported Media Types
- application/json
204 Response
The Plan's identity was updated.
400 Response
Bad request, indicates a problem with the input parameters.
Root Schema : Error
Type:
Show Source
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
403 Response
Forbidden.
Root Schema : Error
Type:
Show Source
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
Unexpected error.
Root Schema : Error
Type:
Show Source
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 change the name, version or vanityName of the plan by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X PUT
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/plans/{planId}/identity
{planId}
is the unique Id for a plan. To retrieve available API Ids, see Get plans.
Example of Request Body
The following example provides a request body for updating a plan.
{ "name":MyGoldplan, "version":"v2", "vanityName":"myGold" }
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 204 No Content Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Mon, 13 Mar 2017 09:51:17 GMT X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-000196fb X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0