Jump to

• Request
• Response
• Examples

Get entitlement details

get

/apiplatform/management/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, View All Details Plan or View Public Details 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

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.

Query Parameters

• 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.

  • [0]: string

  {
      "name":"expand",
      "in":"query",
      "description":"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.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• 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.

  • [0]: string

  {
      "name":"fields",
      "in":"query",
      "description":"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.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• links(optional): array
  Collection Format: csv

  Filter the specified link rel's.

  • [0]: string

  {
      "name":"links",
      "in":"query",
      "description":"Filter the specified link rel's.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

Back to Top

Response

Supported Media Types

• application/json

200 Response

The entitlement

Body ()

Root Schema : GetEntitlementResponse

Match All

Show Source

• object ResourceLinksProperties
• Entitlement

{
    "allOf":[
        {
            "$ref":"#/definitions/ResourceLinksProperties"
        },
        {
            "$ref":"#/definitions/Entitlement"
        }
    ]
}

Nested Schema : ResourceLinksProperties

Type: object

Show Source

• links(optional): array links
  Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : Entitlement

Match All

Show Source

• object EntitlementId
• object EntitlementDef
• object Entitlement-allOf[2]
• object Entitlement-allOf[3]
• object EntitlementState
• object Entitlement-allOf[5]
• object EntitlementMetadata

{
    "allOf":[
        {
            "$ref":"#/definitions/EntitlementId"
        },
        {
            "$ref":"#/definitions/EntitlementDef"
        },
        {
            "type":"object",
            "properties":{
                "api":{
                    "$ref":"#/definitions/Api"
                }
            }
        },
        {
            "type":"object",
            "properties":{
                "plan":{
                    "$ref":"#/definitions/Plan"
                }
            }
        },
        {
            "$ref":"#/definitions/EntitlementState"
        },
        {
            "type":"object",
            "properties":{
                "publication":{
                    "$ref":"#/definitions/EntitlementPublication"
                }
            }
        },
        {
            "$ref":"#/definitions/EntitlementMetadata"
        }
    ]
}

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

• Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

Nested Schema : HATEOASLink

Type: object

Show Source

• href(optional): string
  Link href.
• method(optional): string
  HTTP Operation GET, POST, PUT
• rel(optional): string
  Link relation.

{
    "type":"object",
    "properties":{
        "method":{
            "type":"string",
            "description":"HTTP Operation GET, POST, PUT"
        },
        "rel":{
            "type":"string",
            "description":"Link relation."
        },
        "href":{
            "type":"string",
            "description":"Link href."
        }
    }
}

Nested Schema : EntitlementId

Type: object

Show Source

• id: string
  The entitlement's ID.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The entitlement's ID."
        }
    }
}

Nested Schema : EntitlementDef

Type: object

Nested Schema : Entitlement-allOf[2]

Type: object

Show Source

• api(optional): object Api

{
    "type":"object",
    "properties":{
        "api":{
            "$ref":"#/definitions/Api"
        }
    }
}

Nested Schema : Entitlement-allOf[3]

Type: object

Show Source

• plan(optional): object Plan

{
    "type":"object",
    "properties":{
        "plan":{
            "$ref":"#/definitions/Plan"
        }
    }
}

Nested Schema : EntitlementState

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "state":{
            "type":"string",
            "description":"The entitlement's state."
        },
        "stateComments":{
            "type":"string",
            "description":"Comments regarding the entitlement's state."
        },
        "stateUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the entitlement's state."
        },
        "stateUpdatedAt":{
            "type":"string",
            "description":"The date and time the entitlement's state was last updated."
        }
    }
}

Nested Schema : Entitlement-allOf[5]

Type: object

Show Source

• publication(optional): object EntitlementPublication

{
    "type":"object",
    "properties":{
        "publication":{
            "$ref":"#/definitions/EntitlementPublication"
        }
    }
}

Nested Schema : EntitlementMetadata

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "createdBy":{
            "type":"string",
            "description":"The user who created the entitlement."
        },
        "createdAt":{
            "type":"string",
            "description":"The date and time the entitlement was created."
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the entitlement."
        },
        "updatedAt":{
            "type":"string",
            "description":"The date and time the entitlement was last updated."
        }
    }
}

Nested Schema : Api

Type: object

Nested Schema : Plan

Type: object

Nested Schema : EntitlementPublication

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "state":{
            "type":"string",
            "description":"The entitlement's publication state. This value determines if the entitlement is published to the Plan. Valid values are PUBLISHED and UNPUBLISHED."
        },
        "stateComments":{
            "type":"string",
            "description":"Comments about the publication's state."
        },
        "stateUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the publication state."
        },
        "stateUpdatedAt":{
            "type":"string",
            "description":"The date and time the publication state was last 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 retrieve details of  the  {entitlementId} entitlement for 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 
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/plans/{planId}/entitlements/{entitlementId}

• {planId} is the unique Id for a plan. To retrieve available plan Ids, see Get plans.

• {entitlementId} is the unique ID for an entitlement. To retrieve available entitlement IDs, see Get entitlements.

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 18:56:43 GMT
Content-Length:  1153
Content-Type:  application/json
X-oracle-dms-ecid:  49d14691-2176-4c99-aed3-38438604f528-00001e9d
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.

{
    "createdAt": "2018-02-12T06:53:05-0800",
    "updatedBy": "admin",
    "createdBy": "admin",
    "publication": {
        "state": "UNPUBLISHED"
    },
    "links": [
        {
            "templated": "true",
            "method": "GET",
            "rel": "self",
            "href": "http://example.com:443/apiplatform/management/v1/plans/117/entitlements/118"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "canonical",
            "href": "http://example.com:443/apiplatform/management/v1/plans/117/entitlements/118"
        },
        {
            "templated": "true",
            "method": "PUT",
            "rel": "inactivate",
            "href": "http://example.com:443/apiplatform/management/v1/plans/117/entitlements/118/state"
        },
        {
            "templated": "true",
            "method": "PUT",
            "rel": "publish",
            "href": "http://example.com:443/apiplatform/management/v1/plans/117/entitlements/118/publication"
        },
        {
            "templated": "true",
            "method": "PUT",
            "rel": "edit",
            "href": "http://example.com:443/apiplatform/management/v1/plans/117/entitlements/118"
        },
        {
            "templated": "true",
            "method": "DELETE",
            "rel": "remove",
            "href": "http://example.com:443/apiplatform/management/v1/plans/117/entitlements/118"
        }
    ],
    "state": "ACTIVE",
    "api": {
        "id": "100"
    },
    "id": "118",
    "plan": {
        "id": "117"
    },
    "updatedAt": "2018-02-12T06:53:05-0800"
}

Back to Top