Jump to

• Request
• Response
• Examples

Update subscription state

put

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

Updates the state of the {subId} subscription for the {planId} plan.

Users requesting this resource must be assigned the API Manager, Plan Manager or Application Developer role. If the current subscription state is REQUESTING, the user must be issued the Manage Plan grant for the associated API. For all other states, the user must be issued the Manage API, Sunscribe, or Manage Subscribed Application grant to the associated API/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.

Body ()

Root Schema : UpdateSubscriptionStateRequest

Type: object

Show Source

• state: string
  The subscription's state. Valid values depend on the current subscription state. If the state is REQUESTING, it can be updated to REJECTED, SUBSCRIBED, or SUSPENDED. If the state is SUBSCRIBED, it can be updated to SUSPENDED. If the state is SUSPENDED, it can be updated to SUBSCRIBED. If the state is REJECTED, it can't be updated.
• stateComments(optional): string
  Comments regarding the subscription's state.

{
    "type":"object",
    "required":[
        "state"
    ],
    "properties":{
        "state":{
            "type":"string",
            "description":"The subscription's state. Valid values depend on the current subscription state. If the state is <code>REQUESTING</code>, it can be updated to <code>REJECTED</code>, <code>SUBSCRIBED</code>, or <code>SUSPENDED</code>. If the state is <code>SUBSCRIBED</code>, it can be updated to <code>SUSPENDED</code>. If the state is <code>SUSPENDED</code>, it can be updated to <code>SUBSCRIBED</code>. If the state is <code>REJECTED</code>, it can't be updated."
        },
        "stateComments":{
            "type":"string",
            "description":"Comments regarding the subscription's state."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The subscription's state was updated.

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 update the state of a subscription to a plan by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X PUT 
-H "Content-Type:application/json"
-d @sub-state.json
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/plans/{planId}/subscriptions/{subId}/state

• {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 Request Body

The following shows an example of the request body in JSON format, included with the request above in a file named sub-state.json.

{
"state":"SUBSCRIBED",
"stateComments": "Approving subscription"
}

Valid states depend on the existing state of the subscription:

• If the existing state is SUBSCRIBED, you can change the state to SUSPENDED.

• If the existing state is REQUESTING, you can change the state to REJECTED, SUBSCRIBED, or SUSPENDED.

• If the existing state is SUSPENDED you can change the state to SUBSCRIBED.

• If the existing state is REJECTED, you can not update the state.

.

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 204 No Content
Server: Oracle-Traffic-Director/12.2.1.0.0
Date:  Wed, 15 Mar 2017 05:59:59 GMT
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-000219fc
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

Back to Top