Jump to

• Request
• Response
• Examples

Get APIs eligible for a plan

get

/apiplatform/management/v1/plans/{planId}/entitlements/apis

Returns a collection of all APIs that can be added to the {planId} plan. By default, the name and version of each API is returned.

The user must have Plan Manager or API Manager Role. This call is made in the context of a plan so the user must have Manage Plan or Entitle API to Plan grant on the specific plan to invoke this call. The return list includes APIs for which the user has Manage API or Entitle API grant permissions.

Request

Supported Media Types

• application/json

Path Parameters

• planId: string
  A unique ID referencing a specific plan.

Query Parameters

• 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"
  }

• limit(optional): integer(int32)
  Number of items to retrieve. 1 is the minumum; 128 is the maximum.

  Default Value: 128
• offset(optional): integer(int32)
  Offset the list returned results by this amount. Default is zero.

  Default Value: 0
• orderBy(optional): array
  Collection Format: csv

  Pass sorting criteria, comma separated.

  • [0]: string

  {
      "name":"orderBy",
      "in":"query",
      "description":"Pass sorting criteria, comma separated.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• 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

Back to Top

Response

Supported Media Types

• application/json

200 Response

The collection of APIs

Body ()

Root Schema : GetApisResponse

Match All

Show Source

• object CollectionResponseFeature
• object CollectionResponsePagingFeature
• object GetApisResponse-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResponseFeature"
        },
        {
            "$ref":"#/definitions/CollectionResponsePagingFeature"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/Api"
                    }
                }
            }
        }
    ]
}

Nested Schema : CollectionResponseFeature

Type: object

Show Source

• count(optional): integer(int32)
  The number of items in this collection.

{
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of items in this collection."
        }
    }
}

Nested Schema : CollectionResponsePagingFeature

Type: object

Show Source

• totalResults(optional): integer(int32)
  The total number of results available. Only provided if the showTotalResults query parameter is set to true

{
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of results available. Only provided if the showTotalResults query parameter is set to true"
        }
    }
}

Nested Schema : GetApisResponse-allOf[2]

Type: object

Show Source

• items(optional): array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object Api

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Api"
    }
}

Nested Schema : Api

Type: object

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 a 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 
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/plans/{planId}/entitlements/apis

• {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 18:37:55 GMT
Content-Length:  2246
Content-Type:  application/json
X-oracle-dms-ecid:  a7070a18-e96d-4e69-a511-58eafd07a798-0000cda1
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": 9,
    "limit": 128,
    "hasMore": false,
    "links": [
        {
            "templated": "true",
            "method": "GET",
            "rel": "self",
            "href": "http://example.com:443/apiplatform/management/v1/plans/117/entitlements/apis?offset=0=128"
        }
    ],
    "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 simultanously",
            "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 and Electricity Usage API for API Platform and Identity Cloud Service Integration tutorial.",
            "id": "106",
            "version": "1",
            "updatedAt": "2018-02-08T05:13:04-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",
            "id": "108",
            "version": "2.0",
            "updatedAt": "2018-02-12T01:50:34-0800"
        }
    ]
}

Back to Top