Get entitlement details

get

/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

Path Parameters
Query Parameters
  • 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.
  • 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.
Back to Top

Response

200 Response

The entitlement
Body ()
Root Schema : GetEntitlementResponse
Match All
Show Source
Nested Schema : ResourceLinksProperties
Type: object
Show Source
Nested Schema : Entitlement
Match All
Show Source
Nested Schema : EntitlementId
Type: object
Show Source
Nested Schema : EntitlementDef
Type: object
Nested Schema : Entitlement-allOf[2]
Type: object
Show Source
Nested Schema : Entitlement-allOf[3]
Type: object
Show Source
Nested Schema : EntitlementState
Type: object
Show Source
Nested Schema : Entitlement-allOf[5]
Type: object
Show Source
Nested Schema : EntitlementMetadata
Type: object
Show Source
Nested Schema : Api
Match All
Show Source
Nested Schema : ApiId
Type: object
Show Source
Nested Schema : ApiIdentity
Type: object
Show Source
Nested Schema : ApiMetadata
Type: object
Show Source
Nested Schema : ApiState
Type: object
Show Source
Nested Schema : Api-allOf[4]
Type: object
Show Source
Nested Schema : ApiIterationId
Type: object
Show Source
Nested Schema : ApiDetails
Type: object
Show Source
Nested Schema : ApiImpl
Type: object
Nested Schema : ApiArtifacts
Type: object
Show Source
Nested Schema : ApiPublication
Type: object
Show Source
Nested Schema : documentation
Type: object
Describes the API's documenation resource
Show Source
  • 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.
  • The method used to attach documentation to the API. Valid values are link, file, and text. The value is link if Apiary documentation is added.
  • The documentation type of the documentation resource. Valid values are markdown, html, and apiary.
Nested Schema : overview
Type: object
Describes the API's overview text resource.
Show Source
  • 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.
  • The method used to attach overview text to the API. Valid values are link, file, and text.
  • The documentation type of the overview text resource. Valid values are markdown and html.
Nested Schema : artifacts
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : Plan
Type: object
Nested Schema : EntitlementPublication
Type: object
Show Source

403 Response

Forbidden.
Body ()
Root Schema : Error
Type: object
Show Source
Nested Schema : errorDetails
Type: array
additional errors
Show Source

500 Response

Unexpected error.
Body ()
Root Schema : Error
Type: object
Show Source
Nested Schema : errorDetails
Type: array
additional errors
Show Source
Back to Top

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"
        }
    ]
}
Back to Top