機械翻訳について

ジャンプ先

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

アクション・プランのリフレッシュ

post

/crmRestApi/resources/11.13.18.05/actionplans/action/refreshActionPlan

すでに開始されている処理プランをリフレッシュします。

リクエスト

ヘッダー・パラメータ

• 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

ソースを表示

• actionPlanId: number
  処理プランの一意の識別子。
• refreshProcess: boolean
  エラーが発生したプロセス・アクションが再開されたかどうかを示します。
• softRefresh: boolean
  自動リフレッシュが実行されるかどうかを示します。

{
    "type":"object",
    "properties":{
        "actionPlanId":{
            "type":"number",
            "description":"The unique identifier of the action plan.",
            "nullable":true
        },
        "refreshProcess":{
            "type":"boolean",
            "description":"Indicates whether an errored process action is re-initiated or not.",
            "nullable":true
        },
        "softRefresh":{
            "type":"boolean",
            "description":"Indicates whether an auto-refresh is performed.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

トップに戻る

応答

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

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

デフォルトのレスポンス

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

本文( )

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

タイプ: object

ソースを表示

• result(required): string
  リフレッシュが成功した場合、アクション・プランIDを含むレスポンス本文を返すか、エラー・メッセージを返します。

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Returns a response body that contains the action plan id if the refresh is successful, or returns an error message."
        }
    },
    "additionalProperties":false
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによって、アクション・プランをリフレッシュする方法を示しています。

cURLコマンド

curl -u <username:password> \ -X POST  https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/actionplans/action/refreshActionPlan

リクエスト本文の例

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

{

"actionPlanId":300100148450214,

"softRefresh":false

} 

レスポンス本文の例

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

{
  "result": "300100148450214"
}

「トップに戻る」