トランザクション付加フレックスフィールドの更新
patch
/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/TransactionsDFF/{TransactionId2}
リクエスト
パス・パラメータ
- TransactionId(required): integer(int64)
トランザクションの一意の識別子。
- TransactionId2(required): integer(int64)
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
__FLEX_Context: string
タイトル:
Business Unit Context for Base Transaction Attributes
最大長:30
付加フレックスフィールドのコンテキスト・セグメントです。 -
__FLEX_Context_DisplayValue: string
タイトル:
Business Unit Context for Base Transaction Attributes
-
_Area_Code: string
タイトル:
Area Code
最大長:360
市外局番の地理トランザクション属性。 市外局番は電話番号の構成要素であり、通常は国内の各電話サービス区域を識別する3桁の番号です。 -
_Billing_Address: number
タイトル:
Customer Billing Address Location
顧客請求先事業所の一意の識別子。 -
_Billing_Contact: number
タイトル:
Customer Billing Contact
請求先事業所の担当者の一意の識別子です。 -
_City: string
タイトル:
City
最大長:360
市の名前。 -
_City_Display: string
タイトル:
City
-
_Country: string
タイトル:
Country
最大長:360
国の名前。 -
_Country_Display: string
タイトル:
Country
-
_Postal_Code: string
タイトル:
Postal Code
最大長:360
住所の郵便番号。 -
_Product_Item_ID: number
タイトル:
Line Item ID
在庫品目の一意の識別子。 -
_Product_Item_ID_Display: string
タイトル:
Line Item ID
-
_Province: string
タイトル:
Province
最大長:360
州の名前。 -
_Sales_Channel: string
タイトル:
Sales Channel
最大長:30
販売チャネルは、トランザクションの販売方法を表します。 たとえば、間接、直接などです。 -
_Shipping_Address: number
タイトル:
Shipping Address Location
顧客の出荷先事業所の一意の識別子。 -
_Shipping_Contact: number
タイトル:
Customer Shipping Contact
出荷先事業所の担当者の一意の識別子です。 -
_Sold_To_Customer: number
タイトル:
Customer
トランザクションにリストされた品目またはサービスを購入した顧客の一意の識別子。 -
_Sold_To_Customer_Display: string
タイトル:
Customer
販売先顧客の名前。 -
_State: string
タイトル:
State
最大長:360
状態の名前。 -
_State_Display: string
タイトル:
State
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : incentiveCompensationTransactions-TransactionsDFF-item-response
タイプ:
ソースを表示
object
-
__FLEX_Context: string
タイトル:
Business Unit Context for Base Transaction Attributes
最大長:30
付加フレックスフィールドのコンテキスト・セグメントです。 -
__FLEX_Context_DisplayValue: string
タイトル:
Business Unit Context for Base Transaction Attributes
-
_Area_Code: string
タイトル:
Area Code
最大長:360
市外局番の地理トランザクション属性。 市外局番は電話番号の構成要素であり、通常は国内の各電話サービス区域を識別する3桁の番号です。 -
_Billing_Address: number
タイトル:
Customer Billing Address Location
顧客請求先事業所の一意の識別子。 -
_Billing_Contact: number
タイトル:
Customer Billing Contact
請求先事業所の担当者の一意の識別子です。 -
_City: string
タイトル:
City
最大長:360
市の名前。 -
_City_Display: string
タイトル:
City
-
_Country: string
タイトル:
Country
最大長:360
国の名前。 -
_Country_Display: string
タイトル:
Country
-
_Postal_Code: string
タイトル:
Postal Code
最大長:360
住所の郵便番号。 -
_Product_Item_ID: number
タイトル:
Line Item ID
在庫品目の一意の識別子。 -
_Product_Item_ID_Display: string
タイトル:
Line Item ID
-
_Province: string
タイトル:
Province
最大長:360
州の名前。 -
_Sales_Channel: string
タイトル:
Sales Channel
最大長:30
販売チャネルは、トランザクションの販売方法を表します。 たとえば、間接、直接などです。 -
_Shipping_Address: number
タイトル:
Shipping Address Location
顧客の出荷先事業所の一意の識別子。 -
_Shipping_Contact: number
タイトル:
Customer Shipping Contact
出荷先事業所の担当者の一意の識別子です。 -
_Sold_To_Customer: number
タイトル:
Customer
トランザクションにリストされた品目またはサービスを購入した顧客の一意の識別子。 -
_Sold_To_Customer_Display: string
タイトル:
Customer
販売先顧客の名前。 -
_State: string
タイトル:
State
最大長:360
状態の名前。 -
_State_Display: string
タイトル:
State
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
TransactionId: integer (int64)
タイトル:
Transaction ID
トランザクションの一意の識別子。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
href: string
タイトル:
hyperlink reference
関連リソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連リソースの種類。 -
name: string
タイトル:
name
関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
リンク
- LVVO_K__City
-
パラメータ:
- ファインダ:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FCITYVSO
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: _City;ターゲット属性: ID
- 表示属性: 値
- ファインダ:
- LVVO_K__Country
-
パラメータ:
- ファインダ:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FCOUNTRYVSO
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: _国;ターゲット属性: ID
- 表示属性: 値
- ファインダ:
- LVVO_K__Product_Item_ID
-
パラメータ:
- ファインダ:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FBASETRANS_5FITEM_5FNAMEVSO
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: _Product_Item_ID;ターゲット属性: ID
- 表示属性: 値
- ファインダ:
- LVVO_K__Sold_To_Customer
-
パラメータ:
- ファインダ:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FBASETRANS_5FCUSTOMER_5FNAMEVSO
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: _Sold_To_Customer;ターゲット属性: ID
- 表示属性: 値
- ファインダ:
- LVVO_K__State
-
パラメータ:
- ファインダ:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FSTATEVSO
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: _State;ターゲット属性: ID
- 表示属性: 値
- ファインダ:
- LVVO_V___FLEX_Context
-
パラメータ:
- ファインダ:
ValidValuesFinder%3BBind_ApplicationId%3D283%2CBind_DescriptiveFlexfieldCode%3DCN_TP_BASETRANS_DFF
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: __FLEX_Context_DisplayValue;ターゲット属性: 名前
- 表示属性: 名前、説明
- ファインダ:
- LVVO__City
-
パラメータ:
- ファインダ:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FCITYVSO
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: _City_Display;ターゲット属性: 値
- 表示属性: 値
- ファインダ:
- LVVO__Country
-
パラメータ:
- ファインダ:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FCOUNTRYVSO
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: _Country_Display;ターゲット属性: 値
- 表示属性: 値
- ファインダ:
- LVVO__Product_Item_ID
-
パラメータ:
- ファインダ:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FBASETRANS_5FITEM_5FNAMEVSO
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: _Product_Item_ID_Display;ターゲット属性: 値
- 表示属性: 値
- ファインダ:
- LVVO__Sold_To_Customer
-
パラメータ:
- ファインダ:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FBASETRANS_5FCUSTOMER_5FNAMEVSO
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: _Sold_To_Customer_Display;ターゲット属性: 値
- 表示属性: 値
- ファインダ:
- LVVO__State
-
パラメータ:
- ファインダ:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FSTATEVSO
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: _State_Display;ターゲット属性: 値
- 表示属性: 値
- ファインダ:
- LVVO___FLEX_Context
-
パラメータ:
- ファインダ:
ValidValuesFinder%3BBind_ApplicationId%3D283%2CBind_DescriptiveFlexfieldCode%3DCN_TP_BASETRANS_DFF
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: __FLEX_Context;ターゲット属性: ContextCode
- 表示属性: 名前
- ファインダ:
例:
次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、トランザクション付加フレックスフィールドを更新する方法を示しています。
cURLコマンド
curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/10001/child/TransactionsDFF/10001
リクエスト本文の例
次に、JSON形式のリクエスト本文の例を示します。
{ "_Area_Code": "54321" }
レスポンス本文
次に、JSON形式のレスポンス本文の例を示します。
{ "TransactionId": 300100185275415, "_Sold_To_Customer": null, "_Sold_To_Customer_Display": null, "_Sales_Channel": null, "_Country": null, "_Country_Display": null, "_State": null, "_City": null, "_City_Display": null, "_Province": null, "_Area_Code": "12345", "_Postal_Code": null, "_Product_Item_ID": null, "_Product_Item_ID_Display": null, "_Billing_Address": null, "_Billing_Contact": null, "_Shipping_Address": null, "_Shipping_Contact": null, "_Transaction__DFF": null, "productGroup": null, "productGroup_Display": null, "catalogItemId": null, "corporate": null, "Team": null, "individual": null, "trigger": null, "productsold": null, "performance": null, "category": null, "task": null, "__FLEX_Context": "204", "__FLEX_Context_DisplayValue": "204", ... }
ノート:
フィールドを更新すると、新しいTransactionIdでトランザクション・レコードが作成されます。 古いTransactionIdレコードのObjectStatusは、OBSOLETEDに設定されます。 変更を表示するには、新しいTransactionIdを使用する必要があります。 次のGETリクエストを使用して、新しいTransactionIdを取得できます:https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions?q=[TransactionNumber={TransactionNumber}];[TransactionType={TransactionType}]