REST API for the Management Service in Oracle API Platform Cloud Service - Classic

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

Root Schema : CreatePlanRequest

Match All

Show Source

object PlanIdentity
object PlanDef
object PlanState
object CreatePlanRequest-allOf[3]

{
    "allOf":[
        {
            "$ref":"#/definitions/PlanIdentity"
        },
        {
            "$ref":"#/definitions/PlanDef"
        },
        {
            "$ref":"#/definitions/PlanState"
        },
        {
            "type":"object",
            "properties":{
                "publication":{
                    "$ref":"#/definitions/PlanPublication"
                }
            }
        }
    ]
}

Nested Schema : PlanIdentity

Type: object

Show Source

name(optional): string

The Plan's name.
vanityName(optional): string

The Plan's vanity name.
version(optional): string

The Plan's version.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The Plan's name."
        },
        "version":{
            "type":"string",
            "description":"The Plan's version."
        },
        "vanityName":{
            "type":"string",
            "description":"The Plan's vanity name."
        }
    }
}

Nested Schema : PlanDef

Type: object

Show Source

constraints(optional): object constraints

Describes the Plan's overview text resource.
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.

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The plan's description."
        },
        "icon":{
            "type":"string",
            "description":"The Plan's icon."
        },
        "overview":{
            "type":"object",
            "description":"Describes the Plan's overview text resource.",
            "properties":{
                "doctype":{
                    "type":"string",
                    "description":"The documentation type of the overview text resource. Valid values are markdown and html."
                },
                "data":{
                    "type":"string",
                    "description":"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":{
                    "type":"string",
                    "description":"The method used to attach overview text to the Plan. Valid values are link, file, and text."
                }
            }
        },
        "publicationSettings":{
            "type":"object",
            "description":"Describes the Plan's publication settings.",
            "properties":{
                "icon":{
                    "type":"object",
                    "properties":{
                        "displayed":{
                            "type":"boolean",
                            "description":"Whether the Plan's icon should be displayed"
                        }
                    }
                },
                "description":{
                    "type":"object",
                    "properties":{
                        "displayed":{
                            "type":"boolean",
                            "description":"Whether the Plan's description should be displayed"
                        }
                    }
                },
                "constraints":{
                    "type":"object",
                    "properties":{
                        "rate":{
                            "type":"object",
                            "properties":{
                                "invocations":{
                                    "type":"object",
                                    "properties":{
                                        "displayed":{
                                            "type":"boolean",
                                            "description":"Whether the Plan's Invocation Rate Limits should be displayed"
                                        },
                                        "displayText":{
                                            "type":"string",
                                            "description":"An alternate text to display when invocations rate limit are displayed."
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "recommended":{
                    "type":"boolean",
                    "description":"Wheyher the plan should be marked as recommeded in the Developer Portal."
                }
            }
        },
        "constraints":{
            "type":"object",
            "description":"Describes the Plan's overview text resource.",
            "properties":{
                "doctype":{
                    "type":"string",
                    "description":"The documentation type of the overview text resource. Valid values are markdown and html."
                },
                "data":{
                    "type":"string",
                    "description":"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":{
                    "type":"string",
                    "description":"The method used to attach overview text to the Plan. Valid values are link, file, and text."
                }
            }
        }
    }
}

Nested Schema : PlanState

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "state":{
            "type":"string",
            "description":"The Plan's state."
        },
        "stateComments":{
            "type":"string",
            "description":"Comments about the Plan's state."
        },
        "stateUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the Plan state."
        },
        "stateUpdatedAt":{
            "type":"string",
            "description":"The date and time the Plan state was last updated."
        }
    }
}

Nested Schema : CreatePlanRequest-allOf[3]

Type: object

Show Source

publication(optional): object PlanPublication

{
    "type":"object",
    "properties":{
        "publication":{
            "$ref":"#/definitions/PlanPublication"
        }
    }
}

Nested Schema : constraints

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.

{
    "type":"object",
    "description":"Describes the Plan's overview text resource.",
    "properties":{
        "doctype":{
            "type":"string",
            "description":"The documentation type of the overview text resource. Valid values are markdown and html."
        },
        "data":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"The method used to attach overview text to the Plan. Valid values are link, file, and text."
        }
    }
}

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.

{
    "type":"object",
    "description":"Describes the Plan's overview text resource.",
    "properties":{
        "doctype":{
            "type":"string",
            "description":"The documentation type of the overview text resource. Valid values are markdown and html."
        },
        "data":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"The method used to attach overview text to the Plan. Valid values are link, file, and text."
        }
    }
}

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.

{
    "type":"object",
    "description":"Describes the Plan's publication settings.",
    "properties":{
        "icon":{
            "type":"object",
            "properties":{
                "displayed":{
                    "type":"boolean",
                    "description":"Whether the Plan's icon should be displayed"
                }
            }
        },
        "description":{
            "type":"object",
            "properties":{
                "displayed":{
                    "type":"boolean",
                    "description":"Whether the Plan's description should be displayed"
                }
            }
        },
        "constraints":{
            "type":"object",
            "properties":{
                "rate":{
                    "type":"object",
                    "properties":{
                        "invocations":{
                            "type":"object",
                            "properties":{
                                "displayed":{
                                    "type":"boolean",
                                    "description":"Whether the Plan's Invocation Rate Limits should be displayed"
                                },
                                "displayText":{
                                    "type":"string",
                                    "description":"An alternate text to display when invocations rate limit are displayed."
                                }
                            }
                        }
                    }
                }
            }
        },
        "recommended":{
            "type":"boolean",
            "description":"Wheyher the plan should be marked as recommeded in the Developer Portal."
        }
    }
}

Nested Schema : constraints

Type: object

Show Source

rate(optional): object rate

{
    "type":"object",
    "properties":{
        "rate":{
            "type":"object",
            "properties":{
                "invocations":{
                    "type":"object",
                    "properties":{
                        "displayed":{
                            "type":"boolean",
                            "description":"Whether the Plan's Invocation Rate Limits should be displayed"
                        },
                        "displayText":{
                            "type":"string",
                            "description":"An alternate text to display when invocations rate limit are displayed."
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : description

Type: object

Show Source

displayed(optional): boolean

Whether the Plan's description should be displayed

{
    "type":"object",
    "properties":{
        "displayed":{
            "type":"boolean",
            "description":"Whether the Plan's description should be displayed"
        }
    }
}

Nested Schema : icon

Type: object

Show Source

displayed(optional): boolean

Whether the Plan's icon should be displayed

{
    "type":"object",
    "properties":{
        "displayed":{
            "type":"boolean",
            "description":"Whether the Plan's icon should be displayed"
        }
    }
}

Nested Schema : rate

Type: object

Show Source

invocations(optional): object invocations

{
    "type":"object",
    "properties":{
        "invocations":{
            "type":"object",
            "properties":{
                "displayed":{
                    "type":"boolean",
                    "description":"Whether the Plan's Invocation Rate Limits should be displayed"
                },
                "displayText":{
                    "type":"string",
                    "description":"An alternate text to display when invocations rate limit are displayed."
                }
            }
        }
    }
}

Nested Schema : invocations

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "displayed":{
            "type":"boolean",
            "description":"Whether the Plan's Invocation Rate Limits should be displayed"
        },
        "displayText":{
            "type":"string",
            "description":"An alternate text to display when invocations rate limit are displayed."
        }
    }
}

Nested Schema : PlanPublication

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "state":{
            "type":"string",
            "description":"The Plan's publication state. This value determines if the Plan is published to the Developer Portal. Valid values are PUBLISHED and UNPUBLISHED."
        },
        "stateComments":{
            "type":"string",
            "description":"Comments about the publication's state."
        },
        "stateUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the publication state."
        },
        "stateUpdatedAt":{
            "type":"string",
            "description":"The date and time the publication state was last updated."
        }
    }
}

Response

Supported Media Types

application/json

201 Response

The plan was created.

Root Schema : PlanId

Type: object

Show Source

id: string

The plan's ID.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The plan's ID."
        }
    }
}

400 Response

Bad request, indicates a problem with the input parameters.

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"
    }
}

403 Response

Forbidden.

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.

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"
    }
}

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 
-u apicsadmin:password
-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"
}