Create a plan
post
/apiplatform/management/v1/plans
Creates a plan.
Users requesting this resource must be assigned the Plan Manager role.
Request
Supported Media Types
- application/json
Nested Schema : PlanIdentity
Type:
Show Source
object
-
name(optional):
string
The Plan's name.
-
vanityName(optional):
string
The Plan's vanity name.
-
version(optional):
string
The Plan's version.
Nested Schema : PlanDef
Type:
Show Source
object
-
constraints(optional):
object constraints
Describes the Plan's constraints.
-
description(optional):
string
The plan's description.
-
icon(optional):
string
The Plan's icon.
-
overview(optional):
object overview
Describes the Plan's overview text resource.
-
publicationSettings(optional):
object publicationSettings
Describes the Plan's publication settings.
Nested Schema : PlanState
Type:
Show Source
object
-
state(optional):
string
The Plan's state.
-
stateComments(optional):
string
Comments about the Plan's state.
-
stateUpdatedAt(optional):
string
The date and time the Plan state was last updated.
-
stateUpdatedBy(optional):
string
The user who last updated the Plan state.
Nested Schema : overview
Type:
object
Describes the Plan's overview text resource.
Show Source
-
data(optional):
string
The name of the resource, if attached as a file, the URL of the resource, if added as a link, or the overview text itself, if entered as text.
-
dataType(optional):
string
The method used to attach overview text to the Plan. Valid values are link, file, and text.
-
doctype(optional):
string
The documentation type of the overview text resource. Valid values are markdown and html.
Nested Schema : publicationSettings
Type:
object
Describes the Plan's publication settings.
Show Source
-
constraints(optional):
object constraints
-
description(optional):
object description
-
icon(optional):
object icon
-
recommended(optional):
boolean
Wheyher the plan should be marked as recommeded in the Developer Portal.
Nested Schema : description
Type:
Show Source
object
-
displayed(optional):
boolean
Whether the Plan's description should be displayed
Nested Schema : icon
Type:
Show Source
object
-
displayed(optional):
boolean
Whether the Plan's icon should be displayed
Nested Schema : invocations
Type:
Show Source
object
-
displayed(optional):
boolean
Whether the Plan's Invocation Rate Limits should be displayed
-
displayText(optional):
string
An alternate text to display when invocations rate limit are displayed.
Nested Schema : PlanPublication
Type:
Show Source
object
-
state(optional):
string
The Plan's publication state. This value determines if the Plan is published to the Developer Portal. Valid values are PUBLISHED and UNPUBLISHED.
-
stateComments(optional):
string
Comments about the publication's state.
-
stateUpdatedAt(optional):
string
The date and time the publication state was last updated.
-
stateUpdatedBy(optional):
string
The user who last updated the publication state.
Response
Supported Media Types
- application/json
201 Response
The plan was created.
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 create a plan by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -X POST
-H "Authorization: Bearer access_token"
-H "Content-Type: application/json"
-d @plan.json
"https://example.com/apiplatform/management/v1/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 plan.json) , including details about the new plan.
{ "name": "MyGoldplan", "version": "v1", "vanityName": "Gold", "description": "This is my gold plan", "state":"ACTIVE", "stateComments":"ACTIVE", "publication":{"state":"PUBLISHED","stateComments":"Published to Developer portal" } }
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 201 Created Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Tue, 06 Feb 2018 08:59:30 GMT Content-Length: 12 Content-Type: application/json X-oracle-dms-ecid: dd439614-7d4f-47ad-a1ea-a25a74ec9403-0000032d X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0
Example of Response Body
The following example shows the contents of the response body in JSON format, including the ID of the plan you created.
{ "id": "109" }