Update a Plan's publication state
/apiplatform/management/v1/plans/{planId}/publication
Publishes or unpublishes the {planId} Plan. Send a state of PUBLISHED to publish to or UNPUBLISHED to unpublish from the Developer Portal.
Users requesting this resource must be assigned the Plan Manager role and must be issued the Manage Plan grant for the specified plan.
Request
- application/json
-
planId: string
A unique ID referencing a specific plan.
object
-
state(optional):
string
The updated publication state. This value determines if the Plan is published to the Developer Portal.
-
stateComments(optional):
string
Optional comments for the publication state change.
Response
- application/json
204 Response
400 Response
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
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
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 publish or unpublish 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 @publish.json
https://example.com/apiplatform/management/v1/plans/{planId}/publication
{planId}
is the unique Id for a plan. To retrieve available API Ids, see Get plans.
Example of Request Body (Publish an API)
The following example shows the contents of the request body in JSON format, included with the request above in a file named publish.json
.
{ "state":"PUBLISHED", "stateComments":"Publish the Plan" }
Example of Request Body (Unpublish an API)
The following example shows the contents of the request body in JSON format.
{ "state":"UNPUBLISHED", "stateComments":"Unpublish 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-00018e20 X-oracle-dms-rid: 0 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0