Subscribe to an application
/apiplatform/management/v1/plans/{planId}/subscriptions
Subscribes an application to the {planId}
plan.
Users requesting this resource must be assigned the API Manager, or Application Developer role and must be issued the Subscribe or Manage Subscribed Application grant for the specified plan and the Manage Application grant for the application they want to subscribe.
The subscription request is automatically approved if the user is issued the Manage API or Subscribe grant.
Request
- application/json
-
planId: string
A unique ID referencing a specific plan.
object
-
applicationId:
string
The application's ID.
-
state:
string
The subscription's state. Valid values are
SUBSCRIBED
,REQUESTING
,SUSPENDED
, andREJECTED
. -
stateComments(optional):
string
Comments regarding the subscription's state.
Response
- application/json
201 Response
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 subscribe an application to a plan by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X POST
-H "Authorization: Bearer access_token"
-H "Content-Type:application/json"
-d @subscribe.json
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.
Example of Request Body
The following shows an example of the request body in JSON format, included with the request above in a file named subscribe.json
.
{ "applicationId": "102", "state": "SUBSCRIBED", "stateComments": "Requesting subscription" }
The valid states are:
-
SUBSCRIBED
-
REQUESTING
-
SUSPENDED
-
REJECTED
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:39:38 GMT Content-Length: 12 Content-Type: application/json X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-0001ddcf 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 ID of the subscription.
{ "id": "104" }