コマース・プロセス設定REST API

Oracle CPQ 26Aでは、Redwoodスタイルの管理ページをサポートする次のエンドポイントが導入されています。

コマース・プロセス暗号化キー・ステータスの取得

このエンドポイントを使用して、指定したコマース・プロセスに有効な暗号化キー証明書があるかどうかを確認します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/hasValidCertificate
メソッド: GET

プロセス・マネージャ

コマース・プロセス・マネージャ列の追加

このエンドポイントを使用して、コマース・プロセス・マネージャ列を追加します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/processColumns
メソッド: POST

コマース・プロセス・マネージャ列の削除

このエンドポイントを使用して、指定したコマース・プロセス・マネージャ列を削除します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/processColumns/delete
メソッド: POST

コマース・プロセス・マネージャ列の更新

このエンドポイントを使用して、指定したコマース・プロセス・マネージャ列を更新します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/processColumns/{columnId}
方法: PATCH

処理

コマース文書処理のクローニング

このエンドポイントを使用して、指定したコマース・ドキュメント・アクションをクローニングします。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/actions/{actionVarName}/clone
メソッド: POST

コマース・コピー処理コピー順序の作成

このエンドポイントを使用して、指定したコマース・プロセス処理のコピー順序を追加します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/actions/{actionVarName}/copySequence
メソッド: POST

コマース文書処理の作成

このエンドポイントを使用して、ドキュメント・アクションを追加します。ドキュメントIDはリクエスト本文で指定されます。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/actions
メソッド: POST

コマース文書処理の削除

このエンドポイントを使用して、指定したコマース・ドキュメント・アクションを削除します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}
/actions/delete
メソッド: POST

コマース・コピー処理コピー順序の更新

このエンドポイントを使用して、指定したコマース・プロセス・コピー処理コピー順序を更新します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/actions/{actionVarName}/copySequence/{sequenceId}
方法: PATCH

コマース・プロセス処理の更新

このエンドポイントを使用して、指定したコマース・プロセス・アクションを更新します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/actions/{actionVarName}
メソッド: PATCH

コマース・プロセス処理アクセス権限の更新

このエンドポイントを使用して、指定したコマース・プロセス処理のアクセス権を更新します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/actions/{actionVarName}/accessRights
方法: PATCH

属性

システム属性の取得

このエンドポイントを使用して、システム変数属性を取得します。

エンドポイント: /rest/v19/commerceProcessSetups/systemAttributes
メソッド: GET

コマース属性の作成

このエンドポイントを使用して、指定したコマース・ドキュメントに属性を追加します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributes
メソッド: POST

コマース属性の削除

このエンドポイントを使用して、指定したコマース・ドキュメント属性を削除します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributes/delete
メソッド: POST

コマース属性参照の取得

このエンドポイントを使用して、指定したコマース・ドキュメント属性の属性参照を取得します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/references
メソッド: GET

コマース属性設定の取得

このエンドポイントを使用して、指定したコマース・ドキュメント属性の属性設定を取得します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/settings
メソッド: GET

コマース属性タイプの取得

このエンドポイントを使用して、指定したコマース・ドキュメントの属性タイプを取得します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributeTypes
メソッド: GET

コマース属性の更新

このエンドポイントを使用して、指定したコマース・ドキュメント属性を更新します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}
メソッド: PATCH

配列セット

コマース配列セットの作成

このエンドポイントを使用して、指定したコマース・ドキュメントに配列セットを追加します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/arraySets
メソッド: POST

コマース配列セットの削除

このエンドポイントを使用して、指定したコマース・ドキュメント配列セットを削除します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/arraySets/delete
メソッド: POST

コマース配列セット参照の取得

このエンドポイントを使用して、指定したコマース・ドキュメント配列セットの配列セット参照を取得します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/arraySets/{arraySetVarName}/references
メソッド: GET

コマース手数料配列セットの同期

このエンドポイントを使用して、コマース・ドキュメント料金配列セットを同期します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/synchronizeChargeSet
メソッド: POST

コマース配列セットの更新

このエンドポイントを使用して、指定したコマース・ドキュメント配列セットを更新します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/arraySets/{arraySetVarName}
メソッド: PATCH

属性セット

コマース属性セットの削除

このエンドポイントを使用して、指定したコマース・ドキュメント属性セットを削除します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributeSets/delete
メソッド: POST

コマース属性セットの作成

このエンドポイントを使用して、指定したコマース・ドキュメントに属性セットを追加します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributeSets
メソッド: POST

コマース部品属性セット属性オプションの取得

このエンドポイントを使用して、コマース文書部品属性セットの属性オプションを取得します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributeSets/{attrSetVarName}/manageAttributeOptions
メソッド: GET

コマース部品属性セット属性オプションの更新

このエンドポイントを使用して、コマース文書部品属性セットの属性オプションを更新します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/attributeSets/{attrSetVarName}/manageAttributeOptions
メソッド: PATCH

ライブラリ関数

コマース・ライブラリ機能の作成

このエンドポイントを使用して、コマース・ライブラリ関数を追加します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions
メソッド: POST

コマース・ライブラリ機能のデバッグ

このエンドポイントを使用して、指定したコマース・ドキュメント・ライブラリ関数をデバッグします。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions/actions/debug
メソッド: POST

コマース・ライブラリ関数の削除

このエンドポイントを使用して、指定したコマース・ドキュメント・ライブラリ関数を削除します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions/{functionVarName}
メソッド: DELETE

コマース・ライブラリ関数の取得

このエンドポイントを使用して、指定したコマース・ドキュメントのライブラリ関数を取得します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions
メソッド: GET

コマース・ライブラリ関数の取得

このエンドポイントを使用して、指定したコマース・ドキュメント・ライブラリ関数を取得します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions/{functionVarName}
メソッド: GET

コマース・ライブラリ関数の依存属性の取得

このエンドポイントを使用して、指定したコマース・ドキュメント・ライブラリ関数のすべての依存属性を取得します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions/actions/dependentAttributes
メソッド: POST

コマース・ライブラリ機能トランザクション・データのロード

このエンドポイントを使用して、リクエストされたコマース・ドキュメント・ライブラリ関数の属性値を取得します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions/actions/loadTransactionData
メソッド: POST

コマース・ライブラリ機能の更新

このエンドポイントを使用して、指定したコマース・ドキュメント・ライブラリ関数を更新します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions/{functionVarName}
メソッド: PATCH

コマース・ライブラリ関数の検証

このエンドポイントを使用して、指定したコマース・ドキュメント・ライブラリ関数を検証します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/bml/library/functions/actions/validate
メソッド: POST

すべてのコマース属性参照の取得

このエンドポイントは、指定されたコマース・プロセスのすべての属性参照を取得します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/bml/attributeLookups
メソッド: GET

コマース属性参照の取得

このエンドポイントを使用して、指定したコマース・プロセス属性参照の参照タイプ詳細を取得します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/bml/attributeLookups/{lookupType}
メソッド: GET

コマース属性参照値の取得

このエンドポイントを使用して、特定のコマース・プロセス属性参照の参照値を取得します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/bml/attributeLookups/{lookupType}/lookupValues
メソッド: GET

パフォーマンス

パフォーマンス・レポートの生成

このエンドポイントを使用して、パフォーマンス・レポートを生成します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/performance
メソッド: POST

BML数の取得

このエンドポイントを使用して、分析するBML関数をカウントします。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/performance/{actionId}
メソッド: GET

ルール

コマース・ルール条件の取得

このエンドポイントを使用して、指定したコマース・ドキュメント・ルールのルール条件を取得します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/rules/{ruleVarName}/ruleCondition
メソッド: GET

単純条件の拡張条件への変換

このエンドポイントを使用して、指定したコマース・ドキュメントの単純条件を拡張条件に変換します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/documents/{docVarName}/ruleCondition/convertToAdvanced
メソッド: POST

ビューとテンプレート

印刷用XSLビューのコピー

このエンドポイントを使用して、指定したコマース・プロセス・プリンタ対応XSLビューをコピーします。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/printerFriendlyXSLViews/actions/copy
メソッド: POST

印刷用XSLビューの作成

このエンドポイントを使用して、指定したコマース・プロセスにプリンタ対応XSLビューを追加します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/printerFriendlyXSLViews
メソッド: POST

印刷用XSLビューの削除

このエンドポイントを使用して、指定したコマース・プロセス・プリンタ対応XSLビューを削除します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/printerFriendlyXSLViews/actions/delete
メソッド: POST

印刷用XSLビュー設定の取得

このエンドポイントを使用して、指定したコマース・プロセスのプリンタ対応XSLビュー設定を取得します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/printerFriendlyXSLViews/settings
メソッド: GET

印刷用XSLビューの更新

このエンドポイントを使用して、指定したコマース・プロセス・プリンタ対応XSLビューを更新します。

エンドポイント: /rest/v19/commerceProcessSetups/{processVarName}/printerFriendlyXSLViews/{xslVarName}
方法: PATCH

Oracle CPQ 26Aでは、Redwoodスタイルの管理ページがサポートされています。

有効化および構成ステップ

REST APIガイドのRESTサービス定義を確認して、活用してください(Oracle Help Center > 「関心のあるアプリケーション・サービス領域」 > 「API &スキーマ」から入手できます)。 OracleのRESTサービスを初めて利用する場合は、クイック・スタートに関する項から開始してください。