機械翻訳について

ジャンプ先

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

一意の識別子によるスマート・テキスト変数置換の処理

post

/crmRestApi/resources/11.13.18.05/smartTexts/action/processSmartTextById

このアクションは、スマート・テキストおよび参照オブジェクトの主キーを含むjsonStringを受け入れます。 次に、スマート・テキストの変数を参照オブジェクトから取得したデータに置き換えます。 または、主キーのかわりに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

ソースを表示

• paramsValuesJson: string
  スマート・テキスト一意識別子、参照オブジェクトの値の導出に必要な情報、導出値を上書きする目的で変数値など、変数置換を実行するために必要な情報を提供する文字列として表されるJSONオブジェクト。

{
    "type":"object",
    "properties":{
        "paramsValuesJson":{
            "type":"string",
            "description":"A JSON Object represented as a string that provides necessary information to do the variable substitution including the smart text unique identifier, those needed for deriving values for the referenced object and any variable values for the purpose of overriding derived values.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

トップに戻る

応答

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

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

デフォルトのレスポンス

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

本文( )

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

タイプ: object

ソースを表示

• result(required): string
  JSONオブジェクトは、変数値が置換されたスマート・テキストを提供する文字列値として繰り返されます。 また、ユーザー・インタフェースでプロンプトに置換できなかった変数も返します。

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"A JSON Object repesented as a string value that provides the smart text with the variables values substituted.  Also returns the variables that could not be substituted for prompting on the user interface."
        }
    },
    "additionalProperties":false
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してpostリクエストを発行することによって、一意の識別子によるスマート・テキスト変数置換を処理する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/smartTexts/00020000000255530000000EACED00057708000110F09A830876

リクエスト本文の例

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

{
    "name": "processSmartText",
    "parameters": [
        {
            "paramsValuesJson": "{puid: SR0000128147}"
        }
    ]
}

レスポンス本文の例

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

{
    "result": "{\"status\":\"Success\",\"smartText\":\"Dear FirstName_a6c87992392 LastName_a6c87992392:brbrYour code request Number SR0000128147 is being attended.brbrRegards,\"}"
}

「トップに戻る」