Jump to

• Request
• Response
• Examples

Add an API

post

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

Adds an API to the {planId} plan.

Users must have Plan Manager or API Manager roles and must have Manage Plan or Entitle API to Plan grant on the plan and Manage API or Entitle API grant on the API.

Request

Supported Media Types

• application/json

Path Parameters

• planId: string
  A unique ID referencing a specific plan.

Body ()

Root Schema : CreateApiEntitlementRequest

Match All

Show Source

• object CreateApiEntitlementRequest-allOf[0]
• object EntitlementState
• object CreateApiEntitlementRequest-allOf[2]

{
    "allOf":[
        {
            "type":"object",
            "required":[
                "apiId"
            ],
            "properties":{
                "apiId":{
                    "type":"string",
                    "description":"The API's ID."
                }
            }
        },
        {
            "$ref":"#/definitions/EntitlementState"
        },
        {
            "type":"object",
            "properties":{
                "publication":{
                    "$ref":"#/definitions/EntitlementPublication"
                }
            }
        }
    ]
}

Nested Schema : CreateApiEntitlementRequest-allOf[0]

Type: object

Show Source

• apiId: string
  The API's ID.

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

Nested Schema : EntitlementState

Type: object

Show Source

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

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

Nested Schema : CreateApiEntitlementRequest-allOf[2]

Type: object

Show Source

• publication(optional): object EntitlementPublication

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

Nested Schema : EntitlementPublication

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "state":{
            "type":"string",
            "description":"The entitlement's publication state. This value determines if the entitlement is published to the Plan. 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."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

The entitlement was created.

Body ()

Root Schema : EntitlementId

Type: object

Show Source

• id: string
  The entitlement's ID.

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

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 add an API to a plan 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/plans/{planId}/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.

{
	"apiId": "101",
	"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 201 Created
Server: Oracle-Traffic-Director/12.2.1.0.0
Date:  Mon, 12 Feb 2018 17:40:10 GMT
Content-Length:  12
Content-Type:  application/json
Location ???http://example.com:443/apiplatform/management/v1/plans/117/entitlements/119
Set-Cookie ???APIPLATFORMSESSION=jFeKgU0gUINPU5hG26oxKzJDhL_k4W1yiLnp6Lrb_50wwuywBHER!-285585961; path=/; HttpOnly
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": "119"
}

Back to Top