Update a Plan's state
put
/apiplatform/management/v1/plans/{planId}/state
Updates the state of the {planId} 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 : UpdatePlanStateRequest
Type:
Show Source
object
-
state:
string
The updated Plan state.
-
stateComments(optional):
string
Comments about the Plan's state.
Response
Supported Media Types
- application/json
204 Response
The Plan's state 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 update the state of a 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"
-H "Content-Type:application/json"
-d @update-state.json
https://example.com/apiplatform/management/v1/plans/{planId}/state
{planId}
is the unique Id for a plan. To retrieve available API Ids, see Get plans.
Example of Request Body
The following shows an example of the request body in JSON format, included with the request above in a file named update-state.json
.
{ "state": "ACTIVE", "stateComments": "Activated the plan" }
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: Tue, 06 Feb 2018 09:46:05 GMT X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-000196d0 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0