Update a flexfield
patch
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentDFF/{assignmentDFFUniqID}
Request
Path Parameters
-
assignmentDFFUniqID(required): string
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=
-
assignmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Assignments resource and used to uniquely identify an instance of Assignments. The client should not generate the hash key value. Instead, the client should query on the Assignments collection resource in order to navigate to a specific instance of Assignments to get the hash key.
-
empsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Employees resource and used to uniquely identify an instance of Employees. The client should not generate the hash key value. Instead, the client should query on the Employees collection resource in order to navigate to a specific instance of Employees to get the hash key.
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 Value
Maximum Length:30
Descriptive flexfield for assignment. Valid values are defined in the list LVVO___FLEX_Context. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Descriptive flexfield for assignment. -
EffectiveLatestChange: string
Title:
Effective Latest Change
Maximum Length:30
Descriptive flexfield for assignment. -
EffectiveSequence: integer
(int32)
Title:
Effective Sequence
Descriptive flexfield for assignment. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Descriptive flexfield for assignment.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : emps-assignments-assignmentDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield for assignment. Valid values are defined in the list LVVO___FLEX_Context. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
AssignmentId: integer
(int64)
Title:
Assignment ID
-
AssignmentType: string
Title:
Assignment Type
Maximum Length:30
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Descriptive flexfield for assignment. -
EffectiveLatestChange: string
Title:
Effective Latest Change
Maximum Length:30
Descriptive flexfield for assignment. -
EffectiveSequence: integer
(int32)
Title:
Effective Sequence
Descriptive flexfield for assignment. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Descriptive flexfield for assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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%3D800%2CBind_DescriptiveFlexfieldCode%3DPER_ASG_DF
- finder:
- LVVO___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D800%2CBind_DescriptiveFlexfieldCode%3DPER_ASG_DF
- finder:
Examples
The following example shows how to update an assignment descriptive flexfield by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d <payload> https://<host>:<port>/hcmRestApi/resources/11.13.18.05/emps/00020000000EACED00057708000000000000016F0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000015E9C958C0078/child/assignments/00040000000EACED00057708000110F081FE539FFFFFFFFFFFFFFFFF0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000015EE4AE940078/child/assignmentDFF/00050000000EACED00057708000110F081FE539F0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000015EC0A21000780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000015F182E2C00780000000AACED00057704000000010000000159
Example of Payload
The following is an example of the payload
{ "hdlG": "test", "jobFlex": 210, "testS": null, "__FLEX_Context": "PER_ASG_DF", "__FLEX_Context_DisplayValue": "PER_ASG_DF", "_Currency": null, "FBLAL": "FB Label 23", "hdlL3": null, "hdlL2": null }
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK Content-Type : application/json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "AssignmentId": 300100135834527, "EffectiveStartDate": "2017-09-27", "EffectiveEndDate": "2017-10-14", "EffectiveSequence": 1, "EffectiveLatestChange": "Y", "AssignmentType": "E", "costCenter": null, "hdlG": "test", "jobFlex": 210, "gsAsg01": null, "gsAsg02": null, "gsAsg03": null, "testS": null, "__FLEX_Context": "PER_ASG_DF", "__FLEX_Context_DisplayValue": "PER_ASG_DF", "_Currency": null, "_asg_cntx": null, "FBLAL": "FB Label 23", "hdlL3": null, "hdlL2": null, "links": [ {...} ] }