Update Worker

Update a resource for a worker in Oracle HCM.

Options

Field	Definition	Type	Required
Resource Type	Select which worker-related resource to update. General Address Name Email Phone Communication Account Work Relationship Custom Update: Use this option if the resource you want to update isn't one of the previous choices.	Dropdown	TRUE
Update Empty Inputs?	Specifies whether empty values are passed to the remote system, instead of skipping an update to the field. Yes: For any input field on the card that is blank or given a null value, the update includes the empty field. This clears any existing value on the remote system for that field. No: For any input field on the card that is blank or given a null value, nothing is sent to the remote system for this field. Any existing value on the remote system remains unchanged.	Dropdown	TRUE

Field

Definition

Type

Required

Resource Type

Select which worker-related resource to update.

General
Address
Name
Email
Phone
Communication Account
Work Relationship
Custom Update: Use this option if the resource you want to update isn't one of the previous choices.

Dropdown

TRUE

Update Empty Inputs?

Specifies whether empty values are passed to the remote system, instead of skipping an update to the field.

Yes: For any input field on the card that is blank or given a null value, the update includes the empty field. This clears any existing value on the remote system for that field.
No: For any input field on the card that is blank or given a null value, nothing is sent to the remote system for this field. Any existing value on the remote system remains unchanged.

Dropdown

TRUE

Input

Field	Definition	Type	Required
Worker
Worker ID	This is a hash key of the attributes that make up the composite key for the worker's resource. To specify this worker identifier, use the Worker ID output from the Search Worker card.	Text	TRUE
Expand All Fields	Determines whether the card should return data for all fields in the Raw Output. Returning all data can exceed the memory limit for flow execution logs. Set to False if you don't need the Raw Output.	True/False	TRUE
General
Correspondence Language	Preferred language for communication. Valid values can be found through the Common Lookups API.	Text	FALSE
Date of Death	Date of death of the person.	Text	FALSE
Person Number	A unique identification number assigned to the person.	Text	FALSE
Date of Birth	Date of birth of the person.	Text	FALSE
Town of Birth	Town of birth of the person.	Text	FALSE
Region of Birth	Region of birth of the person.	Text	FALSE
Applicant Number	Applicant number in the external application.	Text	FALSE
Blood Type	Blood type of the person. Valid values can be found through the Common Lookups API.	Text	FALSE
Country of Birth	Country of birth of the person. Valid values can be found through the Countries List of Values API.	Text	FALSE
Address
Address Uniq ID	This is a hash key of the attributes that make up the composite key for the addresses resource. It's used to uniquely identify an address. To specify this address identifier, use the Address Uniq ID output from the Search Worker card.	Text	TRUE
Address Line 1	First line of the primary mail address.	Text	FALSE
Address Line 2	The second line of the primary mail address.	Text	FALSE
Address Line 3	The third line of the primary mail address.	Text	FALSE
Address Line 4	The fourth line of the primary mail address.	Text	FALSE
Building	Building information associated with the address.	Text	FALSE
Floor Number	Floor number associated with the building.	Text	FALSE
Primary Mailing	This field indicates whether the address is the primary mailing address.	True/False	FALSE
Postal Code	The postal code of the primary mail address.	Text	FALSE
Latitude	The distance between the equator and the address location. This value is north or south of the equator and is provided in degrees and minutes.	Number	FALSE
Longitude	The distance between the prime meridian and the address location. This value is east or west of the prime meridian and is provided in degrees and minutes.	Number	FALSE
Town or City	Town or city in which the address is located.	Text	FALSE
Validation Status Code	Level of accuracy of an address, as determined by an address provider.	Text	FALSE
Long Postal Code	Long postal code of the primary mail address.	Text	FALSE
Region 1	Primary region in which the address is located.	Text	FALSE
Region 2	Secondary region within the primary region.	Text	FALSE
Region 3	Any additional secondary region within the primary region.	Text	FALSE
Provider	The company that validated the address.	Text	FALSE
Additional Address Attribute	Any additional address columns that are used by localizations. There are five individual fields for these attributes.	Text	FALSE
Name
Name Uniq ID	This is a hash key of the attributes that make up the composite key for a name resource. It's used to uniquely identify a worker's name. To specify this name identifier, use the Name Uniq ID output from the Search Worker card.	Text	TRUE
Prefix	Any honorific or prefix appended before the person's first name.	Text	FALSE
First Name	Person's first name.	Text	FALSE
Middle Names	Person's middle names.	Text	FALSE
Last Name	Person's family name.	Text	FALSE
Military Rank	Person's military rank.	Text	FALSE
Previous Last Name	Person's previous family name.	Text	FALSE
Local First Name	Person's first name in their local language.	Text	FALSE
Local Last Name	Person's family name in their local language.	Text	FALSE
Local Middle Names	Person's middle names in their local language.	Text	FALSE
Local Previous Last Name	Person's previous family name in their local language.	Text	FALSE
Suffix	Any honorific or suffix appended to the person's family name, for example Jr., III.	Text	FALSE
Local Suffix	Any honorific or suffix appended to the person's family name, for example Jr., III in their local language.	Text	FALSE
Country	Legislation code. Valid values can be found through the Countries List of Values API.	Text	FALSE
Local Country	Legislation code of the local language. Valid values can be found through the Countries List of Values API.	Text	FALSE
Local Title	Person's salutation, for example Mr. or Ms. as expressed in their local language. Valid values can be found through the Common Lookups API.	Text	FALSE
Known As	Person's preferred name.	Text	FALSE
Local Known As	Person's preferred name in their local language.	Text	FALSE
Local Prefix	Any honorific or prefix appended before the person's first name in their local language.	Text	FALSE
Title	Person's salutation, for example Mr. or Ms. Valid values can be found through the Common Lookups API.	Text	FALSE
Local Military Rank	Person's military rank in their local language.	Text	FALSE
Honors	Higher qualification appended to a person's name, for example Ph.D.	Text	FALSE
Local Honors	Higher qualification appended to a person's name, for example Ph.D, as expressed in their local language.	Text	FALSE
Name Information	These fields are for other name attributes reserved by Oracle Development for legislation-specific name requirements. There are 30 individual fields for these attributes.	Text	FALSE
Local Name Information	These fields are for other local name attributes reserved by Oracle Development for legislation-specific name requirements. There are 30 individual fields for these attributes.	Text	FALSE
Email
Email Address ID	Surrogate identifier for the email address of the person. To specify this email identifier, use the Email Address ID output from the Search Worker card.	Number	TRUE
Email Address	Email address of the person.	Text	FALSE
Email Type	Type of email, for example work or personal. Valid values can be found through the Common Lookups API.	Text	FALSE
Primary	This field indicates whether the email address is the person's primary email.	True/False	FALSE
From Date	Date from when the email address is valid.	Text	FALSE
To Date	Date until when the email address is valid.	Text	FALSE
Phone
Phone ID	This unique key is the person's phone identifier. To specify this phone identifier, use the Phone ID output from the Search Worker card.	Number	TRUE
Phone Number	Phone number associated with the Phone Type.	Text	FALSE
Phone Type	Type of phone number, for example Work or Home. Valid values can be found through the Common Lookups API.	Text	FALSE
Primary	This field indicates whether the phone number is the primary phone of the worker.	True/False	FALSE
Country Code	The country code of the phone number. Valid values can be found through the Countries List of Values API.	Text	FALSE
Area Code	Area code of the phone number.	Text	FALSE
Extension	Extension number for the phone.	Text	FALSE
Country	Phone legislation code.	Text	FALSE
From Date	Date from when the phone number is valid.	Text	FALSE
To Date	Date until when the phone number is valid.	Text	FALSE
Communication Account
Delivery Method ID	This unique key is the person's delivery method identifier. To specify this delivery method, use the Delivery Method ID output from the Search Worker card.	Number	TRUE
Account Name	Name of the account.	Text	FALSE
Provider	Provider of the account, for example Facebook or X. Valid values can be found through the Common Lookups API.	Text	FALSE
From Date	Start date of the account.	Text	FALSE
To Date	End date of the account.	Text	FALSE
Work Relationship
Period of Service ID	This unique key is the person's period of service identifier. To specify this period of service, use the Period of Service ID output from the Search Worker card.	Number	TRUE
Include for Automatic Conversion	This field indicates whether the pending worker is ready to be converted to the proposed worker type.	True/False	FALSE
Projected Termination Date	Projected last date of employment for the period of service.	Text	FALSE
On Military Service	This field indicates whether the person is on military service.	True/False	FALSE
Custom Update
Relative URL	For a Custom Update, specify the relative URL for the worker update endpoint on the server. The relative URL is the path that comes after the /{workersUniqID} in the path. For example, for the Oracle API endpoint: https://{yourOracleHCMInstance}/hcmRestApi/resources/11.13.18.05 /workers/{workersUniqID}/child/nationalIdentifiers/{NationalIdentifierId}, the relative URL is /child/nationalIdentifiers/{NationalIdentifierId}. A relative URL must have a leading / character.	Text	TRUE
Request Body	Specify the update as a request body in JSON format.	Object	TRUE

Output

Field	Definition	Type
Worker
Raw Output	The raw output returned by the Oracle HCM API.	Object
Worker ID	This is a hash key of the attributes that make up the composite key for the worker's resource. It's used to uniquely identify an instance of a worker.	Text
Person Number	A number assigned to a person to uniquely identify them.	Text
Person ID	Surrogate identifier for the person.	Number
Applicant Number	Applicant number in the external application.	Text
Correspondence Language	Preferred language for communication. Valid values can be found through the Common Lookups API.	Text
Name Uniq ID	This is a hash key of the attributes that make up the composite key for a name resource. It's used to uniquely identify a worker's name.	Text
First Name	Person's first name.	Text
Last Name	Person's family name.	Text
Middle Names	Person's middle names.	Text
Display Name	Person's display name.	Text
Addresses		List of Objects
Address Uniq ID	This is a hash key of the attributes that make up the composite key for the addresses resource. It's used to uniquely identify an address.	Text
Address Line 1	First line of the primary mail address.	Text
Town or City	Town or city in which the address is located.	Text
Region 1	Primary region in which the address is located.	Text
Region 2	Secondary region within the primary region.	Text
Postal Code	The postal code of the primary mail address.	Text
Country	Country in which the address is located. Valid values can be found through the Countries List of Values API.	Text
Address Type	Type of address. Valid values can be found through the Common Lookups API.	Text
Emails		List of Objects
Email Address ID	Surrogate identifier for the email address of the person.	Number
Email Address	Email address of the person.	Text
Email Type	Type of email, for example work or personal. Valid values can be found through the Common Lookups API.	Text
Other Communication Accounts		List of Objects
Delivery Method ID	This unique key is the person's delivery method identifier.	Number
Account Name	Name of the account.	Text
Provider	Provider of the account, for example Facebook or X. Valid values can be found through the Common Lookups API.	Text
Phones		List of Objects
Phone ID	This unique key is the person's phone identifier.	Number
Country Code Number	The country code of the phone number. Valid values can be found through the Countries List of Values API.	Text
Area Code	Area code of the phone number.	Text
Phone Number	Phone number associated with the Phone Type.	Text
Extension	Extension number for the phone.	Text
Phone Type	Type of phone number, for example Work or Home. Valid values can be found through the Common Lookups API.	Text
Work Relationships		List of Objects
Period of Service ID	This unique key is the person's period of service identifier.	Number
Worker Type	Worker type for the period of service, for example Employee (E), Contingent Worker (C), Pending Worker (P), or Nonworker (N). Valid values can be found through the Common Lookups API.	Text
Worker Number	The unique identifier for the worker.	Text
Assignments		List of Objects
Assignment Uniq ID	This is a hash key of the attributes that make up the composite key for the worker's assignment. It's used to uniquely identify an assignment for a worker.	Text
Business Title	The business title for the worker's assignment.	Text
Business Unit Name	The name of the business unit for the worker's assignment. Valid values can be found through the Business Units List of Values API.	Text
Business Unit ID	A unique identifier for the business unit of the worker's assignment.	Number
Department Name	The name of the department for the worker's assignment. Valid values can be found through the Departments List of Values API.	Text
Department ID	A unique identifier for the worker's department.	Number

Update Worker

Options

Input

Output

Related topics