Add an API
/apiplatform/management/v1/apis/{apiId}/entitlements
Adds the {apiId} API to the plan.
User must have Plan Manger or API Manager roles. User must also have Manage API or Entitle API grant on the API and Manage Plan or Entitle API to Plan grants on the plan.
.Request
- application/json
-
apiId: string
A unique ID referencing a specific API.
object
-
planId:
string
The plan's ID.
object
-
state(optional):
string
The entitlement's state.
-
stateComments(optional):
string
Comments regarding the entitlement's state.
-
stateUpdatedAt(optional):
string
The date and time the entitlement's state was last updated.
-
stateUpdatedBy(optional):
string
The user who last updated the entitlement's state.
object
-
state(optional):
string
The entitlement's publication state. This value determines if the entitlement is published to the Plan. 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
- application/json
201 Response
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 add an API to a plan by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X POST
-H "Authorization: Bearer access_token"
-H "Content-Type:application/json"
-d @deployment.json
https://example.com/apiplatform/management/v1/apis/{apiId}/entitlements
{apiId}
is the unique ID for an API. To retrieve available API IDs, see Get APIs.
Example of Request Body
The following shows an example of the request body.
{ "planId": "117", "stateComments": "published", "stateUpdatedBy": "admin", "stateUpdatedAt": "12 Feb 2018", "publication": { "state": "UNPUBLISHED", "stateComments": "published", "stateUpdatedBy": "admin", "stateUpdatedAt": "12 Feb 2018" } }
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 200 OK Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Mon, 12 Feb 2018 14:53:05 GMT Content-Length: 12 Content-Type: application/json X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-0002ac6f 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 deployment ID.
{ "id": "118" }