Get entitlements
/apiplatform/management/v1/apis/{apiId}/entitlements
Returns the collection of entitlements for the {apiID}
API.
User must have Gateway Manger, Plan Manager or API Manager roles. This call is made in the content of API so the user must have Manage API or View All Details grants on the API.
Request
- application/json
-
apiId: string
A unique ID referencing a specific API.
-
expand(optional): array
Collection Format:
csv
Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of expand values. -
fields(optional): array
Collection Format:
csv
Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values. -
limit(optional): integer(int32)
Number of items to retrieve.
1
is the minumum;128
is the maximum.Default Value:128
- links(optional): array
-
offset(optional): integer(int32)
Offset the list returned results by this amount. Default is zero.Default Value:
0
- orderBy(optional): array
-
q(optional): string
Pass filtering criteria, using the SCIM filter expression syntax
-
totalResults(optional): boolean
Include the total result count in the response.Default Value:
false
Response
- application/json
200 Response
object
-
count(optional):
integer(int32)
The number of items in this collection.
object
-
totalResults(optional):
integer(int32)
The total number of results available. Only provided if the showTotalResults query parameter is set to true
object
-
links(optional):
array links
Includes 'canonical'.
object
-
href(optional):
string
Link href.
-
method(optional):
string
HTTP Operation GET, POST, PUT
-
rel(optional):
string
Link relation.
object
-
links(optional):
array links
Includes 'canonical'.
object
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
-
createdAt(optional):
string
The date and time the entitlement was created.
-
createdBy(optional):
string
The user who created the entitlement.
-
updatedAt(optional):
string
The date and time the entitlement was last updated.
-
updatedBy(optional):
string
The user who last updated the entitlement.
object
object
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.
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 retrieve the collection of entitlements for the {apiID}
API by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -i -X GET
-H "Authorization: Bearer access_token"
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 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 12:13:12 GMT Content-Length: 2811 Content-Type: application/json X-oracle-dms-ecid: a7070a18-e96d-4e69-a511-58eafd07a798-0000cda8 X-oracle-dms-rid: 0 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 details of the associated plan and API.
{ "offset": 0, "count": 2, "limit": 128, "hasMore": false, "links": [ { "templated": "true", "method": "GET", "rel": "self", "href": "http://example.com:443/apiplatform/management/v1/apis/100/entitlements?offset=0=128" }, { "templated": "true", "method": "GET", "rel": "canonical", "href": "http://example.com:443/apiplatform/management/v1/apis/100/entitlements" }, { "templated": "true", "method": "POST", "rel": "add", "href": "http://example.com:443/apiplatform/management/v1/apis/100/entitlements" }, { "templated": "true", "method": "GET", "rel": "plans", "href": "http://example.com:443/apiplatform/management/v1/apis/100/entitlements/plans" } ], "items": [ { "createdAt": "2018-02-05T10:27:30-0800", "updatedBy": "admin", "createdBy": "admin", "publication": { "state": "PUBLISHED" }, "links": [ { "templated": "true", "method": "GET", "rel": "self", "href": "http://example.com:443/apiplatform/management/v1/apis/100/entitlements/100" }, { "templated": "true", "method": "GET", "rel": "canonical", "href": "http://example.com:443/apiplatform/management/v1/apis/100/entitlements/100" }, { "templated": "true", "method": "PUT", "rel": "inactivate", "href": "http://example.com:443/apiplatform/management/v1/apis/100/entitlements/100/state" }, { "templated": "true", "method": "PUT", "rel": "unpublish", "href": "http://example.com:443/apiplatform/management/v1/apis/100/entitlements/100/publication" }, { "templated": "true", "method": "PUT", "rel": "edit", "href": "http://example.com:443/apiplatform/management/v1/apis/100/entitlements/100" } ], "state": "ACTIVE", "api": { "id": "100" }, "id": "100", "plan": { "id": "100" }, "updatedAt": "2018-02-05T10:27:30-0800" }, { "createdAt": "2018-02-05T22:57:31-0800", "updatedBy": "admin", "createdBy": "admin", "publication": { "state": "UNPUBLISHED" }, "links": [ { "templated": "true", "method": "GET", "rel": "self", "href": "http://example.com:443/apiplatform/management/v1/apis/100/entitlements/110" }, { "templated": "true", "method": "GET", "rel": "canonical", "href": "http://example.com:443/apiplatform/management/v1/apis/100/entitlements/110" }, { "templated": "true", "method": "PUT", "rel": "inactivate", "href": "http://example.com:443/apiplatform/management/v1/apis/100/entitlements/110/state" }, { "templated": "true", "method": "PUT", "rel": "publish", "href": "http://example.com:443/apiplatform/management/v1/apis/100/entitlements/110/publication" }, { "templated": "true", "method": "PUT", "rel": "edit", "href": "http://example.com:443/apiplatform/management/v1/apis/100/entitlements/110" }, { "templated": "true", "method": "DELETE", "rel": "remove", "href": "http://example.com:443/apiplatform/management/v1/apis/100/entitlements/110" } ], "state": "ACTIVE", "api": { "id": "100" }, "id": "110", "plan": { "id": "107" }, "updatedAt": "2018-02-05T22:57:31-0800" } ] }