Get all contacts

get

/hcmRestApi/resources/11.13.18.05/hcmContacts

Request

Query Parameters
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds all the contacts that match the specified primary key criteria.
      Finder Variables
      • PersonId; integer; Surrogate identifier for the contact.
    • findByPersonId Finds all the contacts that match the specified person identifier.
      Finder Variables
      • PersonId; integer; Surrogate identifier for the worker.
      • SysEffectiveDate; object;
    • findContactsByWorker Finds all the contacts for a worker that match the specified criteria.
      Finder Variables
      • ContactType; string; Relationship between the worker and the contact.
      • EmergencyContactFlag; string; Indicates whether the contact is an emergency contact.
      • RelatedPersonId; integer; Unique identifier of the worker to whom the contact is related.
      • RelatedPersonNumber; string; Person number of the worker to whom the contact is related.
      • SysEffectiveDate; object;
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BloodTypeMeaning; string; Meaning of the contact's blood type.
    • CorrLanguageMeaning; string; Meaning of the contact's preferred language of communication.
    • CountryOfBirthName; string; Name of the country of birth of the contact.
    • DateOfBirth; string; Date of birth of the contact.
    • PersonId; integer; Surrogate identifier for the worker to which the contact relationship belongs.
    • PersonNumber; string; Person number of the worker to whom the contact is related.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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.
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : hcmContacts
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : hcmContacts-item-response
Type: object
Show Source
  • Addresses
    Title: Addresses
    The addresses resource is a child of the hcmContacts resource. It provides all the addresses of worker contacts as of the specified date. By default, the current date is retained.
  • Title: Blood Type
    Maximum Length: 30
    Blood type of the contact. Valid values are defined in the commonLookupsLOV.
  • Title: Blood Type
    Read Only: true
    Maximum Length: 80
    Meaning of the contact's blood type.
  • Citizenships
    Title: Citizenships
    The citizenships resource is a child of the hcmContacts resource. It provides all the citizenships of worker contacts as of the specified date. By default, the current date is retained.
  • Contact Relationships
    Title: Contact Relationships
    The contactRelationships resource is a child of the hcmContacts resource. It provides all the contact relationships of workers as of the specified date. By default, the current date is retained.
  • contactsDFF
  • Title: Correspondence Language
    Maximum Length: 30
    Preferred language for communication. Valid values are defined in the commonLookupsLOV.
  • Title: Correspondence Language
    Read Only: true
    Maximum Length: 80
    Meaning of the contact's preferred language of communication.
  • Title: Country of Birth
    Maximum Length: 240
    Country of birth of the contact. Valid values are defined in the hcmCountriesLOV.
  • Title: Country of Birth
    Read Only: true
    Maximum Length: 80
    Name of the country of birth of the contact.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the contact record.
  • Title: Creation Date
    Read Only: true
    Date and time when the contact record was created.
  • Title: Date of Birth
    Date of birth of the contact.
  • Title: Date of Death
    Date of death of the contact.
  • Driver Licenses
    Title: Driver Licenses
    The driverLicenses resource is a child of the hcmContacts resource. It provides all the driver licenses of worker contacts as of the specified date. By default, the current date is retained.
  • Emails
    Title: Emails
    The emails resource is a child of the hcmContacts resource. It provides all the email addresses of worker contacts as of the specified date. By default, the current date is retained.
  • Ethnicities
    Title: Ethnicities
    The ethnicities resource is a child of the hcmContacts resource. It provides all the ethnicities of worker contacts as of the specified date. By default, the current date is retained.
  • Title: Last Updated Date
    Read Only: true
    Date and time when the contact record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the contact record.
  • Legislative Information
    Title: Legislative Information
    The legislativeInfo resource is a child of the hcmContacts resource. It provides all the legislative information of worker contacts as of the specified date. By default, the current date is retained.
  • Links
  • Names
    Title: Names
    The names resource is a child of the hcmContacts resource. It provides all the names of worker contacts as of the specified date. By default, the current date is retained.
  • National Identifiers
    Title: National Identifiers
    The nationalIdentifiers resource is a child of the hcmContacts resource. It provides all the national identifiers of worker contacts as of the specified date. By default, the current date is retained.
  • Other Communication Accounts
    Title: Other Communication Accounts
    The otherCommunicationAccounts resource is a child of the hcmContacts resource. It provides all the other communication accounts of worker contacts as of the specified date. By default, the current date is retained.
  • Passports
    Title: Passports
    The passports resource is a child of the hcmContacts resource. It provides all the passports of worker contacts as of the specified date. By default, the current date is retained.
  • Title: Person ID
    Surrogate identifier for the worker to which the contact relationship belongs.
  • Title: Person Number
    Maximum Length: 30
    Person number of the worker to whom the contact is related.
  • Phones
    Title: Phones
    The phones resource is a child of the hcmContacts resource. It provides all the phones of worker contacts as of the specified date. By default, the current date is retained.
  • Title: Region of Birth
    Maximum Length: 240
    Region of birth of the contact.
  • Religions
    Title: Religions
    The religions resource is a child of the hcmContacts resource. It provides all the religions of worker contacts as of the specified date. By default, the current date is retained.
  • Title: Town of Birth
    Maximum Length: 240
    Town of birth of the contact.
  • Visa Permits
    Title: Visa Permits
    The visasPermits resource is a child of the hcmContacts resource. It provides all the visas and permits of worker contacts as of the specified date. By default, the current date is retained.
Nested Schema : Addresses
Type: array
Title: Addresses
The addresses resource is a child of the hcmContacts resource. It provides all the addresses of worker contacts as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Citizenships
Type: array
Title: Citizenships
The citizenships resource is a child of the hcmContacts resource. It provides all the citizenships of worker contacts as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Contact Relationships
Type: array
Title: Contact Relationships
The contactRelationships resource is a child of the hcmContacts resource. It provides all the contact relationships of workers as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : contactsDFF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "CRFL_Context_Test":"#/components/schemas/oracle_apps_hcm_people_core_flex_personDFF_view_PersonDFFCRFL__5FContext__5FTestVO-item-response" } }
Nested Schema : Driver Licenses
Type: array
Title: Driver Licenses
The driverLicenses resource is a child of the hcmContacts resource. It provides all the driver licenses of worker contacts as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Emails
Type: array
Title: Emails
The emails resource is a child of the hcmContacts resource. It provides all the email addresses of worker contacts as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Ethnicities
Type: array
Title: Ethnicities
The ethnicities resource is a child of the hcmContacts resource. It provides all the ethnicities of worker contacts as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Legislative Information
Type: array
Title: Legislative Information
The legislativeInfo resource is a child of the hcmContacts resource. It provides all the legislative information of worker contacts as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Names
Type: array
Title: Names
The names resource is a child of the hcmContacts resource. It provides all the names of worker contacts as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : National Identifiers
Type: array
Title: National Identifiers
The nationalIdentifiers resource is a child of the hcmContacts resource. It provides all the national identifiers of worker contacts as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Other Communication Accounts
Type: array
Title: Other Communication Accounts
The otherCommunicationAccounts resource is a child of the hcmContacts resource. It provides all the other communication accounts of worker contacts as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Passports
Type: array
Title: Passports
The passports resource is a child of the hcmContacts resource. It provides all the passports of worker contacts as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Phones
Type: array
Title: Phones
The phones resource is a child of the hcmContacts resource. It provides all the phones of worker contacts as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Religions
Type: array
Title: Religions
The religions resource is a child of the hcmContacts resource. It provides all the religions of worker contacts as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Visa Permits
Type: array
Title: Visa Permits
The visasPermits resource is a child of the hcmContacts resource. It provides all the visas and permits of worker contacts as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : hcmContacts-addresses-item-response
Type: object
Show Source
Nested Schema : addressesDFF
Type: array
Show Source
Nested Schema : hcmContacts-addresses-addressesDFF-item-response
Type: object
Show Source
Nested Schema : hcmContacts-citizenships-item-response
Type: object
Show Source
Nested Schema : citizenshipsDFF
Type: array
Show Source
Nested Schema : hcmContacts-citizenships-citizenshipsDFF-item-response
Type: object
Show Source
Nested Schema : hcmContacts-contactRelationships-item-response
Type: object
Show Source
Nested Schema : contactRelationshipsDDF
Type: array
Show Source
  • 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 : contactRelationshipsDFF
Type: array
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFAEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFAUVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFBRVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFCHVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFGBVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFINVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFKWVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FBHVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FOMVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFORA__5FHRX__5FQAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFSAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personContactRelLegDDF_view_PersonContactRelLegDDFUSVO-item-response
Type: object
Show Source
Nested Schema : hcmContacts-contactRelationships-contactRelationshipsDFF-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personDFF_view_PersonDFFCRFL__5FContext__5FTestVO-item-response
Type: object
Show Source
Nested Schema : hcmContacts-driverLicenses-item-response
Type: object
Show Source
Nested Schema : driverLicensesDDF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "BR":"#/components/schemas/oracle_apps_hcm_people_core_flex_personDriversLicenseLegDDF_view_PersonDriversLicenseLegDDFBRVO-item-response", "DE":"#/components/schemas/oracle_apps_hcm_people_core_flex_personDriversLicenseLegDDF_view_PersonDriversLicenseLegDDFDEVO-item-response" } }
Nested Schema : driverLicensesDFF
Type: array
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personDriversLicenseLegDDF_view_PersonDriversLicenseLegDDFBRVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personDriversLicenseLegDDF_view_PersonDriversLicenseLegDDFDEVO-item-response
Type: object
Show Source
Nested Schema : hcmContacts-driverLicenses-driverLicensesDFF-item-response
Type: object
Show Source
Nested Schema : hcmContacts-emails-item-response
Type: object
Show Source
Nested Schema : emailsDFF
Type: array
Show Source
Nested Schema : hcmContacts-emails-emailsDFF-item-response
Type: object
Show Source
Nested Schema : hcmContacts-ethnicities-item-response
Type: object
Show Source
Nested Schema : ethnicitiesDFF
Type: array
Show Source
Nested Schema : hcmContacts-ethnicities-ethnicitiesDFF-item-response
Type: object
Show Source
Nested Schema : hcmContacts-legislativeInfo-item-response
Type: object
Show Source
Nested Schema : legislativeInfoDDF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AE":"#/components/schemas/oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeAEVO-item-response", "BR":"#/components/schemas/oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeBRVO-item-response", "CH":"#/components/schemas/oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeCHVO-item-response", "CN":"#/components/schemas/oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeCNVO-item-response", "FR":"#/components/schemas/oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeFRVO-item-response", "GB":"#/components/schemas/oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeGBVO-item-response", "IE":"#/components/schemas/oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeIEVO-item-response", "KW":"#/components/schemas/oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeKWVO-item-response", "MX":"#/components/schemas/oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeMXVO-item-response", "ORA_HRX_ES":"#/components/schemas/oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeORA__5FHRX__5FESVO-item-response", "ORA_HRX_IT":"#/components/schemas/oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeORA__5FHRX__5FITVO-item-response", "ORA_HRX_QA":"#/components/schemas/oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeORA__5FHRX__5FQAVO-item-response", "ORA_HRX_ZA":"#/components/schemas/oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeORA__5FHRX__5FZAVO-item-response", "SA":"#/components/schemas/oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeSAVO-item-response", "US":"#/components/schemas/oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeUSVO-item-response" } }
Nested Schema : legislativeInfoDFF
Type: array
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeAEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeBRVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeCHVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeCNVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeFRVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeGBVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeIEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeKWVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeMXVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeORA__5FHRX__5FESVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeORA__5FHRX__5FITVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeORA__5FHRX__5FQAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeORA__5FHRX__5FZAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeSAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personLegislativeInfo_view_PersonLegislativeUSVO-item-response
Type: object
Show Source
Nested Schema : hcmContacts-legislativeInfo-legislativeInfoDFF-item-response
Type: object
Show Source
Nested Schema : hcmContacts-names-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the contact's name information.
  • Title: Creation Date
    Read Only: true
    Date and time when the contact's name information was created.
  • Title: Display Name
    Read Only: true
    Maximum Length: 240
    Contact's display name.
  • Title: Effective End Date
    End date of the date-effective changes to the record.
  • Title: Effective Start Date
    Start date of the date-effective changes to the record.
  • Title: First Name
    Maximum Length: 150
    Contact's first name.
  • Title: Full Name
    Read Only: true
    Maximum Length: 2000
    Contact's full name.
  • Title: Honors
    Maximum Length: 80
    Higher qualification appended to a person's name such as PhD.
  • Title: Known As
    Maximum Length: 80
    Contact's preferred name.
  • Title: Last Name
    Maximum Length: 150
    Contact's last name.
  • Title: Last Updated Date
    Read Only: true
    Date and time when the contact's name information was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the contact's name information.
  • Title: Country
    Maximum Length: 4
    Legislation code of the contact. Valid values are defined in the hcmCountriesLov.
  • Title: Country
    Read Only: true
    Maximum Length: 80
    Name of the contact's legislation.
  • Links
  • Title: List Name
    Read Only: true
    Maximum Length: 240
    Contact's listed name.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the contact's local name information.
  • Title: Creation Date
    Read Only: true
    Date and time when the contact's local name information was created.
  • Title: Display Name
    Read Only: true
    Maximum Length: 240
    Contact's display name in local language.
  • Title: Effective End Date
    End date of the date-effective changes to the record.
  • Title: Effective Start Date
    Start date of the date-effective changes to the record.
  • Title: First Name
    Maximum Length: 150
    Contact's first name in local language.
  • Title: Full Name
    Read Only: true
    Maximum Length: 2000
    Contact's full name in local language.
  • Title: Honors
    Maximum Length: 80
    Higher qualification appended to a person's name such as PhD in local language.
  • Title: Known As
    Maximum Length: 80
    Contact 's preferred name in local language.
  • Title: Last Name
    Maximum Length: 150
    Contact's last name in local language.
  • Title: Last Updated Date
    Read Only: true
    Date and time when the contact's local name information was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the contact's local name information.
  • Title: Country
    Maximum Length: 4
    Legislation code of the local language. Valid values are defined in the hcmCountriesLov.
  • Title: Country
    Read Only: true
    Maximum Length: 80
    Name of the contact's legislation in local language.
  • Title: List Name
    Read Only: true
    Maximum Length: 240
    Contact's listed name in local language.
  • Title: Middle Names
    Maximum Length: 80
    Contact's middle name in local language.
  • Title: Military Rank
    Maximum Length: 80
    Contact's military rank in local language.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Local-Name Language
    Read Only: true
    Maximum Length: 255
    Meaning of the local language code for the contact's name.
  • Title: Order Name
    Read Only: true
    Maximum Length: 240
    Contact's order name in local language.
  • Title: Person Name ID
    Surrogate identifier for the local contact's name record.
  • Title: Prefix
    Maximum Length: 150
    Part of the name added before a person's first name in local language.
  • Title: Previous Last Name
    Maximum Length: 150
    Contact 's previous last name in local language.
  • 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.
  • Title: Title
    Maximum Length: 30
    Person salutation such as Mr., Ms., and so on, in local language. Valid values are defined in the commonLookupsLOV.
  • Title: Title
    Read Only: true
    Maximum Length: 80
    Meaning of the contact's title in local language.
  • Title: Middle Names
    Maximum Length: 80
    Contact's middle name.
  • Title: Military Rank
    Maximum Length: 80
    Contact's military rank.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Global-Name Language
    Read Only: true
    Maximum Length: 30
    Meaning of the language code for the contact's name.
  • Title: Order Name
    Read Only: true
    Maximum Length: 240
    Contact's order name.
  • Title: Person Name ID
    Read Only: true
    Surrogate identifier for the contact's name.
  • Title: Prefix
    Maximum Length: 150
    Part of the name added before a person's first name.
  • Title: Previous Last Name
    Maximum Length: 150
    Contact's previous last name.
  • Title: Suffix
    Maximum Length: 80
    Part of the name appended to a person's last name such as Jr., III, and so on.
  • Title: Title
    Maximum Length: 30
    Person salutation such as Mr., Ms., and so on. Valid values are defined in the commonLookupsLOV.
  • Title: Title
    Read Only: true
    Maximum Length: 80
    Meaning of the contact's title.
Nested Schema : hcmContacts-nationalIdentifiers-item-response
Type: object
Show Source
Nested Schema : nationalIdentifiersDFF
Type: array
Show Source
Nested Schema : hcmContacts-nationalIdentifiers-nationalIdentifiersDFF-item-response
Type: object
Show Source
Nested Schema : hcmContacts-otherCommunicationAccounts-item-response
Type: object
Show Source
Nested Schema : otherCommunicationAccountsDFF
Type: array
Show Source
Nested Schema : hcmContacts-otherCommunicationAccounts-otherCommunicationAccountsDFF-item-response
Type: object
Show Source
Nested Schema : hcmContacts-passports-item-response
Type: object
Show Source
Nested Schema : passportsDDF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AE":"#/components/schemas/oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFAEVO-item-response", "IN":"#/components/schemas/oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFINVO-item-response", "KW":"#/components/schemas/oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFKWVO-item-response" } }
Nested Schema : passportsDFF
Type: array
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFAEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFINVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFKWVO-item-response
Type: object
Show Source
Nested Schema : hcmContacts-passports-passportsDFF-item-response
Type: object
Show Source
Nested Schema : hcmContacts-phones-item-response
Type: object
Show Source
Nested Schema : phonesDFF
Type: array
Show Source
Nested Schema : hcmContacts-phones-phonesDFF-item-response
Type: object
Show Source
Nested Schema : hcmContacts-religions-item-response
Type: object
Show Source
Nested Schema : religionsDFF
Type: array
Show Source
Nested Schema : hcmContacts-religions-religionsDFF-item-response
Type: object
Show Source
Nested Schema : hcmContacts-visasPermits-item-response
Type: object
Show Source
Nested Schema : visasPermitsDDF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AE":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFAEVO-item-response", "CH":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFCHVO-item-response", "KW":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFKWVO-item-response", "ORA_HRX_BH":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FBHVO-item-response", "ORA_HRX_OM":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FOMVO-item-response", "ORA_HRX_QA":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FQAVO-item-response", "SA":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSAVO-item-response", "SG":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSGVO-item-response" } }
Nested Schema : visasPermitsDFF
Type: array
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFAEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFCHVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFKWVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FBHVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FOMVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FQAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSGVO-item-response
Type: object
Show Source
Nested Schema : hcmContacts-visasPermits-visasPermitsDFF-item-response
Type: object
Show Source
Back to Top