Update a contact relationship
patch
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}
Request
Path Parameters
-
contactRelationshipsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Contact Relationships resource and used to uniquely identify an instance of Contact Relationships. The client should not generate the hash key value. Instead, the client should query on the Contact Relationships collection resource in order to navigate to a specific instance of Contact Relationships to get the hash key.
-
hcmContactsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the HCM Contacts resource and used to uniquely identify an instance of HCM Contacts. The client should not generate the hash key value. Instead, the client should query on the HCM Contacts collection resource in order to navigate to a specific instance of HCM Contacts 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-
contactRelationshipsDDF: array
contactRelationshipsDDF
-
contactRelationshipsDFF: array
contactRelationshipsDFF
-
ContactType: string
Title:
RelationshipMaximum Length:30Relationship between the worker and the contact. -
EffectiveEndDate: string
(date)
Title:
Effective End DateEnd date of the date-effective changes to the record. -
EffectiveStartDate: string
(date)
Title:
Effective Start DateStart date of the date-effective changes to the record. -
EmergencyContactFlag: boolean
Title:
Emergency ContactMaximum Length:30Default Value:falseIndicates whether the contact is an emergency contact. -
LegislationCode: string
Title:
CountryMaximum Length:30Legislation code of the contact. Valid values are defined in the hcmCountriesLov. -
PrimaryContactFlag: boolean
Title:
Primary ContactMaximum Length:30Default Value:falseIndicates whether the contact is the primary contact. -
StatutoryDependent: string
Title:
Statutory DependentMaximum Length:30A persons contact is a statutory dependent validated against the lookup type ORA_PER_CONTACT_STATUTORY_DEP used by specific localization.
Nested Schema : contactRelationshipsDDF
Type:
Show Source
array-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "AE":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFAEVO-item-patch-request", "AU":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFAUVO-item-patch-request", "BR":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFBRVO-item-patch-request", "CH":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFCHVO-item-patch-request", "GB":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFGBVO-item-patch-request", "IN":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFINVO-item-patch-request", "KW":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFKWVO-item-patch-request", "ORA_HRX_BH":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FBHVO-item-patch-request", "ORA_HRX_OM":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FOMVO-item-patch-request", "ORA_HRX_QA":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FQAVO-item-patch-request", "SA":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFSAVO-item-patch-request", "US":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFUSVO-item-patch-request" } }
Nested Schema : Discriminator: __FLEX_Context
Type:
objectDiscriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
-
AE -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFAEVO-item-patch-request
-
AU -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFAUVO-item-patch-request
-
BR -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFBRVO-item-patch-request
-
CH -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFCHVO-item-patch-request
-
GB -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFGBVO-item-patch-request
-
IN -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFINVO-item-patch-request
-
KW -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFKWVO-item-patch-request
-
ORA_HRX_BH -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FBHVO-item-patch-request
-
ORA_HRX_OM -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FOMVO-item-patch-request
-
ORA_HRX_QA -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FQAVO-item-patch-request
-
SA -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFSAVO-item-patch-request
-
US -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFUSVO-item-patch-request
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFAEVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:AEContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
_SPOUSE_EMPLOYER: string
Title:
Name of Spouse's EmployerMaximum Length:150Name of Spouse's Employer -
_SPOUSE_LATEST_QUALIFICATION: string
Title:
Spouse's Latest QualificationMaximum Length:150Spouse's Latest Qualification -
_STATUTORY_DEPENDENT: string
Title:
Statutory DependentMaximum Length:150Statutory Dependent -
_SUBJECT: string
Title:
SubjectMaximum Length:150Subject -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFAUVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:AUContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
_TFN: string
Title:
Tax File NumberMaximum Length:150Tax File Number -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFBRVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:BRContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
_STUDENT: string
Title:
StudentMaximum Length:150Student -
_UNI_TECH_HIGH_SCH: string
Title:
University or Technical High SchoolMaximum Length:150University or Technical High School -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFCHVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:CHContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
_CONTACT_WORKING: string
Title:
Partner WorkingMaximum Length:150Partner Working -
_CONTACT_WORKING_Display: string
Title:
Partner WorkingPartner Working -
_LEGAL_EMPLOYER_CA: string
Title:
Legal Employer Paying Child AllowanceMaximum Length:150Legal Employer Paying Child Allowance -
_PENSIONER: string
Title:
PensionerMaximum Length:150Pensioner -
_PENSIONER_Display: string
Title:
PensionerPensioner -
_SIDE_JOB: string
Title:
Side JobMaximum Length:150Side Job -
_SIDE_JOB_Display: string
Title:
Side JobSide Job -
_WORK_CANTON: string
Title:
Working in CantonMaximum Length:150Working in Canton -
_WORK_CANTON_Display: string
Title:
Working in CantonWorking in Canton -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFGBVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:GBContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
_ORA_HRX_GB_CARE_RESP: string
Title:
Caring responsibilitiesMaximum Length:150Caring responsibilities -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFINVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:INContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
_GUARDIAN_ADDRESS: string
Title:
Guardian AddressMaximum Length:150Guardian Address -
_GUARDIAN_BIRTH_DATE: string
(date)
Title:
Guardian Birth DateGuardian Birth Date -
_GUARDIAN_NAME: string
Title:
Guardian NameMaximum Length:150Guardian Name -
_GUARDIAN_TELEPHONE: string
Title:
Guardian PhoneMaximum Length:150Guardian Phone -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFKWVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:KWContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
_STATUTORY_DEPENDENT: string
Title:
Statutory DependentMaximum Length:150Statutory Dependent -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FBHVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:ORA_HRX_BHContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
oraHrxBhStatDep: string
Title:
Statutory DependentMaximum Length:150Statutory Dependent
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FOMVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:ORA_HRX_OMContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
oraHrxOmStatDep: string
Title:
Statutory DependentMaximum Length:150Statutory Dependent
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FQAVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:ORA_HRX_QAContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
oraHrxQaStatDep: string
Title:
Statutory DependantMaximum Length:150Statutory Dependant
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFSAVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:SAContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
_STATUTORY_DEPENDENT: string
Title:
Statutory DependentMaximum Length:150Statutory Dependent -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFUSVO-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:USContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
benefitsOffered: string
Title:
Benefits Offered ConditionallyMaximum Length:150Benefits Offered Conditionally -
benefitsOffered_Display: string
Title:
Benefits Offered ConditionallyBenefits Offered Conditionally -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
tinNumber: string
Title:
TIN NumberMaximum Length:150TIN Number -
tinType: string
Title:
TIN TypeMaximum Length:150TIN Type -
tinType_Display: string
Title:
TIN TypeTIN Type
Nested Schema : hcmContacts-contactRelationships-contactRelationshipsDFF-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
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 : hcmContacts-contactRelationships-item-response
Type:
Show Source
object-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDSurrogate identifier for the contact relationship. -
contactRelationshipsDDF: array
contactRelationshipsDDF
-
contactRelationshipsDFF: array
contactRelationshipsDFF
-
ContactType: string
Title:
RelationshipMaximum Length:30Relationship between the worker and the contact. -
ContactTypeMeaning: string
Title:
RelationshipRead Only:trueMaximum Length:80Meaning of the contact type code. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the contact relationship record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate and time when the contact relationship record was created. -
EffectiveEndDate: string
(date)
Title:
Effective End DateEnd date of the date-effective changes to the record. -
EffectiveStartDate: string
(date)
Title:
Effective Start DateStart date of the date-effective changes to the record. -
EmergencyContactFlag: boolean
Title:
Emergency ContactMaximum Length:30Default Value:falseIndicates whether the contact is an emergency contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate and time when the contact relationship record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the contact relationship record. -
LegislationCode: string
Title:
CountryMaximum Length:30Legislation code of the contact. Valid values are defined in the hcmCountriesLov. -
LegislationName: string
Title:
CountryRead Only:trueMaximum Length:80Name of the contact's legislation. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PrimaryContactFlag: boolean
Title:
Primary ContactMaximum Length:30Default Value:falseIndicates whether the contact is the primary contact. -
RelatedPersonId: integer
(int64)
Title:
Person IDUnique identifier of the worker to whom the contact is related. -
RelatedPersonNumber: string
Title:
Person NumberMaximum Length:30Person number of the worker to whom the contact is related. -
StatutoryDependent: string
Title:
Statutory DependentMaximum Length:30A persons contact is a statutory dependent validated against the lookup type ORA_PER_CONTACT_STATUTORY_DEP used by specific localization. -
StatutoryDependentMeaning: string
Title:
Statutory DependentRead Only:trueMaximum Length:80Meaning of the contact's statutory dependent code.
Nested Schema : contactRelationshipsDDF
Type:
Show Source
array-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "AE":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFAEVO-item-response", "AU":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFAUVO-item-response", "BR":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFBRVO-item-response", "CH":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFCHVO-item-response", "GB":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFGBVO-item-response", "IN":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFINVO-item-response", "KW":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFKWVO-item-response", "ORA_HRX_BH":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FBHVO-item-response", "ORA_HRX_OM":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FOMVO-item-response", "ORA_HRX_QA":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FQAVO-item-response", "SA":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFSAVO-item-response", "US":"#/components/schemas/oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFUSVO-item-response" } }
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type:
objectDiscriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
-
AE -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFAEVO-item-response
-
AU -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFAUVO-item-response
-
BR -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFBRVO-item-response
-
CH -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFCHVO-item-response
-
GB -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFGBVO-item-response
-
IN -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFINVO-item-response
-
KW -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFKWVO-item-response
-
ORA_HRX_BH -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FBHVO-item-response
-
ORA_HRX_OM -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FOMVO-item-response
-
ORA_HRX_QA -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FQAVO-item-response
-
SA -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFSAVO-item-response
-
US -
object
oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFUSVO-item-response
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFAEVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:AEContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
_SPOUSE_EMPLOYER: string
Title:
Name of Spouse's EmployerMaximum Length:150Name of Spouse's Employer -
_SPOUSE_LATEST_QUALIFICATION: string
Title:
Spouse's Latest QualificationMaximum Length:150Spouse's Latest Qualification -
_STATUTORY_DEPENDENT: string
Title:
Statutory DependentMaximum Length:150Statutory Dependent -
_SUBJECT: string
Title:
SubjectMaximum Length:150Subject -
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFAUVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:AUContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
_TFN: string
Title:
Tax File NumberMaximum Length:150Tax File Number -
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFBRVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:BRContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
_STUDENT: string
Title:
StudentMaximum Length:150Student -
_UNI_TECH_HIGH_SCH: string
Title:
University or Technical High SchoolMaximum Length:150University or Technical High School -
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFCHVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:CHContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
_CONTACT_WORKING: string
Title:
Partner WorkingMaximum Length:150Partner Working -
_CONTACT_WORKING_Display: string
Title:
Partner WorkingPartner Working -
_LEGAL_EMPLOYER_CA: string
Title:
Legal Employer Paying Child AllowanceMaximum Length:150Legal Employer Paying Child Allowance -
_PENSIONER: string
Title:
PensionerMaximum Length:150Pensioner -
_PENSIONER_Display: string
Title:
PensionerPensioner -
_SIDE_JOB: string
Title:
Side JobMaximum Length:150Side Job -
_SIDE_JOB_Display: string
Title:
Side JobSide Job -
_WORK_CANTON: string
Title:
Working in CantonMaximum Length:150Working in Canton -
_WORK_CANTON_Display: string
Title:
Working in CantonWorking in Canton -
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFGBVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:GBContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
_ORA_HRX_GB_CARE_RESP: string
Title:
Caring responsibilitiesMaximum Length:150Caring responsibilities -
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFINVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:INContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
_GUARDIAN_ADDRESS: string
Title:
Guardian AddressMaximum Length:150Guardian Address -
_GUARDIAN_BIRTH_DATE: string
(date)
Title:
Guardian Birth DateGuardian Birth Date -
_GUARDIAN_NAME: string
Title:
Guardian NameMaximum Length:150Guardian Name -
_GUARDIAN_TELEPHONE: string
Title:
Guardian PhoneMaximum Length:150Guardian Phone -
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFKWVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:KWContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
_STATUTORY_DEPENDENT: string
Title:
Statutory DependentMaximum Length:150Statutory Dependent -
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FBHVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:ORA_HRX_BHContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
oraHrxBhStatDep: string
Title:
Statutory DependentMaximum Length:150Statutory Dependent
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FOMVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:ORA_HRX_OMContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
oraHrxOmStatDep: string
Title:
Statutory DependentMaximum Length:150Statutory Dependent
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FQAVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:ORA_HRX_QAContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
oraHrxQaStatDep: string
Title:
Statutory DependantMaximum Length:150Statutory Dependant
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFSAVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:SAContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
_STATUTORY_DEPENDENT: string
Title:
Statutory DependentMaximum Length:150Statutory Dependent -
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFUSVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Contact Information CategoryMaximum Length:30Default Value:USContact Information Category -
__FLEX_Context_DisplayValue: string
Title:
Contact Information CategoryContact Information Category -
benefitsOffered: string
Title:
Benefits Offered ConditionallyMaximum Length:150Benefits Offered Conditionally -
benefitsOffered_Display: string
Title:
Benefits Offered ConditionallyBenefits Offered Conditionally -
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
tinNumber: string
Title:
TIN NumberMaximum Length:150TIN Number -
tinType: string
Title:
TIN TypeMaximum Length:150TIN Type -
tinType_Display: string
Title:
TIN TypeTIN Type
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : hcmContacts-contactRelationships-contactRelationshipsDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- contactRelationshipsDDF
-
Parameters:
- contactRelationshipsUniqID:
$request.path.contactRelationshipsUniqID - hcmContactsUniqID:
$request.path.hcmContactsUniqID
- contactRelationshipsUniqID:
- contactRelationshipsDFF
-
Parameters:
- contactRelationshipsUniqID:
$request.path.contactRelationshipsUniqID - hcmContactsUniqID:
$request.path.hcmContactsUniqID
- contactRelationshipsUniqID:
- contactTypeLov
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupCode%3D{ContactType}%2CLookupType%3DCONTACT%2CLegislationCode%3D{LegislationCode}
The following properties are defined on the LOV link relation:- Source Attribute: ContactType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- statutoryDependentLov
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupCode%3D{StatutoryDependent}%2CLookupType%3DORA_PER_STATUTORY_DEPENDENT%2CLegislationCode%3D{LegislationCode}
The following properties are defined on the LOV link relation:- Source Attribute: StatutoryDependent; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: