Update a flexfield
/fscmRestApi/resources/11.13.18.05/shipmentTransactionRequests/{TransactionId}/child/shipments/{DeliveryInterfaceId}/child/costs/{FreightCostInterfaceId}/child/DFF/{FreightCostInterfaceId2}
Request
-
DeliveryInterfaceId(required): integer(int64)
Value that uniquely identifies the candidate shipment.
-
FreightCostInterfaceId(required): integer(int64)
Value that uniquely identifies the candidate shipping cost.
-
FreightCostInterfaceId2(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=
-
TransactionId(required): integer(int64)
Value that uniquely identifies the shipment transaction request.
-
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.
- application/json
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value. -
FreightCostInterfaceId: integer
(int64)
Value that uniquely identifies the candidate shipping cost.
Response
- application/json
Default Response
-
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.
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value. -
FreightCostInterfaceId: integer
(int64)
Value that uniquely identifies the candidate shipping cost.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
array
Links
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
- LVVO_V___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D665%2CBind_DescriptiveFlexfieldCode%3DWSH_FREIGHT_COSTS
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context_DisplayValue; Target Attribute: Name
- Display Attribute: Name, Description
- finder:
- LVVO___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D665%2CBind_DescriptiveFlexfieldCode%3DWSH_FREIGHT_COSTS
List of values that sets the context value of the descriptive flexfield.
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context; Target Attribute: ContextCode
- Display Attribute: Name
- finder:
Examples
This example describes how to update a flexfield.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/TransactionId/child/shipments/DeliveryInterfaceId/child/costs/FreightCostInterfaceId/child/DFF/FreightCostInterfaceId2"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "_Global1": "G1", "_Global2": "G2", "__FLEX_Context": "Context1" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "FreightCostInterfaceId": 300100169688188, "_Global1": "G1", "_Global2": "G2", "__FLEX_Context": "Context1", "__FLEX_Context_DisplayValue": "Context1", "_Context1Col1": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688173/child/shipments/300100169688174/child/costs/300100169688188/child/DFF/300100169688188", "name": "DFF", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688173/child/shipments/300100169688174/child/costs/300100169688188/child/DFF/300100169688188", "name": "DFF", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688173/child/shipments/300100169688174/child/costs/300100169688188", "name": "costs", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688173/child/shipments/300100169688174/child/costs/300100169688188/child/DFF/300100169688188/lov/LVVO___FLEX_Context", "name": "LVVO___FLEX_Context", "kind": "collection" } ] }