Update a worker name
patch
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/names/{namesUniqID}
Request
Path Parameters
-
namesUniqID(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=
-
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 : schema
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
FirstName: string
Title:
First Name
Maximum Length:150
Person's first name. -
Honors: string
Title:
Honors
Maximum Length:80
Higher qualification appended to a person's name such as PhD. -
KnownAs: string
Title:
Known As
Maximum Length:80
Person's preferred name. -
LastName: string
Title:
Last Name
Maximum Length:150
Person's last name. -
LegislationCode: string
Title:
Country
Maximum Length:4
Legislation code. Valid values are defined in the hcmCountriesLov. -
LocalEffectiveEndDate: string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
LocalEffectiveStartDate: string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
LocalFirstName: string
Title:
First Name
Maximum Length:150
Person's first name in local language. -
LocalHonors: string
Title:
Honors
Maximum Length:80
Higher qualification appended to a person's name such as PhD in local language. -
LocalKnownAs: string
Title:
Known As
Maximum Length:80
Person's preferred name in local language. -
LocalLastName: string
Title:
Last Name
Maximum Length:150
Person's last name in local language. -
LocalLegislationCode: string
Title:
Country
Maximum Length:4
Legislation code of the local language. Valid values are defined in the hcmCountriesLov. -
LocalMiddleNames: string
Title:
Middle Names
Maximum Length:80
Person's middle name in local language. -
LocalMilitaryRank: string
Title:
Military Rank
Maximum Length:80
Person's military rank in local language. -
LocalNameInformation1: string
Title:
Name Information 1
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation10: string
Title:
Name Information 10
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation11: string
Title:
Name Information 11
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation12: string
Title:
Name Information 12
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation13: string
Title:
Name Information 13
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation14: string
Title:
Name Information 14
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation15: string
Title:
Name Information 15
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation16: string
Title:
Name Information 16
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation17: string
Title:
Name Information 17
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation18: string
Title:
Name Information 18
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation19: string
Title:
Name Information 19
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation2: string
Title:
Name Information 2
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation20: string
Title:
Name Information 20
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation21: string
Title:
Name Information 21
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation22: string
Title:
Name Information 22
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation23: string
Title:
Name Information 23
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation24: string
Title:
Name Information 24
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation25: string
Title:
Name Information 25
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation26: string
Title:
Name Information 26
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation27: string
Title:
Name Information 27
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation28: string
Title:
Name Information 28
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation29: string
Title:
Name Information 29
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation3: string
Title:
Name Information 3
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation30: string
Title:
Name Information 30
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation4: string
Title:
Name Information 4
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation5: string
Title:
Name Information 5
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation6: string
Title:
Name Information 6
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation7: string
Title:
Name Information 7
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation8: string
Title:
Name Information 8
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation9: string
Title:
Name Information 9
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameLanguage: string
Title:
Local-Name Language
Maximum Length:4
Local language of the name. This isn't required for global names. If you're creating a local name, you must provide the language code. -
LocalPreNameAdjunct: string
Title:
Prefix
Maximum Length:150
Part of the name added before a person's first name in local language. -
LocalPreviousLastName: string
Title:
Previous Last Name
Maximum Length:150
Person's previous last name in local language. -
LocalSuffix: string
Title:
Suffix
Maximum Length:80
Part of the name appended to a person's last name such as Jr., III, and so on, in local language. -
LocalTitle: string
Title:
Title
Maximum Length:30
Person's salutation such as Mr., Ms., and so on in local language. Valid values are defined in the commonLookupsLOV. -
MiddleNames: string
Title:
Middle Names
Maximum Length:80
Person's middle name. -
MilitaryRank: string
Title:
Military Rank
Maximum Length:80
Person's military rank. -
NameInformation1: string
Title:
Name Information 1
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation10: string
Title:
Name Information 10
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation11: string
Title:
Name Information 11
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation12: string
Title:
Name Information 12
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation13: string
Title:
Name Information 13
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation14: string
Title:
Name Information 14
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation15: string
Title:
Name Information 15
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation16: string
Title:
Name Information 16
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation17: string
Title:
Name Information 17
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation18: string
Title:
Name Information 18
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation19: string
Title:
Name Information 19
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation2: string
Title:
Name Information 2
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation20: string
Title:
Name Information 20
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation21: string
Title:
Name Information 21
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation22: string
Title:
Name Information 22
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation23: string
Title:
Name Information 23
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation24: string
Title:
Name Information 24
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation25: string
Title:
Name Information 25
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation26: string
Title:
Name Information 26
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation27: string
Title:
Name Information 27
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation28: string
Title:
Name Information 28
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation29: string
Title:
Name Information 29
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation3: string
Title:
Name Information 3
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation30: string
Title:
Name Information 30
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation4: string
Title:
Name Information 4
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation5: string
Title:
Name Information 5
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation6: string
Title:
Name Information 6
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation7: string
Title:
Name Information 7
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation8: string
Title:
Name Information 8
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation9: string
Title:
Name Information 9
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
PreNameAdjunct: string
Title:
Prefix
Maximum Length:150
Part of the name added before a person's first name. -
PreviousLastName: string
Title:
Previous Last Name
Maximum Length:150
Person's previous last name. -
Suffix: string
Title:
Suffix
Maximum Length:80
Part of the name appended to a person's last name such as Jr., III, and so on. -
Title: string
Title:
Title
Maximum Length:30
Person salutation such as Mr., Ms., and so on. Valid values are defined in the commonLookupsLOV.
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 : workers-names-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the name information. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the name information was created. -
DisplayName: string
Title:
Display Name
Read Only:true
Maximum Length:240
Person's display name. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
FirstName: string
Title:
First Name
Maximum Length:150
Person's first name. -
FullName: string
Title:
Full Name
Read Only:true
Maximum Length:2000
Person's full name. -
Honors: string
Title:
Honors
Maximum Length:80
Higher qualification appended to a person's name such as PhD. -
KnownAs: string
Title:
Known As
Maximum Length:80
Person's preferred name. -
LastName: string
Title:
Last Name
Maximum Length:150
Person's last name. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the name information was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the name information. -
LegislationCode: string
Title:
Country
Maximum Length:4
Legislation code. Valid values are defined in the hcmCountriesLov. -
LegislationName: string
Title:
Country
Read Only:true
Maximum Length:80
Name of the person's legislation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListName: string
Title:
List Name
Read Only:true
Maximum Length:240
Person's listed name. -
LocalCreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the local name information. -
LocalCreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the local name information was created. -
LocalDisplayName: string
Title:
Display Name
Read Only:true
Maximum Length:240
Person's display name in local language. -
LocalEffectiveEndDate: string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
LocalEffectiveStartDate: string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
LocalFirstName: string
Title:
First Name
Maximum Length:150
Person's first name in local language. -
LocalFullName: string
Title:
Full Name
Read Only:true
Maximum Length:2000
Person's full name in local language. -
LocalHonors: string
Title:
Honors
Maximum Length:80
Higher qualification appended to a person's name such as PhD in local language. -
LocalKnownAs: string
Title:
Known As
Maximum Length:80
Person's preferred name in local language. -
LocalLastName: string
Title:
Last Name
Maximum Length:150
Person's last name in local language. -
LocalLastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the local name information was last updated. -
LocalLastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the local name information. -
LocalLegislationCode: string
Title:
Country
Maximum Length:4
Legislation code of the local language. Valid values are defined in the hcmCountriesLov. -
LocalLegislationName: string
Title:
Country
Read Only:true
Maximum Length:80
Name of the person's legislation in local language. -
LocalListName: string
Title:
List Name
Read Only:true
Maximum Length:240
Person's listed name in local language. -
LocalMiddleNames: string
Title:
Middle Names
Maximum Length:80
Person's middle name in local language. -
LocalMilitaryRank: string
Title:
Military Rank
Maximum Length:80
Person's military rank in local language. -
LocalNameInformation1: string
Title:
Name Information 1
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation10: string
Title:
Name Information 10
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation11: string
Title:
Name Information 11
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation12: string
Title:
Name Information 12
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation13: string
Title:
Name Information 13
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation14: string
Title:
Name Information 14
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation15: string
Title:
Name Information 15
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation16: string
Title:
Name Information 16
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation17: string
Title:
Name Information 17
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation18: string
Title:
Name Information 18
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation19: string
Title:
Name Information 19
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation2: string
Title:
Name Information 2
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation20: string
Title:
Name Information 20
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation21: string
Title:
Name Information 21
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation22: string
Title:
Name Information 22
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation23: string
Title:
Name Information 23
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation24: string
Title:
Name Information 24
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation25: string
Title:
Name Information 25
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation26: string
Title:
Name Information 26
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation27: string
Title:
Name Information 27
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation28: string
Title:
Name Information 28
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation29: string
Title:
Name Information 29
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation3: string
Title:
Name Information 3
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation30: string
Title:
Name Information 30
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation4: string
Title:
Name Information 4
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation5: string
Title:
Name Information 5
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation6: string
Title:
Name Information 6
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation7: string
Title:
Name Information 7
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation8: string
Title:
Name Information 8
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameInformation9: string
Title:
Name Information 9
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
LocalNameLanguage: string
Title:
Local-Name Language
Maximum Length:4
Local language of the name. This isn't required for global names. If you're creating a local name, you must provide the language code. -
LocalNameLanguageMeaning: string
Title:
Local-Name Language
Read Only:true
Maximum Length:255
Meaning of the local language code for the person's name. -
LocalOrderName: string
Title:
Order Name
Read Only:true
Maximum Length:240
Person's order name in local language. -
LocalPersonNameId: integer
(int64)
Title:
Person Name ID
Surrogate identifier for the local name record. -
LocalPreNameAdjunct: string
Title:
Prefix
Maximum Length:150
Part of the name added before a person's first name in local language. -
LocalPreviousLastName: string
Title:
Previous Last Name
Maximum Length:150
Person's previous last name in local language. -
LocalSuffix: string
Title:
Suffix
Maximum Length:80
Part of the name appended to a person's last name such as Jr., III, and so on, in local language. -
LocalTitle: string
Title:
Title
Maximum Length:30
Person's salutation such as Mr., Ms., and so on in local language. Valid values are defined in the commonLookupsLOV. -
LocalTitleMeaning: string
Title:
Title
Read Only:true
Maximum Length:80
Meaning of the person's title in local language. -
MiddleNames: string
Title:
Middle Names
Maximum Length:80
Person's middle name. -
MilitaryRank: string
Title:
Military Rank
Maximum Length:80
Person's military rank. -
NameInformation1: string
Title:
Name Information 1
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation10: string
Title:
Name Information 10
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation11: string
Title:
Name Information 11
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation12: string
Title:
Name Information 12
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation13: string
Title:
Name Information 13
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation14: string
Title:
Name Information 14
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation15: string
Title:
Name Information 15
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation16: string
Title:
Name Information 16
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation17: string
Title:
Name Information 17
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation18: string
Title:
Name Information 18
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation19: string
Title:
Name Information 19
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation2: string
Title:
Name Information 2
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation20: string
Title:
Name Information 20
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation21: string
Title:
Name Information 21
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation22: string
Title:
Name Information 22
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation23: string
Title:
Name Information 23
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation24: string
Title:
Name Information 24
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation25: string
Title:
Name Information 25
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation26: string
Title:
Name Information 26
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation27: string
Title:
Name Information 27
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation28: string
Title:
Name Information 28
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation29: string
Title:
Name Information 29
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation3: string
Title:
Name Information 3
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation30: string
Title:
Name Information 30
Maximum Length:150
Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition. -
NameInformation4: string
Title:
Name Information 4
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation5: string
Title:
Name Information 5
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation6: string
Title:
Name Information 6
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation7: string
Title:
Name Information 7
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation8: string
Title:
Name Information 8
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameInformation9: string
Title:
Name Information 9
Maximum Length:150
Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition. -
NameLanguage: string
Title:
Global-Name Language
Read Only:true
Maximum Length:4
Language of the name. This isn't required for global names. If you're creating a local name, you must provide the language code. -
NameLanguageMeaning: string
Title:
Global-Name Language
Read Only:true
Maximum Length:30
Meaning of the language code for the person's name. -
OrderName: string
Title:
Order Name
Read Only:true
Maximum Length:240
Person's order name. -
PersonNameId: integer
(int64)
Title:
Person Name ID
Read Only:true
Surrogate identifier for the name record. -
PreNameAdjunct: string
Title:
Prefix
Maximum Length:150
Part of the name added before a person's first name. -
PreviousLastName: string
Title:
Previous Last Name
Maximum Length:150
Person's previous last name. -
Suffix: string
Title:
Suffix
Maximum Length:80
Part of the name appended to a person's last name such as Jr., III, and so on. -
Title: string
Title:
Title
Maximum Length:30
Person salutation such as Mr., Ms., and so on. Valid values are defined in the commonLookupsLOV. -
TitleMeaning: string
Title:
Title
Read Only:true
Maximum Length:80
Meaning of the person's title.
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
- localTitlesLov
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupCode%3D{LocalTitle}%2CLookupType%3DTITLE%2CLegislationCode%3D{LegislationCode}
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
- titlesLov
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupCode%3D{Title}%2CLookupType%3DTITLE%2CLegislationCode%3D{LegislationCode}
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
Examples
The following exampled show how to update a worker name by submitting a PATCH request on the REST resource using cURL.
Correction
For a correction operation:
RangeMode
,RangeStartDate
, andRangeEndDate
are required parameters.RangeStartDate
the same as theEffectiveStartDate
of the record.RangeEndDate
must be the same as theEffectiveEndDate
of the record.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4" -H "Effective-Of: RangeMode=CORRECTION;RangeStartDate=2015-06-01;RangeEndDate=4712-12-31" -X PATCH -d <payload>"https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED00057708000110F07BD26B4E0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000016B43D5980078/child/names/00020000000EACED00057708000110F07BD26B520000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000016B43D5980078"
Example of Payload
The following is an example of the payload.
{ "MiddleNames": "Francis" }
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK Content-Type : application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "PersonNameId": 100000015254282, "EffectiveStartDate": "2015-06-01", "EffectiveEndDate": "4712-12-31", "LegislationCode": "LR", "LastName": "Doe", "FirstName": "John", "PreNameAdjunct": null, "Suffix": null, "MiddleNames": null, "DisplayName": "John Doe", "OrderName": "Doe John", "ListName": "Doe, John", "FullName": "Doe, Francis John", "NameLanguage": "US", "CreatedBy": "OPERATIONS", "CreationDate": "2013-12-26T01:19:50.495+00:00", "LastUpdatedBy": "HCM_INTEGRATION_SPEC", "LastUpdateDate": "2019-06-11T17:06:56+00:00", "LocalPersonNameId": 300100032293715, "LocalEffectiveStartDate": "2015-06-01", "LocalEffectiveEndDate": "4712-12-31", "LocalLegislationCode": "US", "LocalLastName": "Doe", "LocalFirstName": "John", "LocalPreNameAdjunct": null, "LocalSuffix": null, "LocalMiddleNames": "Francis", "LocalDisplayName": "John Doe", "LocalOrderName": "Doe John", "LocalListName": "Doe, John", "LocalFullName": "Doe John", "LocalNameLanguage": "US", "LocalCreatedBy": "OPERATIONS", "LocalCreationDate": "2013-12-26T01:19:50.617+00:00", "LocalLastUpdatedBy": "HCM_INTEGRATION_SPEC", "LocalLastUpdateDate": "2019-06-11T17:06:56.018+00:00", "links": [ {... } ] }
Update
For an update operation:
RangeMode
,RangeStartDate
, andRangeEndDate
are required parameters.RangeStartDate
must be betweenEffectiveStartDate
andEffectiveEndDate
of the record.RangeEndDate
must be the same as theEffectiveEndDate
of the record.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4" -H "Effective-Of: RangeMode=UPDATE;RangeStartDate=2018-01-01;RangeEndDate=4712-12-31" -X PATCH -d <payload>"https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED00057708000110F07BD26B4E0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000016B43D5980078/child/names/00020000000EACED00057708000110F07BD26B520000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000016B43D5980078"
Example of Payload
The following is an example of the payload.
{
"FirstName":"SamplePayload"
}
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK
Content-Type : application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"PersonNameId": 300100032293714,
"EffectiveStartDate": "2018-01-01",
"EffectiveEndDate": "4712-12-31",
"LegislationCode": "US",
"LastName": "Doe",
"FirstName": "Bill",
"PreNameAdjunct": null,
"Suffix": null,
"MiddleNames": null,
"DisplayName": "Bill Doe",
"OrderName": "Doe Bill",
"ListName": "Doe, Bill",
"FullName": "Doe, Bill",
"NameLanguage": "US",
"CreatedBy": "OPERATIONS",
"CreationDate": "2013-12-26T01:19:50.495+00:00",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"LastUpdateDate": "2019-06-11T17:06:56+00:00",
"LocalPersonNameId": 300100032293715,
"LocalEffectiveStartDate": "2015-06-01",
"LocalEffectiveEndDate": "4712-12-31",
"LocalLegislationCode": "US",
"LocalLastName": "Doe",
"LocalFirstName": "Bill",
"LocalPreNameAdjunct": null,
"LocalSuffix": null,
"LocalMiddleNames": null,
"LocalDisplayName": "Bill Doe",
"LocalOrderName": "Doe Bill",
"LocalListName": "Doe, Bill",
"LocalFullName": "Doe Bill",
"LocalNameLanguage": "US",
"LocalCreatedBy": "OPERATIONS",
"LocalCreationDate": "2013-12-26T01:19:50.617+00:00",
"LocalLastUpdatedBy": "HCM_INTEGRATION_SPEC",
"LocalLastUpdateDate": "2019-06-11T17:06:56.018+00:00",
"links": [
{...
}
]
}