Jump to

• Request
• Response
• Examples

Subscribe to an application

post

/developers/services/v1/applications/{id}/subscriptions

Subscribes the {appId} application.

Users requesting this resource must be assigned the API Manager, Plan 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 plan, Manage Subscribed Application, or Subscribe grant.

Request

Path Parameters

• appId: string
  A unique ID referencing a specific application.

Body ()

Root Schema : CreatePlanSubscriptionRequest

Type: object

Show Source

• planId: string
  The plan's ID.
• state: string
  The subscription's state. Valid values are SUBSCRIBED, REQUESTING, SUSPENDED, and REJECTED.
• stateComments(optional): string
  Comments regarding the subscription's state.

{
    "type":"object",
    "required":[
        "planId",
        "state"
    ],
    "properties":{
        "planId":{
            "type":"string",
            "description":"The plan's ID."
        },
        "state":{
            "type":"string",
            "description":"The subscription's state. Valid values are <code>SUBSCRIBED</code>, <code>REQUESTING</code>, <code>SUSPENDED</code>, and <code>REJECTED</code>."
        },
        "stateComments":{
            "type":"string",
            "description":"Comments regarding the subscription's state."
        }
    }
}

Back to Top

Response

201 Response

The subscription was created.

Body ()

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

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":{
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "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":{
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "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 register an application by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X POST 
-u apicsadmin:password
-H "Content-Type:application/json"
-d @register.json
https://example.com/developers/services/v1/applications/{id}/subscriptions

{id} is the unique ID for an application. To retrieve available applications, see Get applications.

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 register.json.

{
	"planid": "102",
	"state": "REGISTERED",
	"stateComments": "Requesting for registration"
}

The valid states are:

• REGISTERED

• REQUESTING

• SUSPENDED

• REJECTED

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 201 OK
Date: Fri, 05 Jan 2018 05:38:18 GMT
Content-Length:  12
Content-Type:  application/json
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-0001ddcf
X-oracle-dms-rid: 0:1

Example of Response Body

The following example shows the contents of the response body in JSON format, including ID of the registration.

{
    "id": "104"
}

Back to Top