Jump to

• Request
• Response
• Examples

Get subscription details

get

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

Returns details of the {subId} subscription for the {planId} plan. The response also contains HATEOAS links to related operations.

Users requesting this resource must be assigned the API Manager, Application Developer or Plan Manager roles and must be issued the Application Manager or View All Details grants for the plan.

Request

Supported Media Types

• application/json

Path Parameters

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

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"
  }

• 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"
  }

Back to Top

Response

Supported Media Types

• application/json

200 Response

The subscription

Body ()

Root Schema : GetSubscriptionResponse

Match All

Show Source

• object ResourceLinksProperties
• Subscription

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

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

Match All

Show Source

• object ApplicationId
• object ApplicationIdentity
• object ApplicationDef
• object ApplicationKey
• object ApplicationMetadata

{
    "allOf":[
        {
            "$ref":"#/definitions/ApplicationId"
        },
        {
            "$ref":"#/definitions/ApplicationIdentity"
        },
        {
            "$ref":"#/definitions/ApplicationDef"
        },
        {
            "$ref":"#/definitions/ApplicationKey"
        },
        {
            "$ref":"#/definitions/ApplicationMetadata"
        }
    ]
}

Nested Schema : ApplicationId

Type: object

Show Source

• id: string
  The application's ID.

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

Nested Schema : ApplicationIdentity

Type: object

Show Source

• name: string
  The application's name.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The application's name."
        }
    }
}

Nested Schema : ApplicationDef

Type: object

Show Source

• contact(optional): object contact
  The application owner's contact information.
• description(optional): string
  The application's description.
• types(optional): array types

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The application's description."
        },
        "contact":{
            "type":"object",
            "description":"The application owner's contact information.",
            "properties":{
                "firstName":{
                    "type":"string",
                    "description":"The owner's first name."
                },
                "lastName":{
                    "type":"string",
                    "description":"The owner's last name."
                },
                "phone":{
                    "type":"string",
                    "description":"The owner's phone number."
                },
                "company":{
                    "type":"string",
                    "description":"The owner's company."
                },
                "email":{
                    "type":"string",
                    "description":"The owner's email address."
                }
            }
        },
        "types":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ApplicationKey

Type: object

Show Source

• key(optional): string
  The application's key.

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"The application's key."
        }
    }
}

Nested Schema : ApplicationMetadata

Type: object

Show Source

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

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

Nested Schema : contact

Type: object

The application owner's contact information.

Show Source

• company(optional): string
  The owner's company.
• email(optional): string
  The owner's email address.
• firstName(optional): string
  The owner's first name.
• lastName(optional): string
  The owner's last name.
• phone(optional): string
  The owner's phone number.

{
    "type":"object",
    "description":"The application owner's contact information.",
    "properties":{
        "firstName":{
            "type":"string",
            "description":"The owner's first name."
        },
        "lastName":{
            "type":"string",
            "description":"The owner's last name."
        },
        "phone":{
            "type":"string",
            "description":"The owner's phone number."
        },
        "company":{
            "type":"string",
            "description":"The owner's company."
        },
        "email":{
            "type":"string",
            "description":"The owner's email address."
        }
    }
}

Nested Schema : types

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Plan

Type: object

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 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 
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/plans/{planId}/subscriptions/{subId}

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

{subId} is the unique Id for a subscription. To retrieve available subscription Ids, see Get subscriptions.

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 10:04:07 GMT
Content-Length:  750
Content-Type:  application/json
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-0001df01
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 subscription details and HATEOAS links to related operations.

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