Get a worker

get

/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Workers resource and used to uniquely identify an instance of Workers. The client should not generate the hash key value. Instead, the client should query on the Workers collection resource in order to navigate to a specific instance of Workers to get the hash key.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : workers-item-response
Type: object
Show Source
Nested Schema : addresses
Type: array
Show Source
Nested Schema : citizenships
Type: array
Show Source
Nested Schema : disabilities
Type: array
Show Source
Nested Schema : driverLicenses
Type: array
Show Source
Nested Schema : emails
Type: array
Show Source
Nested Schema : ethnicities
Type: array
Show Source
Nested Schema : externalIdentifiers
Type: array
Show Source
Nested Schema : legislativeInfo
Type: array
Show Source
Nested Schema : messages
Type: array
Show Source
Nested Schema : names
Type: array
Show Source
Nested Schema : nationalIdentifiers
Type: array
Show Source
Nested Schema : otherCommunicationAccounts
Type: array
Show Source
Nested Schema : passports
Type: array
Show Source
Nested Schema : phones
Type: array
Show Source
Nested Schema : photos
Type: array
Show Source
Nested Schema : religions
Type: array
Show Source
Nested Schema : visasPermits
Type: array
Show Source
Nested Schema : workersDFF
Type: array
Show Source
Nested Schema : workersEFF
Type: array
Show Source
  • Discriminator: CategoryCode
    Discriminator: { "propertyName":"CategoryCode", "mapping":{ "PER_EIT":"#/components/schemas/oracle_apps_hcm_people_core_flex_personEITEFF_base_view_j__PersonExtraInformationPerEitprivateVO-item-response" } }
Nested Schema : workRelationships
Type: array
Show Source
Nested Schema : workers-addresses-item-response
Type: object
Show Source
Nested Schema : Address Descriptive Flexfields
Type: array
Title: Address Descriptive Flexfields
The addressesDFF resource is a child of the addresses resource. It provides all the address descriptive flexfields of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : workers-addresses-addressesDFF-item-response
Type: object
Show Source
Nested Schema : workers-citizenships-item-response
Type: object
Show Source
Nested Schema : Citizenship Descriptive Flexfields
Type: array
Title: Citizenship Descriptive Flexfields
The citizenshipsDFF resource is a child of the citizenships resource. It provides all the citizenship descriptive flexfields of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : workers-citizenships-citizenshipsDFF-item-response
Type: object
Show Source
Nested Schema : workers-disabilities-item-response
Type: object
Show Source
Nested Schema : attachments
Type: array
Show Source
Nested Schema : disabilitiesDDF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AE":"#/components/schemas/oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFAEVO-item-response", "DE":"#/components/schemas/oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFDEVO-item-response", "FR":"#/components/schemas/oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFFRVO-item-response", "HRX_NL_DISABILITY_INFO":"#/components/schemas/oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFHRX__5FNL__5FDISABILITY__5FINFOVO-item-response", "IN":"#/components/schemas/oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFINVO-item-response", "KW":"#/components/schemas/oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFKWVO-item-response", "ORA_HRX_BH":"#/components/schemas/oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFORA__5FHRX__5FBHVO-item-response", "ORA_HRX_MX_DISABILITY":"#/components/schemas/oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFORA__5FHRX__5FMX__5FDISABILITYVO-item-response", "ORA_HRX_OM":"#/components/schemas/oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFORA__5FHRX__5FOMVO-item-response", "ORA_HRX_QA":"#/components/schemas/oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFORA__5FHRX__5FQAVO-item-response", "SA":"#/components/schemas/oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFSAVO-item-response", "US":"#/components/schemas/oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFUSVO-item-response" } }
Nested Schema : workers-disabilities-attachments-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_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFAEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFDEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFFRVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFHRX__5FNL__5FDISABILITY__5FINFOVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFINVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFKWVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFORA__5FHRX__5FBHVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFORA__5FHRX__5FMX__5FDISABILITYVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFORA__5FHRX__5FOMVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFORA__5FHRX__5FQAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFSAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_healthAndSafety_flex_personDisabilityDDF_view_PersonDisabilityLegDDFUSVO-item-response
Type: object
Show Source
Nested Schema : workers-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 : workers-driverLicenses-driverLicensesDFF-item-response
Type: object
Show Source
Nested Schema : workers-emails-item-response
Type: object
Show Source
Nested Schema : emailsDFF
Type: array
Show Source
Nested Schema : workers-emails-emailsDFF-item-response
Type: object
Show Source
Nested Schema : workers-ethnicities-item-response
Type: object
Show Source
Nested Schema : ethnicitiesDFF
Type: array
Show Source
Nested Schema : workers-ethnicities-ethnicitiesDFF-item-response
Type: object
Show Source
Nested Schema : workers-externalIdentifiers-item-response
Type: object
Show Source
Nested Schema : workers-legislativeInfo-item-response
Type: object
Show Source
Nested Schema : Legislative Information Developer Flexfields
Type: array
Title: Legislative Information Developer Flexfields
The legislativeInfoDDF resource is a child of the legislativeInfo resource. It provides all the legislative informaton developer flexfields of a worker as of the specified date. By default, the current date is retained.
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 : Legislative Information Descriptive Flexfields
Type: array
Title: Legislative Information Descriptive Flexfields
The legislativeInfoDFF resource is a child of the legislativeInfo resource. It provides all the legislative informaton descriptive flexfields of a worker as of the specified date. By default, the current date is retained.
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 : workers-legislativeInfo-legislativeInfoDFF-item-response
Type: object
Show Source
Nested Schema : workers-messages-item-response
Type: object
Show Source
Nested Schema : workers-names-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
  • Title: Creation Date
    Read Only: true
  • Title: Display Name
    Read Only: true
    Maximum Length: 240
  • 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
    Person's first name.
  • Title: Full Name
    Read Only: true
    Maximum Length: 2000
  • Title: Honors
    Maximum Length: 80
    Higher qualification appended to a person's name such as PhD.
  • Title: Known As
    Maximum Length: 80
    Person's preferred name.
  • Title: Last Name
    Maximum Length: 150
    Person's last name.
  • Title: Last Updated Date
    Read Only: true
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
  • Title: Country
    Maximum Length: 4
    Legislation code. Valid values are defined in the hcmCountriesLov.
  • Title: Country
    Read Only: true
    Maximum Length: 80
  • Links
  • Title: List Name
    Read Only: true
    Maximum Length: 240
  • Title: Created By
    Read Only: true
    Maximum Length: 64
  • Title: Creation Date
    Read Only: true
  • Title: Display Name
    Read Only: true
    Maximum Length: 240
  • 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
    Person's first name in local language.
  • Title: Full Name
    Read Only: true
    Maximum Length: 2000
  • 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
    Person's preferred name in local language.
  • Title: Last Name
    Maximum Length: 150
    Person's last name in local language.
  • Title: Last Updated Date
    Read Only: true
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
  • 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
  • Title: List Name
    Read Only: true
    Maximum Length: 240
  • Title: Middle Names
    Maximum Length: 80
    Person's middle name in local language.
  • Title: Military Rank
    Maximum Length: 80
    Person'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 is not 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
  • Title: Order Name
    Read Only: true
    Maximum Length: 240
  • Title: Person Name ID
    Surrogate identifier for the local 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
    Person'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's 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
  • Title: Middle Names
    Maximum Length: 80
    Person's middle name.
  • Title: Military Rank
    Maximum Length: 80
    Person'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
  • Title: Global-Name Language
    Read Only: true
    Maximum Length: 30
  • Title: Order Name
    Read Only: true
    Maximum Length: 240
  • Title: Person Name ID
    Read Only: true
  • Title: Prefix
    Maximum Length: 150
    Part of the name added before a person's first name.
  • Title: Previous Last Name
    Maximum Length: 150
    Person'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
Nested Schema : workers-nationalIdentifiers-item-response
Type: object
Show Source
Nested Schema : National Identifier Descriptive Flexfields
Type: array
Title: National Identifier Descriptive Flexfields
The nationalIdentifiersDFF resource is a child of the nationalIdentifiers resource. It provides all the national identifier descriptive flexfields of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : workers-nationalIdentifiers-nationalIdentifiersDFF-item-response
Type: object
Show Source
Nested Schema : workers-otherCommunicationAccounts-item-response
Type: object
Show Source
Nested Schema : otherCommunicationAccountsDFF
Type: array
Show Source
Nested Schema : workers-otherCommunicationAccounts-otherCommunicationAccountsDFF-item-response
Type: object
Show Source
Nested Schema : workers-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 : 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 : workers-phones-item-response
Type: object
Show Source
Nested Schema : phonesDFF
Type: array
Show Source
Nested Schema : workers-phones-phonesDFF-item-response
Type: object
Show Source
Nested Schema : workers-photos-item-response
Type: object
Show Source
Nested Schema : photosDFF
Type: array
Show Source
Nested Schema : workers-photos-photosDFF-item-response
Type: object
Show Source
Nested Schema : workers-religions-item-response
Type: object
Show Source
Nested Schema : Religion Descriptive Flexfields
Type: array
Title: Religion Descriptive Flexfields
The religionsDFF resource is a child of the workers resource. It provides all the religion descriptive flexfields of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : workers-religions-religionsDFF-item-response
Type: object
Show Source
Nested Schema : workers-visasPermits-item-response
Type: object
Show Source
Nested Schema : Visa Permit Developer Flexfields
Type: array
Title: Visa Permit Developer Flexfields
The visasPermitsDDF resource is a child of the visasPermits resource. It provides all the visa permit descriptive flexfields of a worker as of the specified date. By default, the current date is retained.
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 : Visa Permit Descriptive Flexfields
Type: array
Title: Visa Permit Descriptive Flexfields
The visasPermitsDFF resource is a child of the visasPermits resource. It provides all the visa permit developer flexfields of a worker as of the specified date. By default, the current date is retained.
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 : workers-visasPermits-visasPermitsDFF-item-response
Type: object
Show Source
Nested Schema : workers-workersDFF-item-response
Type: object
Show Source
Nested Schema : Discriminator: CategoryCode
Type: object
Discriminator: CategoryCode

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personEITEFF_base_view_j__PersonExtraInformationPerEitprivateVO-item-response
Type: object
Show Source
Nested Schema : PersonExtraInformationContextHRX_5FCN_5FMILITARY_5FINFOprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextHRX_5FCN_5FOTHER_5FEMPLOYEE_5FINFOprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextHRX_5FCN_5FPERSONAL_5FFILE_5FINFOprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextHRX_5FCN_5FPERSONALITY_5FINFOprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextHRX_5FCN_5FPOLITICAL_5FINFOprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextHRX_5FIN_5FMISCELLANEOUSprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextHRX_5FIN_5FNOMINATIONprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FCA_5FDESIGNATED_5FGROUPSprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FFR_5FDISC_5FACTIONSprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FFR_5FMED_5FEXAMprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FFR_5FPERSO_5FREPprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FINFOprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FQUAL_5FINFOprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FIT_5FDISC_5FACTIONSprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FIT_5FORG_5FROLEprivateVO
Type: array
Show Source
Nested Schema : PersonExtraInformationContextORA_5FHRX_5FIT_5FTRADE_5FUNION_5FRELprivateVO
Type: array
Show Source
Nested Schema : workers-workersEFF-PersonExtraInformationContextHRX_5FCN_5FMILITARY_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workersEFF-PersonExtraInformationContextHRX_5FCN_5FOTHER_5FEMPLOYEE_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workersEFF-PersonExtraInformationContextHRX_5FCN_5FPERSONAL_5FFILE_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workersEFF-PersonExtraInformationContextHRX_5FCN_5FPERSONALITY_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workersEFF-PersonExtraInformationContextHRX_5FCN_5FPOLITICAL_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workersEFF-PersonExtraInformationContextHRX_5FIN_5FMISCELLANEOUSprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workersEFF-PersonExtraInformationContextHRX_5FIN_5FNOMINATIONprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workersEFF-PersonExtraInformationContextORA_5FHRX_5FCA_5FDESIGNATED_5FGROUPSprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workersEFF-PersonExtraInformationContextORA_5FHRX_5FFR_5FDISC_5FACTIONSprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workersEFF-PersonExtraInformationContextORA_5FHRX_5FFR_5FMED_5FEXAMprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workersEFF-PersonExtraInformationContextORA_5FHRX_5FFR_5FPERSO_5FREPprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workersEFF-PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workersEFF-PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FQUAL_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workersEFF-PersonExtraInformationContextORA_5FHRX_5FIT_5FDISC_5FACTIONSprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workersEFF-PersonExtraInformationContextORA_5FHRX_5FIT_5FORG_5FROLEprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workersEFF-PersonExtraInformationContextORA_5FHRX_5FIT_5FTRADE_5FUNION_5FRELprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-item-response
Type: object
Show Source
Nested Schema : assignments
Type: array
Show Source
Nested Schema : contracts
Type: array
Show Source
Nested Schema : workRelationshipsDDF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "BR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFBRVO-item-response", "CA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFCAVO-item-response", "FR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFFRVO-item-response", "GB":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFGBVO-item-response", "MX":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFMXVO-item-response", "NL":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFNLVO-item-response", "SA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFSAVO-item-response", "US":"#/components/schemas/oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFUSVO-item-response" } }
Nested Schema : workRelationshipsDFF
Type: array
Show Source
Nested Schema : workers-workRelationships-assignments-item-response
Type: object
Show Source
Nested Schema : allReports
Type: array
Show Source
Nested Schema : assignmentsDDF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "DE":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFDEVO-item-response", "FR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFFRVO-item-response", "GB":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFGBVO-item-response", "MX":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFMXVO-item-response", "ORA_HRX_ZA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFORA__5FHRX__5FZAVO-item-response", "US":"#/components/schemas/oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFUSVO-item-response" } }
Nested Schema : assignmentsDFF
Type: array
Show Source
Nested Schema : assignmentsEFF
Type: array
Show Source
  • Discriminator: CategoryCode
    Discriminator: { "propertyName":"CategoryCode", "mapping":{ "PER_ASG_EIT":"#/components/schemas/oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-response" } }
Nested Schema : gradeSteps
Type: array
Show Source
Nested Schema : managers
Type: array
Show Source
Nested Schema : representatives
Type: array
Show Source
Nested Schema : workMeasures
Type: array
Show Source
Nested Schema : workers-workRelationships-assignments-allReports-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_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFDEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFFRVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFGBVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFMXVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFORA__5FHRX__5FZAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_baseWorkerAssignmentDDF_view_BaseWorkerAsgLegDDFUSVO-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-assignmentsDFF-item-response
Type: object
Show Source
Nested Schema : Discriminator: CategoryCode
Type: object
Discriminator: CategoryCode

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_assignmentExtraInfoEFF_Category_view_j__CategoryPerAsgEitprivateVO-item-response
Type: object
Show Source
Nested Schema : InformationORA_5FPER_5FRET_5FGRADEprivateVO
Type: array
Show Source
Nested Schema : workers-workRelationships-assignments-assignmentsEFF-InformationORA_5FPER_5FRET_5FGRADEprivateVO-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-gradeSteps-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-managers-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-representatives-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-assignments-workMeasures-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-contracts-item-response
Type: object
Show Source
Nested Schema : contractsDDF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AE":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFAEVO-item-response", "CH":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCHVO-item-response", "CN":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCNVO-item-response", "FR":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFFRVO-item-response", "GB":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFGBVO-item-response", "KW":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFKWVO-item-response", "ORA_HRX_BE":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FBEVO-item-response", "ORA_HRX_IT":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FITVO-item-response", "SA":"#/components/schemas/oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFSAVO-item-response" } }
Nested Schema : contractsDFF
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_employment_core_flex_contractDDF_view_ContractLegDDFAEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCHVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFCNVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFFRVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFGBVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFKWVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FBEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFORA__5FHRX__5FITVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_contractDDF_view_ContractLegDDFSAVO-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-contracts-contractsDFF-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_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFBRVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFCAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFFRVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFGBVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFMXVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFNLVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFSAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_employment_core_flex_periodOfServiceDDF_view_WorkRelationshipLegDDFUSVO-item-response
Type: object
Show Source
Nested Schema : workers-workRelationships-workRelationshipsDFF-item-response
Type: object
Show Source
Back to Top

Examples

The following examples show how to retrieve a worker by submitting a GET request on the REST resource using cURL.

Retrieve a Worker by Last Name

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers?q=names.LastName='Doe'"

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type: application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "PersonId": 300100215315227,
  "PersonNumber": "960000000000900",
  "CorrespondenceLanguage": null,
  "BloodType": null,
  "DateOfBirth": null,
  "DateOfDeath": null,
  "CountryOfBirth": null,
  "RegionOfBirth": null,
  "TownOfBirth": null,
  "ApplicantNumber": null,
  "CreatedBy": "VMOSS",
  "CreationDate": "2019-04-23T10:25:40+00:00",
  "LastUpdatedBy": "VMOSS",
  "LastUpdateDate": "2019-04-23T10:25:44.457+00:00",
  "workRelationships": {
      "items": [
          {
              "PeriodOfServiceId": 300100215315230,
              "LegislationCode": "US",
              "LegalEntityId": 100000011593283,
              "LegalEmployerName": null,
              "WorkerType": "E",
              "PrimaryFlag": true,
              "StartDate": "2018-01-01",
              "LegalEmployerSeniorityDate": null,
              "EnterpriseSeniorityDate": null,
              "OnMilitaryServiceFlag": false,
              "WorkerNumber": null,
              "ReadyToConvertFlag": null,
              "TerminationDate": null,
              "NotificationDate": null,
              "LastWorkingDate": null,
              "RevokeUserAccess": null,
              "RecommendedForRehire": "ORA_NS",
              "RecommendationReason": null,
              "RecommendationAuthorizedByPersonId": null,
              "CreatedBy": "VMOSS",
              "CreationDate": "2019-04-23T10:25:40.075+00:00",
              "LastUpdatedBy": "VMOSS",
              "LastUpdateDate": "2019-04-23T10:25:45.295+00:00",
              "assignments": {
                  "items": [
                      {
                          "AssignmentId": 300100215315237,
                          "AssignmentNumber": "E960000000000900",
                          "AssignmentName": "E960000000000900",
                          "ActionCode": "HIRE",
                          "ReasonCode": null,
                          "EffectiveStartDate": "2018-01-01",
                          "EffectiveEndDate": "4712-12-31",
                          "EffectiveSequence": 1,
                          "EffectiveLatestChange": "Y",
                          "BusinessUnitId": 100010025072009,
                          "BusinessUnitName": "GBI HCM-Financials USA BU",
                          "AssignmentType": "E",
                          "AssignmentStatusTypeId": 100010026278977,
                          "AssignmentStatusTypeCode": "ACTIVE_PROCESS",
                          "AssignmentStatusType": "ACTIVE",
                          "SystemPersonType": "EMP",
                          "UserPersonTypeId": 100010025072012,
                          "UserPersonType": "Employee",
                          "ProposedUserPersonTypeId": null,
                          "ProposedUserPersonType": null,
                          "ProjectedStartDate": null,
                          "ProjectedEndDate": null,
                          "PrimaryFlag": true,
                          "PrimaryAssignmentFlag": true,
                          "PositionId": null,
                          "PositionCode": null,
                          "SynchronizeFromPositionFlag": false,
                          "JobId": null,
                          "JobCode": null,
                          "GradeId": null,
                          "GradeCode": null,
                          "GradeLadderId": null,
                          "GradeLadderName": null,
                          "GradeStepEligibilityFlag": true,
                          "GradeCeilingStepId": null,
                          "GradeCeilingStep": null,
                          "DepartmentId": null,
                          "DepartmentName": null,
                          "ReportingEstablishmentId": null,
                          "ReportingEstablishmentName": null,
                          "LocationId": null,
                          "LocationCode": null,
                          "WorkAtHomeFlag": false,
                          "AssignmentCategory": null,
                          "WorkerCategory": null,
                          "PermanentTemporary": null,
                          "FullPartTime": null,
                          "ManagerFlag": false,
                          "HourlySalariedCode": null,
                          "NormalHours": null,
                          "Frequency": null,
                          "StartTime": null,
                          "EndTime": null,
                          "SeniorityBasis": "ORA_PER_SNDT_DAYS",
                          "ProbationPeriod": null,
                          "ProbationPeriodUnit": null,
                          "ProbationEndDate": null,
                          "NoticePeriod": null,
                          "NoticePeriodUOM": null,
                          "WorkTaxAddressId": null,
                          "ExpenseCheckSendToAddress": null,
                          "RetirementAge": null,
                          "RetirementDate": null,
                          "LabourUnionMemberFlag": null,
                          "UnionId": null,
                          "UnionName": null,
                          "BargainingUnitCode": null,
                          "CollectiveAgreementId": null,
                          "CollectiveAgreementName": null,
                          "InternalBuilding": null,
                          "InternalFloor": null,
                          "InternalOfficeNumber": null,
                          "InternalMailstop": null,
                          "DefaultExpenseAccount": null,
                          "PeopleGroup": null,
                          "CreatedBy": "VMOSS",
                          "CreationDate": "2019-04-23T10:25:40.216+00:00",
                          "LastUpdatedBy": "VMOSS",
                          "LastUpdateDate": "2019-04-23T10:25:45.812+00:00",
                          "links": [
                              {
                                 ...}
          }
    ]
} 

Retrieve a Worker by Effective Date

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers?q=names.LastName='Doe'&effectiveDate=2005-02-01"

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type: application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "PersonId": 300100215315227,
  "PersonNumber": "960000000000900",
  "CorrespondenceLanguage": null,
  "BloodType": null,
  "DateOfBirth": null,
  "DateOfDeath": null,
  "CountryOfBirth": null,
  "RegionOfBirth": null,
  "TownOfBirth": null,
  "ApplicantNumber": null,
  "CreatedBy": "VMOSS",
  "CreationDate": "2019-04-23T10:25:40+00:00",
  "LastUpdatedBy": "VMOSS",
  "LastUpdateDate": "2019-04-23T10:25:44.457+00:00",
  "workRelationships": {
      "items": [
          {
              "PeriodOfServiceId": 300100215315230,
              "LegislationCode": "US",
              "LegalEntityId": 100000011593283,
              "LegalEmployerName": null,
              "WorkerType": "E",
              "PrimaryFlag": true,
              "StartDate": "2018-01-01",
              "LegalEmployerSeniorityDate": null,
              "EnterpriseSeniorityDate": null,
              "OnMilitaryServiceFlag": false,
              "WorkerNumber": null,
              "ReadyToConvertFlag": null,
              "TerminationDate": null,
              "NotificationDate": null,
              "LastWorkingDate": null,
              "RevokeUserAccess": null,
              "RecommendedForRehire": "ORA_NS",
              "RecommendationReason": null,
              "RecommendationAuthorizedByPersonId": null,
              "CreatedBy": "VMOSS",
              "CreationDate": "2019-04-23T10:25:40.075+00:00",
              "LastUpdatedBy": "VMOSS",
              "LastUpdateDate": "2019-04-23T10:25:45.295+00:00",
              "assignments": {
                  "items": [
                      {
                          "AssignmentId": 300100215315237,
                          "AssignmentNumber": "E960000000000900",
                          "AssignmentName": "E960000000000900",
                          "ActionCode": "HIRE",
                          "ReasonCode": null,
                          "EffectiveStartDate": "2005-02-01",
                          "EffectiveEndDate": "4712-12-31",
                          "EffectiveSequence": 1,
                          "EffectiveLatestChange": "Y",
                          "BusinessUnitId": 100010025072009,
                          "BusinessUnitName": "GBI HCM-Financials USA BU",
                          "AssignmentType": "E",
                          "AssignmentStatusTypeId": 100010026278977,
                          "AssignmentStatusTypeCode": "ACTIVE_PROCESS",
                          "AssignmentStatusType": "ACTIVE",
                          "SystemPersonType": "EMP",
                          "UserPersonTypeId": 100010025072012,
                          "UserPersonType": "Employee",
                          "ProposedUserPersonTypeId": null,
                          "ProposedUserPersonType": null,
                          "ProjectedStartDate": null,
                          "ProjectedEndDate": null,
                          "PrimaryFlag": true,
                          "PrimaryAssignmentFlag": true,
                          "PositionId": null,
                          "PositionCode": null,
                          "SynchronizeFromPositionFlag": false,
                          "JobId": null,
                          "JobCode": null,
                          "GradeId": null,
                          "GradeCode": null,
                          "GradeLadderId": null,
                          "GradeLadderName": null,
                          "GradeStepEligibilityFlag": true,
                          "GradeCeilingStepId": null,
                          "GradeCeilingStep": null,
                          "DepartmentId": null,
                          "DepartmentName": null,
                          "ReportingEstablishmentId": null,
                          "ReportingEstablishmentName": null,
                          "LocationId": null,
                          "LocationCode": null,
                          "WorkAtHomeFlag": false,
                          "AssignmentCategory": null,
                          "WorkerCategory": null,
                          "PermanentTemporary": null,
                          "FullPartTime": null,
                          "ManagerFlag": false,
                          "HourlySalariedCode": null,
                          "NormalHours": null,
                          "Frequency": null,
                          "StartTime": null,
                          "EndTime": null,
                          "SeniorityBasis": "ORA_PER_SNDT_DAYS",
                          "ProbationPeriod": null,
                          "ProbationPeriodUnit": null,
                          "ProbationEndDate": null,
                          "NoticePeriod": null,
                          "NoticePeriodUOM": null,
                          "WorkTaxAddressId": null,
                          "ExpenseCheckSendToAddress": null,
                          "RetirementAge": null,
                          "RetirementDate": null,
                          "LabourUnionMemberFlag": null,
                          "UnionId": null,
                          "UnionName": null,
                          "BargainingUnitCode": null,
                          "CollectiveAgreementId": null,
                          "CollectiveAgreementName": null,
                          "InternalBuilding": null,
                          "InternalFloor": null,
                          "InternalOfficeNumber": null,
                          "InternalMailstop": null,
                          "DefaultExpenseAccount": null,
                          "PeopleGroup": null,
                          "CreatedBy": "VMOSS",
                          "CreationDate": "2019-04-23T10:25:40.216+00:00",
                          "LastUpdatedBy": "VMOSS",
                          "LastUpdateDate": "2019-04-23T10:25:45.812+00:00",
                          "links": [
                              {
                                 ...}
          }
    ]
}
Back to Top