Update a transaction descriptive flex field
patch
/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/TransactionsDFF/{TransactionId2}
Request
Path Parameters
-
TransactionId(required): integer(int64)
The unique identifier of the transaction.
-
TransactionId2(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Business Unit Context for Base Transaction AttributesMaximum Length:30The context segment for the descriptive flex field. -
__FLEX_Context_DisplayValue: string
Title:
Business Unit Context for Base Transaction AttributesBusiness Unit Context for Base Transaction Attributes -
_Area_Code: string
Title:
Area CodeMaximum Length:360The geographic transaction attribute for the area code. The area code is a component of a phone number and is usually a 3-digit number that identifies each telephone service area in a country. -
_Billing_Address: number
Title:
Customer Billing Address LocationThe unique identifier of the customer billing location. -
_Billing_Contact: number
Title:
Customer Billing ContactThe unique identifier of the contact person at the bill-to location. -
_City: string
Title:
CityMaximum Length:360The name of the city. -
_City_Display: string
Title:
CityCity -
_Country: string
Title:
CountryMaximum Length:360The name of the country. -
_Country_Display: string
Title:
CountryCountry -
_Postal_Code: string
Title:
Postal CodeMaximum Length:360The postal code of the address. -
_Product_Item_ID: number
Title:
Line Item IDThe unique identifier of the inventory item. -
_Product_Item_ID_Display: string
Title:
Line Item IDLine Item ID -
_Province: string
Title:
ProvinceMaximum Length:360The name of the province. -
_Sales_Channel: string
Title:
Sales ChannelMaximum Length:30The sales channel represents how the transaction was sold. For example, indirect or direct. -
_Shipping_Address: number
Title:
Shipping Address LocationThe unique identifier of the customer's ship-to location. -
_Shipping_Contact: number
Title:
Customer Shipping ContactThe unique identifier of the contact person at the ship-to location. -
_Sold_To_Customer: number
Title:
CustomerThe unique identifier of customer who purchased the items or services listed on the transaction. -
_Sold_To_Customer_Display: string
Title:
CustomerThe name of the sold-to customer. -
_State: string
Title:
StateMaximum Length:360The name of the state. -
_State_Display: string
Title:
StateState
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : incentiveCompensationTransactions-TransactionsDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Business Unit Context for Base Transaction AttributesMaximum Length:30The context segment for the descriptive flex field. -
__FLEX_Context_DisplayValue: string
Title:
Business Unit Context for Base Transaction AttributesBusiness Unit Context for Base Transaction Attributes -
_Area_Code: string
Title:
Area CodeMaximum Length:360The geographic transaction attribute for the area code. The area code is a component of a phone number and is usually a 3-digit number that identifies each telephone service area in a country. -
_Billing_Address: number
Title:
Customer Billing Address LocationThe unique identifier of the customer billing location. -
_Billing_Contact: number
Title:
Customer Billing ContactThe unique identifier of the contact person at the bill-to location. -
_City: string
Title:
CityMaximum Length:360The name of the city. -
_City_Display: string
Title:
CityCity -
_Country: string
Title:
CountryMaximum Length:360The name of the country. -
_Country_Display: string
Title:
CountryCountry -
_Postal_Code: string
Title:
Postal CodeMaximum Length:360The postal code of the address. -
_Product_Item_ID: number
Title:
Line Item IDThe unique identifier of the inventory item. -
_Product_Item_ID_Display: string
Title:
Line Item IDLine Item ID -
_Province: string
Title:
ProvinceMaximum Length:360The name of the province. -
_Sales_Channel: string
Title:
Sales ChannelMaximum Length:30The sales channel represents how the transaction was sold. For example, indirect or direct. -
_Shipping_Address: number
Title:
Shipping Address LocationThe unique identifier of the customer's ship-to location. -
_Shipping_Contact: number
Title:
Customer Shipping ContactThe unique identifier of the contact person at the ship-to location. -
_Sold_To_Customer: number
Title:
CustomerThe unique identifier of customer who purchased the items or services listed on the transaction. -
_Sold_To_Customer_Display: string
Title:
CustomerThe name of the sold-to customer. -
_State: string
Title:
StateMaximum Length:360The name of the state. -
_State_Display: string
Title:
StateState -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionId: integer
(int64)
Title:
Transaction IDThe unique identifier of the transaction.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- LVVO_K__City
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FCITYVSO
The following properties are defined on the LOV link relation:- Source Attribute: _City; Target Attribute: Id
- Display Attribute: Value
- finder:
- LVVO_K__Country
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FCOUNTRYVSO
The following properties are defined on the LOV link relation:- Source Attribute: _Country; Target Attribute: Id
- Display Attribute: Value
- finder:
- LVVO_K__Product_Item_ID
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FBASETRANS_5FITEM_5FNAMEVSO
The following properties are defined on the LOV link relation:- Source Attribute: _Product_Item_ID; Target Attribute: Id
- Display Attribute: Value
- finder:
- LVVO_K__Sold_To_Customer
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FBASETRANS_5FCUSTOMER_5FNAMEVSO
The following properties are defined on the LOV link relation:- Source Attribute: _Sold_To_Customer; Target Attribute: Id
- Display Attribute: Value
- finder:
- LVVO_K__State
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FSTATEVSO
The following properties are defined on the LOV link relation:- Source Attribute: _State; Target Attribute: Id
- Display Attribute: Value
- finder:
- LVVO_V___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D283%2CBind_DescriptiveFlexfieldCode%3DCN_TP_BASETRANS_DFF
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context_DisplayValue; Target Attribute: Name
- Display Attribute: Name, Description
- finder:
- LVVO__City
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FCITYVSO
The following properties are defined on the LOV link relation:- Source Attribute: _City_Display; Target Attribute: Value
- Display Attribute: Value
- finder:
- LVVO__Country
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FCOUNTRYVSO
The following properties are defined on the LOV link relation:- Source Attribute: _Country_Display; Target Attribute: Value
- Display Attribute: Value
- finder:
- LVVO__Product_Item_ID
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FBASETRANS_5FITEM_5FNAMEVSO
The following properties are defined on the LOV link relation:- Source Attribute: _Product_Item_ID_Display; Target Attribute: Value
- Display Attribute: Value
- finder:
- LVVO__Sold_To_Customer
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FBASETRANS_5FCUSTOMER_5FNAMEVSO
The following properties are defined on the LOV link relation:- Source Attribute: _Sold_To_Customer_Display; Target Attribute: Value
- Display Attribute: Value
- finder:
- LVVO__State
-
Parameters:
- finder:
ValidValuesFinder%3BBind_DataSource%3Doracle.apps.incentiveCompensation.cn.transactionProcessing.transactionManagement.flex.TransactionDFF.view.TransactionDFFORA_5FCN_5FSTATEVSO
The following properties are defined on the LOV link relation:- Source Attribute: _State_Display; Target Attribute: Value
- Display Attribute: Value
- finder:
- LVVO___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D283%2CBind_DescriptiveFlexfieldCode%3DCN_TP_BASETRANS_DFF
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context; Target Attribute: ContextCode
- Display Attribute: Name
- finder:
Examples
The following example shows how to update a transaction descriptive flex field by submitting a PATCH request on the REST resource using cURL.
cURL Command
curl --user
sales_cloud_user https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/10001/child/TransactionsDFF/10001Example of Request Body
The following shows an example of the request body in JSON format.
{
"_Area_Code": "54321"
}Response Body
The following shows an example of the response body in JSON format.
{
"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",
...
}Note:
When you update a field, a transaction record is created with a new TransactionId. The ObjectStatus of the old TransactionId record is set to OBSOLETED. You must use the new TransactionId to view the changes. You can get the new TransactionId using this GET request:https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions?q=[TransactionNumber={TransactionNumber}];[TransactionType={TransactionType}]