Update an entitlement
put
/apiplatform/management/v1/apis/{apiId}/entitlements/{entitlementId}
Updates the {entitlementId}
entitlement definition.
User must have API Manager or Plan Manager roles. The user must have Manage API or Entitle API grant on the API and Manage Plan or Entitle API to Plan grants on the Plan.
Request
Supported Media Types
- application/json
Path Parameters
-
apiId: string
A unique ID referencing a specific API.
-
entitlementId: string
A unique ID referencing a specific entitlement.
Nested Schema : EntitlementDef
Type:
object
Response
Supported Media Types
- application/json
204 Response
The entitlement was updated.
400 Response
Bad request, indicates a problem with the input parameters.
Root Schema : Error
Type:
Show Source
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
403 Response
Forbidden.
Root Schema : Error
Type:
Show Source
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
Unexpected error.
Root Schema : Error
Type:
Show Source
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 update the entitlement metadata for an API 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/apis/{apiId}/entitlements/{entitlementId}
{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.
{ "createdBy": "weblogic", "createdAt": "12 Feb 2018", "updatedBy": "weblogic", "updatedAt": "12 Feb 2018" }
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 19:37:49 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