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

Get subscriptions

get

/apiplatform/management/v1/applications/{appId}/subscriptions

Returns collections of subscriptions for the {appId} application.

Users requesting this resource must be assigned the API Manager, Application Developer, or Plan Manager role and must be issued the Manage Application or View All Details grant for the specified application.

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 subscriptions
Body ()
Root Schema : GetSubscriptionsResponse
Match All
Show Source
Nested Schema : CollectionResponseFeature
Type: object
Show Source
Nested Schema : CollectionResponsePagingFeature
Type: object
Show Source
Nested Schema : LinksResponseFeature
Type: object
Show Source
Nested Schema : GetSubscriptionsResponse-allOf[3]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : GetSubscriptionsItem
Match All
Show Source
Nested Schema : Subscription
Match All
Show Source
Nested Schema : ResourceLinksProperties
Type: object
Show Source
Nested Schema : SubscriptionId
Type: object
Show Source
Nested Schema : Subscription-allOf[1]
Type: object
Show Source
Nested Schema : Subscription-allOf[2]
Type: object
Show Source
Nested Schema : SubscriptionState
Type: object
Show Source
Nested Schema : SubscriptionMetadata
Type: object
Show Source
Nested Schema : Application
Type: object
Nested Schema : Plan
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 subscriptions 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 
-u apicsadmin:password
https://example.com/apiplatform/management/v1/applications/{appId}/subscriptions

{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:

  • state: The subscription's state.

  • stateComments: Comments regarding the subscription's state.

  • stateUpdatedAt: The date and time the subscription's state was last updated.

  • stateUpdatedBy: The user who last updated the subscription's state.

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

  • createdBy: The user who created the subscription.

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

  • updatedBy: The user who last updated the subscription.

  • plan.description: The plan???s description.

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

  • plan.createdBy: The user who created the plan.

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

  • plan.updatedBy: The user who last updated the plan.

  • application.description: The application???s description.

  • application.key: The application???s key.

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

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

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

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

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

  • application.types: The application???s types.

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

  • application.createdBy: The user who created the application.

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

  • application.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/applications/{appId}/subscriptions?fields=state,application.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:  Tue, 14 Mar 2017 07:47:50 GMT
Content-Length:  1243
Content-Type:  application/json
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-0001d84f
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 subscriptions and HATEOAS links to related operations.

{
    "offset": 0,
    "count": 1,
    "limit": 128,
    "hasMore": false,
    "links": [
        {
            "templated": "true",
            "method": "GET",
            "rel": "self",
            "href": "http://example.com:443/apiplatform/management/v1/applications/107/subscriptions?offset=0=128"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "canonical",
            "href": "http://example.com:443/apiplatform/management/v1/applications/107/subscriptions"
        },
        {
            "templated": "true",
            "method": "POST",
            "rel": "subscribe",
            "href": "http://example.com:443/apiplatform/management/v1/applications/107/subscriptions"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "plans",
            "href": "http://example.com:443/apiplatform/management/v1/applications/107/subscriptions/plans"
        }
    ],
    "items": [
        {
            "createdAt": "2018-02-13T01:47:47-0800",
            "stateUpdatedAt": "2018-02-13T01:47:47-0800",
            "updatedBy": "apcsadmin",
            "application": {
                "id": "107"
            },
            "createdBy": "apcsadmin",
            "links": [
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "self",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/107/subscriptions/134"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "canonical",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/107/subscriptions/134"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "suspend",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/107/subscriptions/134/state"
                },
                {
                    "templated": "true",
                    "method": "DELETE",
                    "rel": "unsubscribe",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/107/subscriptions/134"
                }
            ],
            "state": "SUBSCRIBED",
            "id": "134",
            "plan": {
                "id": "119"
            },
            "stateUpdatedBy": "apcsadmin",
            "updatedAt": "2018-02-13T01:47:47-0800"
        }
    ]
}
Back to Top