Update one flexfield
patch
/fscmRestApi/resources/11.13.18.05/workOrders/{WorkOrderId}/child/WorkOrderDFF/{WorkOrderId3}
Request
Path Parameters
-
WorkOrderId(required): integer(int64)
Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order.
-
WorkOrderId3(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:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for work orders. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for work orders. -
WorkOrderId: integer
(int64)
Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order.
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 : workOrders-WorkOrderDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for work orders. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for work orders. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WorkOrderId: integer
(int64)
Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- LVVO_V___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D10493%2CBind_DescriptiveFlexfieldCode%3DWIE_WORK_ORDERS
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%3D10493%2CBind_DescriptiveFlexfieldCode%3DWIE_WORK_ORDERS
List of values that the user uses to set the context value for the work order that the descriptive flexfield references.
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 one 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/workOrders/WorkOrderId/child/WorkOrderDFF/WorkOrderId2"
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.
{ "gs1" : "4", }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "WorkOrderId" : 300100141973514, "gs1" : "4", "gs2" : 45, "__FLEX_Context" : null, "__FLEX_Context_DisplayValue" : null }