Get available plans for an application
/apiplatform/management/v1/applications/{appId}/subscriptions/plans
Returns a collection of plans available to the {appId}
application.
Users requesting this resource must be assigned the API Manager, Plan Manager, or Application Developer role and must be issued the Manage Application grant for the specified application. Applications the user is issued the Manage Plan, Subscribe, Request Subscribtion, or Manage Subscribed Application grants for are returned.
Request
- application/json
-
appId: string
A unique ID referencing a specific application.
-
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. -
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 available plans for an application 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/applications/{appId}/subscriptions/plans
{appId}
is the unique Id for an application. To retrieve available application Ids, see Get Applications.
You can pass the following optional field values in the fields
query parameter, separated by commas, to include them in the response:
-
description
: The plan???s description. -
createdAt
: The date and time the plan was created. -
createdBy
: The user who created the plan. -
updatedAt
: The date and time the plan was last updated. -
updatedBy
: The user who last updated the plan.
The following example shows you how to include these fields in the response:
curl -i -X GET
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/applications/{appId}/subscriptions/plans?fields=createdAt,createdBy
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: Tue, 14 Mar 2017 09:17:10 GMT Content-Length: 290 Content-Type: application/json X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-0001dcb2 X-oracle-dms-rid: 0:1 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 details about the available plans and HATEOAS links to related operations.
{{ "offset": 0, "count": 12, "limit": 128, "hasMore": false, "links": [ { "templated": "true", "method": "GET", "rel": "self", "href": "http://example.com:7201/apiplatform/management/v1/applications/107/subscriptions/plans?offset=0=128" } ], "items": [ { "createdAt": "2018-02-05T10:27:33-0800", "updatedBy": "apcsadmin", "createdBy": "apcsadmin", "name": "Everything Free", "description": "Everything is free.", "id": "103", "version": "1.0", "updatedAt": "2018-02-05T11:23:21-0800" }, { "createdAt": "2018-02-05T22:41:48-0800", "updatedBy": "apcsadmin", "createdBy": "apcsadmin", "name": "myplan", "id": "108", "updatedAt": "2018-02-05T22:41:48-0800" }, { "createdAt": "2018-02-06T00:59:30-0800", "updatedBy": "apcsadmin", "createdBy": "apcsadmin", "name": "Myplan", "description": "This is my plan", "id": "109", "version": "v1", "updatedAt": "2018-02-06T00:59:30-0800" }, { "createdAt": "2018-02-12T10:49:24-0800", "updatedBy": "apcsadmin", "createdBy": "apcsadmin", "name": "abc123", "id": "118", "updatedAt": "2018-02-12T10:49:24-0800" }, { "createdAt": "2018-02-05T10:27:29-0800", "updatedBy": "apcsadmin", "createdBy": "apcsadmin", "name": "Real Estate Gold", "description": "Allows for high usage.", "id": "100", "version": "1.0", "updatedAt": "2018-02-05T11:26:42-0800" }, { "createdAt": "2018-02-05T10:27:29-0800", "updatedBy": "apcsadmin", "createdBy": "apcsadmin", "name": "Weather Gold", "description": "A high usage plan that lets you check the weather as oftern as you want.", "id": "101", "version": "1.0", "updatedAt": "2018-02-05T11:26:07-0800" }, { "createdAt": "2018-02-05T10:27:29-0800", "updatedBy": "apcsadmin", "createdBy": "apcsadmin", "name": "Energy Supreme", "description": "A plan for intermediate usage.", "id": "102", "version": "1.0", "updatedAt": "2018-02-05T11:24:37-0800" }, { "createdAt": "2018-02-09T17:39:29-0800", "updatedBy": "apcsadmin", "createdBy": "apcsadmin", "name": "mybasicplan", "id": "116", "updatedAt": "2018-02-09T17:44:54-0800" }, { "createdAt": "2018-02-06T01:05:16-0800", "updatedBy": "apcsadmin", "createdBy": "apcsadmin", "name": "MyGoldplan", "description": "This is my plan", "id": "112", "version": "v2", "updatedAt": "2018-02-08T00:19:24-0800" }, { "createdAt": "2018-02-12T01:50:35-0800", "updatedBy": "apcsadmin", "createdBy": "apcsadmin", "name": "Energy", "id": "117", "version": "2.0", "updatedAt": "2018-02-13T01:01:40-0800" }, { "createdAt": "2018-02-13T01:15:12-0800", "updatedBy": "apcsadmin", "createdBy": "apcsadmin", "name": "MyNewPlan", "id": "119", "updatedAt": "2018-02-13T01:24:01-0800" }, { "createdAt": "2018-02-05T21:51:34-0800", "updatedBy": "apcsadmin", "createdBy": "apcsadmin", "name": "Goldplan", "description": "Mygold", "id": "107", "version": "2.0", "updatedAt": "2018-02-05T22:49:37-0800" } ] }