Jump to

• Request
• Response
• Examples

Update a plan

put

/apiplatform/management/v1/plans/{planId}

Updates 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.

Body ()

Root Schema : UpdatePlanRequest

Match All

Show Source

• object PlanDef

{
    "allOf":[
        {
            "$ref":"#/definitions/PlanDef"
        }
    ]
}

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

Back to Top

Response

Supported Media Types

• application/json

204 Response

The plan was updated.

400 Response

Bad request, indicates a problem with the input parameters.

Body ()

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.

Body ()

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.

Body ()

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

Back to Top

Examples

The following example shows how to update 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 
-u apicsadmin:password
-H "Content-Type:application/json"
-d @update-plan.json
https://example.com/apiplatform/management/v1/plans/{planId}

{planId} is the unique ID for a plan. To retrieve available Plan 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-plan.json.

{
	"name": "MyGoldplan",
	"version": "v1",
	"vanityName": "MyGold",
 "description": "This is my gold plan",
 "state":"ACTIVE",
 "stateComments":"ACTIVE",
 "publication":{"state":"UNPUBLISHED","stateComments":"UNPublished to Developer portal" }
} 

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:40:28 GMT
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-00018fc1
X-oracle-dms-rid:  0
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

Back to Top