Jump to

• Request
• Response
• Examples

Update entitlement state

put

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

Updates the state of the {entitlementId} entitlement for the {planId} plan.

The user must have Plan Manager or API Manager role and must have Manage Plan or Entitle API to Plan grants on the Plan and Manage API or Entitle API grants on the API.

Request

Supported Media Types

• application/json

Path Parameters

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

Body ()

Root Schema : UpdateEntitlementStateRequest

Type: object

Show Source

• state: string
  The entitlement's state.
• stateComments(optional): string
  Comments regarding the entitlement's state.

{
    "type":"object",
    "required":[
        "state"
    ],
    "properties":{
        "state":{
            "type":"string",
            "description":"The entitlement's state."
        },
        "stateComments":{
            "type":"string",
            "description":"Comments regarding the entitlement's state."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The entitlement's state was updated.

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 the state of an entitlement for 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 
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/plans/{planId}/entitlements/{entitlementId}/state

{apiId} is the unique Id for an API. To retrieve available API Ids, see Get APIs.

Example of Request Body

The following example provides a request body for updating an API.

{
	"state": "ACTIVE",
	"stateComments": "in active state"
}

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:  Mon, 12 Feb 2018 18:00:53 GMT
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-000196fb
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

Back to Top