1. REST API for the Management Service in Oracle API Platform Cloud Service - Classic
  2. Tasks
  3. Subscriptions
  4. Plans

Get applications eligible for a plan

get

/apiplatform/management/v1/plans/{planId}/subscriptions/applications

Returns a collection of all applications that can subscribe to the {planId} plan.

Users requesting this resource must be assigned the API Manager, Plan Manager role and must be issued the Manage API, Subscribe, or Manage a Subscribed Application grants for the plan. Applications the user is issued the Manage Application grant for are returned.

Request

Supported Media Types
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.
  • Number of items to retrieve. 1 is the minumum; 128 is the maximum.
    Default Value: 128
  • Offset the list returned results by this amount. Default is zero.
    Default Value: 0
  • Collection Format: csv
    Pass sorting criteria, comma separated.
  • Pass filtering criteria, using the SCIM filter expression syntax
  • Include the total result count in the response.
    Default Value: false
Back to Top

Response

Supported Media Types

200 Response

The collection of applications
Body ()
Root Schema : GetApplicationsResponse
Match All
Show Source
Nested Schema : CollectionResponseFeature
Type: object
Show Source
Nested Schema : CollectionResponsePagingFeature
Type: object
Show Source
Nested Schema : GetApplicationsResponse-allOf[2]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Application
Type: object

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 all available applications that can subscribe to a 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/apiplatform/management/v1/plans/{planId}/subscriptions/applications

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

You can pass the following optional field values in the fields query parameter, separated by commas, to include them in the response:

  • description: The application???s description.

  • key: The application???s key.

  • contact.firstName: The application owner???s first name.

  • contact.lastName: The application owner???s last name.

  • contact.email: The application owner???s email address.

  • contact.phone: The application owner???s phone number.

  • contact.company: The application owner???s company.

  • types: The application???s types.

  • createdAt: The date and time the application was created.

  • createdBy: The user who created the application.

  • updatedAt: The date and time the application was last updated.

  • updatedBy: The user who last updated the application

The following example shows you how to include these fields in the response:

curl -i -X GET 
-u apicsadmin:password
https://example.com/apiplatform/management/v1/plans/{planId}/subscriptions/applications?fields=key,contact.email

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:  Wed, 15 Mar 2017 06:13:34 GMT
Content-Length:  1494
Content-Type:  application/json
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-00021aa8
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 the details about the eligible applications.

{
    "offset": 0,
    "count": 6,
    "limit": 128,
    "hasMore": false,
    "links": [
        {
            "templated": "true",
            "method": "GET",
            "rel": "self",
            "href": "http://example.com:7201/apiplatform/management/v1/plans/119/subscriptions/applications?offset=0&=128"
        }
    ],
    "items": [
        {
            "createdAt": "2018-02-08T00:39:42-0800",
            "updatedBy": "apcsadmin",
            "createdBy": "apcsadmin",
            "name": "Allied Mortgage Calculator",
            "description": "Fast and easy real estate mortgage payment calculator",
            "id": "104",
            "updatedAt": "2018-02-08T00:39:42-0800"
        },
        {
            "createdAt": "2018-02-06T22:19:15-0800",
            "updatedBy": "apcsadmin",
            "createdBy": "apcsadmin",
            "name": "Temperature",
            "id": "103",
            "updatedAt": "2018-02-09T01:36:45-0800"
        },
        {
            "createdAt": "2018-02-05T10:27:30-0800",
            "updatedBy": "apcsadmin",
            "createdBy": "apcsadmin",
            "name": "World Weather",
            "description": "Weather reports and forecasts for the entire world",
            "id": "101",
            "updatedAt": "2018-02-05T11:30:46-0800"
        },
        {
            "createdAt": "2018-02-05T10:27:30-0800",
            "updatedBy": "apcsadmin",
            "createdBy": "apcsadmin",
            "name": "Western Real Estate",
            "description": "View Real Estate Trends, Analysis and Statistics",
            "id": "102",
            "updatedAt": "2018-02-05T11:30:20-0800"
        },
        {
            "createdAt": "2018-02-08T00:42:27-0800",
            "updatedBy": "apcsadmin",
            "createdBy": "apcsadmin",
            "name": "Temperature",
            "description": "Application for Temperature",
            "id": "105",
            "updatedAt": "2018-02-08T23:23:05-0800"
        },
        {
            "createdAt": "2018-02-09T02:57:15-0800",
            "updatedBy": "apcsadmin",
            "createdBy": "apcsadmin",
            "name": "Postman FAON",
            "description": "Postman FAON",
            "id": "106",
            "updatedAt": "2018-02-09T02:57:15-0800"
        }
    ]
}
Back to Top