スマート・テキスト変数置換の処理
post
/crmRestApi/resources/11.13.18.05/smartTexts/{smartTextsUniqID}/action/processSmartText
このアクションは、スマート・テキストおよび参照オブジェクトの主キーを含むjsonStringを受け入れます。 このアクションは、スマート・テキストの変数を参照オブジェクトから取得したデータに置き換えます。 または、主キーのかわりにPUIDを使用して、スマート・テキストを参照できます。
リクエスト
パス・パラメータ
- smartTextsUniqID(required): string
これは、スマート・テキスト・リソースに対してコンポジット・キー(StdTxtId、LanguageおよびStandardTextId)を構成する属性のハッシュ・キーで、スマート・テキストのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、スマート・テキストの特定のインスタンスにナビゲートするために、主キー値に対するフィルタを使用してスマート・テキスト・コレクション・リソースを問い合せる必要があります。
次に例を示します: smartTexts?q=StdTxtId=<value1>;Language=<value2>;StandardTextId=<value3>
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
- application/vnd.oracle.adf.action+json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object-
paramsValuesJson: string
変数の置換を行うために必要な情報を提供する文字列として表されるJSONオブジェクト(参照オブジェクトの値の導出に必要な情報や、導出値をオーバーライドする目的で変数値を含む)。
応答
サポートされるメディア・タイプ
- application/json
- application/vnd.oracle.adf.actionresult+json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object-
result(required): string
JSONオブジェクトは、変数値が置換されたスマート・テキストを提供する文字列値として繰り返されます。 また、ユーザー・インタフェースでプロンプトに置換できなかった変数も返します。
例:
次の例は、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": "{primaryKey: 300100547166949}"
}
]
}
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{
"result": "{\"status\":\"Success\",\"smartText\":\"Dear FirstName_a6c87992392 LastName_a6c87992392:brbrYour code request Number SR0000128147 is being attended.brbrRegards,\"}"
}