Update
patch
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsEFF/{assignmentsEFFUniqID}
Request
Path Parameters
-
PeriodOfServiceId(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=
-
assignmentsEFFUniqID(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--- AssignmentId, EffectiveStartDate, EffectiveEndDate, EffectiveSequence and EffectiveLatestChange ---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 with a filter on the primary key values in order to navigate to a specific instance of Assignments.
For example: assignments?q=AssignmentId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3>;EffectiveSequence=<value4>;EffectiveLatestChange=<value5> -
workersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Workers resource and used to uniquely identify an instance of Workers. The client should not generate the hash key value. Instead, the client should query on the Workers collection resource in order to navigate to a specific instance of Workers to get the hash key.
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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 : Discriminator: CategoryCode
Type:
object
Discriminator: CategoryCode
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-patch-request
Type:
Show Source
object
-
CategoryCode: string
Title:
EFF Context
Maximum Length:80
Default Value:PER_ASG_EIT
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveLatestChange: string
Title:
Effective Latest Change
Maximum Length:30
-
EffectiveSequence: integer
(int32)
Title:
Effective Sequence
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
InformationORA_5FPER_5FRET_5FGRADEprivateVO: array
InformationORA_5FPER_5FRET_5FGRADEprivateVO
Nested Schema : emps-assignments-assignmentExtraInformation-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-patch-request
Type:
Show Source
object
-
AeiInformationCategory: string
Maximum Length:
30
Default Value:ORA_PER_RET_GRADE
-
AssignmentExtraInfoId: integer
(int64)
-
AssignmentId(required): integer
(int64)
-
BusinessGroupId(required): integer
(int64)
-
EffectiveEndDate(required): string
(date)
Title:
Effective End Date
-
EffectiveLatestChange: string
Maximum Length:
30
Default Value:Y
-
EffectiveSequence: integer
(int32)
Default Value:
1
-
EffectiveStartDate(required): string
(date)
Title:
Effective Start Date
-
endDate(required): string
(date)
Title:
End Date
-
frequency: string
Title:
Pay Basis
Maximum Length:150
-
grade: string
Title:
Grade
Maximum Length:150
-
grade_Display: string
Title:
Grade
-
gradeLadder: string
Title:
Pay Table ID
Maximum Length:150
-
gradeLadder_Display: string
Title:
Pay Table ID
-
payPlan: string
Title:
Pay Plan
Maximum Length:150
-
primaryIndicator(required): string
Title:
Primary Indicator
Maximum Length:150
-
primaryIndicator_Display: string
Title:
Primary Indicator
-
startDate(required): string
(date)
Title:
Start Date
-
step: string
Title:
Step
Maximum Length:150
-
step_Display: string
Title:
Step
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 : Discriminator: CategoryCode
Type:
object
Discriminator: CategoryCode
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Title:
Assignment ID
-
AssignmentType: string
Title:
Assignment Type
Maximum Length:30
-
CategoryCode: string
Title:
EFF Context
Maximum Length:80
Default Value:PER_ASG_EIT
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveLatestChange: string
Title:
Effective Latest Change
Maximum Length:30
-
EffectiveSequence: integer
(int32)
Title:
Effective Sequence
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
InformationORA_5FPER_5FRET_5FGRADEprivateVO: array
InformationORA_5FPER_5FRET_5FGRADEprivateVO
-
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 : emps-assignments-assignmentExtraInformation-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-response
Type:
Show Source
object
-
AeiInformationCategory: string
Maximum Length:
30
Default Value:ORA_PER_RET_GRADE
-
AssignmentExtraInfoId: integer
(int64)
-
AssignmentId: integer
(int64)
-
BusinessGroupId: integer
(int64)
-
CreationDate: string
(date-time)
Read Only:
true
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveLatestChange: string
Maximum Length:
30
Default Value:Y
-
EffectiveSequence: integer
(int32)
Default Value:
1
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
endDate: string
(date)
Title:
End Date
-
frequency: string
Title:
Pay Basis
Maximum Length:150
-
grade: string
Title:
Grade
Maximum Length:150
-
grade_Display: string
Title:
Grade
-
gradeLadder: string
Title:
Pay Table ID
Maximum Length:150
-
gradeLadder_Display: string
Title:
Pay Table ID
-
LastUpdateDate: string
(date-time)
Read Only:
true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
payPlan: string
Title:
Pay Plan
Maximum Length:150
-
primaryIndicator: string
Title:
Primary Indicator
Maximum Length:150
-
primaryIndicator_Display: string
Title:
Primary Indicator
-
startDate: string
(date)
Title:
Start Date
-
step: string
Title:
Step
Maximum Length:150
-
step_Display: string
Title:
Step
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.