Jump to

• Request
• Response
• Examples

Get subscriptions

get

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

Returns collections of subscriptions and applications for the {planId} plan.

Users requesting this resource must be assigned the API Manager, Application Developr, or Plan Manager role and must be issued the Application Manager or View All Details grant for the plan.

Request

Supported Media Types

• application/json

Path Parameters

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

Query Parameters

• 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.

  • [0]: string

  {
      "name":"expand",
      "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 expand values.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• 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
• links(optional): array
  Collection Format: csv

  Filter the specified link rel's.

  • [0]: string

  {
      "name":"links",
      "in":"query",
      "description":"Filter the specified link rel's.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• 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 subscriptions

Body ()

Root Schema : GetSubscriptionsResponse

Match All

Show Source

• object CollectionResponseFeature
• object CollectionResponsePagingFeature
• object LinksResponseFeature
• object GetSubscriptionsResponse-allOf[3]

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

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

Type: object

Show Source

• links(optional): array links
  Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : GetSubscriptionsResponse-allOf[3]

Type: object

Show Source

• items(optional): array items

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

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

• Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

Nested Schema : HATEOASLink

Type: object

Show Source

• href(optional): string
  Link href.
• method(optional): string
  HTTP Operation GET, POST, PUT
• rel(optional): string
  Link relation.

{
    "type":"object",
    "properties":{
        "method":{
            "type":"string",
            "description":"HTTP Operation GET, POST, PUT"
        },
        "rel":{
            "type":"string",
            "description":"Link relation."
        },
        "href":{
            "type":"string",
            "description":"Link href."
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: GetSubscriptionsItem

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

Nested Schema : GetSubscriptionsItem

Match All

Show Source

• Subscription
• object ResourceLinksProperties

{
    "allOf":[
        {
            "$ref":"#/definitions/Subscription"
        },
        {
            "$ref":"#/definitions/ResourceLinksProperties"
        }
    ]
}

Nested Schema : Subscription

Match All

Show Source

• object SubscriptionId
• object Subscription-allOf[1]
• object Subscription-allOf[2]
• object SubscriptionState
• object SubscriptionMetadata

{
    "allOf":[
        {
            "$ref":"#/definitions/SubscriptionId"
        },
        {
            "type":"object",
            "properties":{
                "application":{
                    "$ref":"#/definitions/Application"
                }
            }
        },
        {
            "type":"object",
            "properties":{
                "plan":{
                    "$ref":"#/definitions/Plan"
                }
            }
        },
        {
            "$ref":"#/definitions/SubscriptionState"
        },
        {
            "$ref":"#/definitions/SubscriptionMetadata"
        }
    ]
}

Nested Schema : ResourceLinksProperties

Type: object

Show Source

• links(optional): array links
  Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : SubscriptionId

Type: object

Show Source

• id: string
  The subscription's ID.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The subscription's ID."
        }
    }
}

Nested Schema : Subscription-allOf[1]

Type: object

Show Source

• application(optional): object Application

{
    "type":"object",
    "properties":{
        "application":{
            "$ref":"#/definitions/Application"
        }
    }
}

Nested Schema : Subscription-allOf[2]

Type: object

Show Source

• plan(optional): object Plan

{
    "type":"object",
    "properties":{
        "plan":{
            "$ref":"#/definitions/Plan"
        }
    }
}

Nested Schema : SubscriptionState

Type: object

Show Source

• state(optional): string
  The subscription's state.
• stateComments(optional): string
  Comments regarding the subscription's state.
• stateUpdatedAt(optional): string
  The date and time the subscription's state was last updated.
• stateUpdatedBy(optional): string
  The user who last updated the subscription's state.

{
    "type":"object",
    "properties":{
        "state":{
            "type":"string",
            "description":"The subscription's state."
        },
        "stateComments":{
            "type":"string",
            "description":"Comments regarding the subscription's state."
        },
        "stateUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the subscription's state."
        },
        "stateUpdatedAt":{
            "type":"string",
            "description":"The date and time the subscription's state was last updated."
        }
    }
}

Nested Schema : SubscriptionMetadata

Type: object

Show Source

• createdAt(optional): string
  The date and time the subscription was created.
• createdBy(optional): string
  The user who created the subscription.
• updatedAt(optional): string
  The date and time the subscription was last updated.
• updatedBy(optional): string
  The user who last updated the subscription.

{
    "type":"object",
    "properties":{
        "createdBy":{
            "type":"string",
            "description":"The user who created the subscription."
        },
        "createdAt":{
            "type":"string",
            "description":"The date and time the subscription was created."
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the subscription."
        },
        "updatedAt":{
            "type":"string",
            "description":"The date and time the subscription was last updated."
        }
    }
}

Nested Schema : Application

Type: object

Nested Schema : Plan

Type: object

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

• Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

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 available subscriptions and applications for 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

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

• 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.

• 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/plans/{planId}/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 09:53:30 GMT
Content-Length:  1209
Content-Type:  application/json
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-0001de7c
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 plan and 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/plans/119/subscriptions?offset=0&=128"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "canonical",
            "href": "http://example.com:443/apiplatform/management/v1/plans/119/subscriptions"
        },
        {
            "templated": "true",
            "method": "POST",
            "rel": "subscribe",
            "href": "http://example.com:443/apiplatform/management/v1/plans/119/subscriptions"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "applications",
            "href": "http://example.com:443/apiplatform/management/v1/plans/119/subscriptions/applications"
        }
    ],
    "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/plans/119/subscriptions/134"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "canonical",
                    "href": "http://example.com:443/apiplatform/management/v1/plans/119/subscriptions/134"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "suspend",
                    "href": "http://example.com:443/apiplatform/management/v1/plans/119/subscriptions/134/state"
                },
                {
                    "templated": "true",
                    "method": "DELETE",
                    "rel": "unsubscribe",
                    "href": "http://example.com:443/apiplatform/management/v1/plans/119/subscriptions/134"
                }
            ],
            "state": "SUBSCRIBED",
            "id": "134",
            "plan": {
                "id": "119"
            },
            "stateUpdatedBy": "apcsadmin",
            "updatedAt": "2018-02-13T01:47:47-0800"
        }
    ]
}

Back to Top