機械翻訳について

ジャンプ先

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

サブスクリプション製品を一時停止

post

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/action/suspend

このメソッドでは、サブスクリプション製品を一時停止できます。 サブスクリプション製品Puidを一時停止するには、サブスクリプション製品Puidを指定する必要があります。

リクエスト

パス・パラメータ

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

ヘッダー・パラメータ

• 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

ソースを表示

• autoExtendFlag: boolean
• resumeDate: string (date)
• resumeDuration: number
• resumePeriod: string
• suspendedDate: string (date)
• suspendReason: string

{
    "type":"object",
    "properties":{
        "suspendReason":{
            "type":"string",
            "nullable":true
        },
        "resumePeriod":{
            "type":"string",
            "nullable":true
        },
        "resumeDuration":{
            "type":"number",
            "nullable":true
        },
        "suspendedDate":{
            "type":"string",
            "format":"date",
            "nullable":true
        },
        "autoExtendFlag":{
            "type":"boolean",
            "nullable":true
        },
        "resumeDate":{
            "type":"string",
            "format":"date",
            "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リソースに対するPOSTリクエストを発行して、サブスクリプション製品を一時停止する方法を示しています。

cURLコマンド

curl --user sales_cloud_user -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/CDRM_1/child/products/CDRM_1-PRDT-1

リクエスト本文の例

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

{ "name" : "suspend", 
       "parameters": [ 
                     {"suspendedDate":"2019-06-30"}, 
                     {"suspendReason":"ORA_BREACH"} 
                     ]
   }

レスポンス本文の例

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

{
    "result": "Success"
}

「トップに戻る」