機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

サブスクリプションを解約

post

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/cancel

このメソッドを使用すると、サブスクリプションを取り消すことができます。 サブスクリプションを取り消すには、サブスクリプション番号を指定する必要があります。

リクエスト

パス・パラメータ

• SubscriptionNumber(required): string
  サブスクリプションの代替識別子。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

• application/vnd.oracle.adf.action+json

リクエスト本文 - application/vnd.oracle.adf.action+json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• cancelDescription: string
• canceledDate: string (date)
• cancelReason: string

{
    "type":"object",
    "properties":{
        "canceledDate":{
            "type":"string",
            "format":"date",
            "nullable":true
        },
        "cancelDescription":{
            "type":"string",
            "nullable":true
        },
        "cancelReason":{
            "type":"string",
            "nullable":true
        }
    },
    "additionalProperties":false
}

トップに戻る

応答

サポートされるメディア・タイプ

• application/json
• application/vnd.oracle.adf.actionresult+json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

本文( )

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• result(required): string
  204 response.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"204 response."
        }
    },
    "additionalProperties":false
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する投稿リクエストを発行することによってサブスクリプションを取り消す方法を示しています。

cURLコマンド

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/CDRM_15008/action/cancel

SubscriptionProductPuidを使用したリクエスト本文の例

次に、JSON形式のリクエスト本文の内容を示します。

{  
   
  
        
         "cancelReason":"ORA_PRICING",
       
         "canceledDate":"2019-06-03"
      
   
}

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

 {
 "result": "300"
}

ExternalAssetKeyを使用したリクエスト本文の例

次に、JSON形式のリクエスト本文の内容を示します。

{
 "name":"calculateEarlyTerminationFee",
 "parameters":[
 {"externalAssetKey": "Asset-001"},
 {"closedDate": "2020-09-29"}
 ]
}

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
 "result": "300"
}

ノート:

サブスクリプション製品PUIDと外部アセット・キーの両方を渡すと、製品PUIDが考慮されます。

「トップに戻る」