Get entitlement details
/developers/services/v1/plans/{planId}/entitlements/{entitlementId}
Returns details of the {entitlementId}
entitlement for the {planId} plan.
Users must have Gateway Manager, Application Developer, Plan Manager or API Manager Role. This call is made in the context of a plan so the user requesting this resource must have Manage Plan or View all Details Plan grant to view all the details of the entitlement. If the user has View Public Details Plan, Subscribe Application to Plan, Request Subscribe Application to Plan, Entitle API to Plan grants, only public view details of entitlements are returned.
Request
-
entitlementId: string
A unique ID referencing a specific entitlement.
-
planId: string
A unique ID referencing a specific plan.
-
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. - links(optional): array
Response
200 Response
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
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
-
name:
string
The API's name.
-
vanityName(optional):
string
The API's vanity name.
-
version:
string
The API's version.
object
-
createdAt(optional):
string
The date and time the API was created.
-
createdBy(optional):
string
The user who created the API.
-
updatedAt(optional):
string
The date and time the API was last updated.
-
updatedBy(optional):
string
The user who last updated the API.
object
-
state(optional):
string
The API's state. Valid values are
ALPHA
,BETA
,DEPRECATED
,RELEASED
, andRETIRED
. -
stateComments(optional):
string
Comments about the API's state.
-
stateUpdatedAt(optional):
string
The date and time the API state was last updated.
-
stateUpdatedBy(optional):
string
The user who last updated the API state.
object
-
iterationId(optional):
string
The API's iteration.
object
-
description(optional):
string
The API's description.
-
documentation(optional):
object documentation
Describes the API's documenation resource
-
icon(optional):
string
The API's icon.
-
overview(optional):
object overview
Describes the API's overview text resource.
object
object
-
iterationId(optional):
string
The iteration ID of the API published to the Developer Portal.
-
portalUrl(optional):
string
The URL of the API's page on the Developer Portal.
-
state(optional):
string
The API's publication state. This value indicates if the API is published to the Developer Portal. Valid values are
PUBLISHED
andUNPUBLISHED
. -
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.
-
visibility(optional):
string
The API's visibility level.
object
-
data(optional):
string
The path to the documentation resource, if attached as a file, the URL of the resource, if added as a link, or the overview text itself, if entered as text.
-
dataType(optional):
string
The method used to attach documentation to the API. Valid values are
link
,file
, andtext
. The value islink
if Apiary documentation is added. -
doctype(optional):
string
The documentation type of the documentation resource. Valid values are markdown, html, and apiary.
object
-
data(optional):
string
The name of the resource, if attached as a file, the URL of the resource, if added as a link, or the overview text itself, if entered as text.
-
dataType(optional):
string
The method used to attach overview text to the API. Valid values are
link
,file
, andtext
. -
doctype(optional):
string
The documentation type of the overview text resource. Valid values are
markdown
andhtml
.
object
-
content(optional):
string
-
content-type:
string
The content type of the attached resource, like
text/html; charset=utf-8
. -
pathname:
string
The path to the API resource.
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 collection of all APIs that can be added to the {planId}
plan by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -i -X GET -u apicsadmin:password https://example.com:443/developers/services/v1/plans/{planId}/entitlements/{entitlementId}
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 200 OK Server: Oracle Traffic Director Content-length: 2870 Date: Thu, 15 Feb 2018 15:07:04 GMT Content-type: application/json X-oracle-dms-ecid: a7070a18-e96d-4e69-a511-58eafd07a798-0000f81a X-oracle-dms-rid: 0:1
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "offset": 0, "count": 12, "limit": 128, "hasMore": false, "links": [ { "templated": "true", "method": "GET", "rel": "self", "href": "http://example.com:443/developers/services/v1/plans/117/entitlements/apis" } ], "items": [ { "createdAt": "2018-02-05T10:27:27-0800", "updatedBy": "admin", "createdBy": "admin", "name": "Allied Mortgage Calculator", "description": "Fast and easy real estate mortgage payment calculator", "id": "100", "version": "1.0", "updatedAt": "2018-02-05T10:27:27-0800" }, { "createdAt": "2018-02-05T10:27:27-0800", "updatedBy": "admin", "createdBy": "admin", "name": "Allied Mortgage Calculator", "description": "Fast and easy real estate mortgage payment calculator", "id": "101", "version": "2.0", "updatedAt": "2018-02-05T10:27:27-0800" }, { "createdAt": "2018-02-05T10:27:28-0800", "updatedBy": "admin", "createdBy": "admin", "name": "Concur Real Estate Price Comparision", "description": "Compare real estate prices from multiple realtors and multiple markets", "id": "102", "version": "1.0", "updatedAt": "2018-02-05T10:27:28-0800" }, { "createdAt": "2018-02-05T10:27:28-0800", "updatedBy": "admin", "createdBy": "admin", "name": "GeoServices", "description": "Mapping, Routing & Navigation Services", "id": "103", "version": "3.0", "updatedAt": "2018-02-05T10:27:28-0800" }, { "createdAt": "2018-02-05T10:27:28-0800", "updatedBy": "admin", "createdBy": "admin", "name": "United States Weather", "description": "U.S. weather conditions services", "id": "104", "version": "1.0", "updatedAt": "2018-02-05T10:27:28-0800" }, { "createdAt": "2018-02-05T10:27:29-0800", "updatedBy": "admin", "createdBy": "admin", "name": "Energy", "description": "Energy consumption services", "id": "105", "version": "1.0", "updatedAt": "2018-02-05T10:27:29-0800" }, { "createdAt": "2018-02-07T12:12:05-0800", "updatedBy": "admin", "createdBy": "admin", "name": "energy", "description": "Gas Usage API for API Platform and Identity Cloud Service Integration tutorial.", "id": "106", "version": "1", "updatedAt": "2018-02-15T02:08:52-0800" }, { "createdAt": "2018-02-08T23:36:11-0800", "updatedBy": "admin", "createdBy": "admin", "name": "weather", "id": "107", "version": "v1", "updatedAt": "2018-02-08T23:36:11-0800" }, { "createdAt": "2018-02-12T01:50:34-0800", "updatedBy": "admin", "createdBy": "admin", "name": "Energy", "description": "API description.", "id": "108", "version": "2.0", "updatedAt": "2018-02-13T01:35:24-0800" }, { "createdAt": "2018-02-15T01:18:01-0800", "updatedBy": "admin", "createdBy": "admin", "name": "Test", "id": "113", "version": "v1", "updatedAt": "2018-02-15T01:18:01-0800" }, { "createdAt": "2018-02-13T23:22:24-0800", "updatedBy": "admin", "createdBy": "admin", "name": "MyNewAPI", "description": "Demo", "id": "111", "version": "1.0", "updatedAt": "2018-02-13T23:40:41-0800" }, { "createdAt": "2018-02-13T10:38:13-0800", "updatedBy": "admin", "createdBy": "admin", "name": "proc_test", "id": "109", "version": "1", "updatedAt": "2018-02-13T22:54:23-0800" } ] }