Get APIs eligible for a plan
/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
- application/json
-
planId: string
A unique ID referencing a specific plan.
-
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
-
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
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 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" } ] }