Jump to

• Request
• Response

Get all flexfields

get

/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF

Request

Path Parameters

• CitizenshipId(required): integer(int64)
  Surrogate identifier for the citizenship of a worker.
• workersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Workers resource and used to uniquely identify an instance of Workers. The client should not generate the hash key value. Instead, the client should query on the Workers collection resource in order to navigate to a specific instance of Workers to get the hash key.

Query Parameters

• dependency: string
  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>
• expand: string
  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).
• fields: string
  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
• finder: string
  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 worker citizenship flexfields that match the specified primary key criteria.
    Finder Variables:
    • CitizenshipId; integer; Surrogate identifier for the citizenship of a worker.
• limit: integer
  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.
• links: string
  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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • EmailAddressId; integer
  • __FLEX_Context; string; Descriptive flexfield for email.
  • __FLEX_Context_DisplayValue; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ReligionId; integer
  • __FLEX_Context; string; Descriptive flexfield for religions.
  • __FLEX_Context_DisplayValue; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssignGradeStepId; integer; Surrogate identifier for the assignment grade step record.
  • CreatedBy; string
  • CreationDate; string
  • EffectiveEndDate; string; End date of the date-effective changes to the record.
  • EffectiveStartDate; string; Start date of the date-effective changes to the record.
  • GradeStepId; integer; Surrogate identifier for the grade step.
  • GradeStepName; string; Name of the grade step. Valid values are defined in the gradeStepNamesLOV.
  • LastUpdateDate; string
  • LastUpdatedBy; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • PhotoName; string; Name of the image file.
  • PhotoType; string; Type of photo such as Profile or Cover. Valid values are defined in the commonLookupsLOV.
  • PrimaryFlag; boolean; Indicates whether the image is primary.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ExpirationDate; string; Expiration date of the passport.
  • IssuingCountry; string; Country in which the passport was issued. Valid values are defined in the hcmCountriesLov.
  • IssuingCountryName; string
  • PassportId; integer
  • PassportNumber; string; Passport number of the person.
  • PassportType; string; Type or category of the passport. Valid values are defined in the commonLookupsLOV.
  • PassportTypeMeaning; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AsgResponsibilityId; integer
  • AssignmentId; integer
  • AssignmentName; string
  • AssignmentNumber; string
  • DisplayName; string
  • PersonId; integer
  • PersonNumber; string
  • ResponsibilityName; string
  • ResponsibilityType; string
  • Usage; string
  • WorkContactsFlag; boolean

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • EffectiveEndDate; string; Descriptive flexfield for address.
  • EffectiveStartDate; string; Descriptive flexfield for address.
  • PersonAddrUsageId; integer
  • __FLEX_Context; string; Descriptive flexfield for address.
  • __FLEX_Context_DisplayValue; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ImageId; integer
  • __FLEX_Context; string; Descriptive flexfield for photos.
  • __FLEX_Context_DisplayValue; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • DeliveryMethodId; integer
  • __FLEX_Context; string; Descriptive flexfield for other communication accounts.
  • __FLEX_Context_DisplayValue; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AddressId; integer; Surrogate identifier for the address record.
  • AddressType; string; Type of address. Valid values are defined in the commonLookupsLOV.
  • AddressTypeMeaning; string
  • Building; string; Building information associated with the address.
  • Country; string; Country in which the address is located. Valid values are defined in the hcmCountriesLov.
  • CountryName; string
  • EffectiveEndDate; string; End date of the date-effective changes to the record.
  • EffectiveStartDate; string; Start date of the date-effective changes to the record.
  • FloorNumber; string; Floor number associated with the building.
  • Latitude; number; Distance between the equator and an address located to its north or south, expressed in degrees and minutes.
  • LongPostalCode; string; Long postal code of the primary mail address.
  • Longitude; number; Distance between the prime meridian and an address located to its east or west, expressed in degrees and minutes.
  • PersonAddrUsageId; integer
  • PostalCode; string; Postal code of the primary mail address.
  • PrimaryFlag; boolean; Indicates whether the address is the primary mailing address.
  • Provider; string; Company that has validated the address.
  • Region1; string; Primary region in which the address is located.
  • Region2; string; Secondary region within the primary region.
  • Region3; string; Additional secondary region within the primary region.
  • TownOrCity; string; Town or city in which the address is located.
  • ValidationStatusCode; string; Level of accuracy of an address, as determined by an address provider.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Ethnicity; string; Person's ethnicity. Valid values are defined in the commonLookupsLOV.
  • EthnicityId; integer
  • EthnicityMeaning; string
  • LegislationCode; string; Legislation code of the ethnicity. Valid values are defined in the hcmCountriesLov.
  • LegislationName; string
  • PrimaryFlag; boolean; Indicates whether the ethnicity is the primary ethnicity record for the person.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • CreationDate; string
  • EffectiveEndDate; string; End date of the date-effective changes to the record.
  • EffectiveStartDate; string; Start date of the date-effective changes to the record.
  • LastUpdateDate; string
  • ManagerAssignmentId; integer; Surrogate identifier for the assignment supervisor.
  • ManagerAssignmentNumber; string; Assignment number of the supervisor.
  • ManagerType; string; Role the supervisor has with regards to the overall organization structure such as functional, project leader, and so on. Valid values are defined in the commonLookupsLOV.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • DisplayName; string
  • EffectiveEndDate; string; End date of the date-effective changes to the record.
  • EffectiveStartDate; string; Start date of the date-effective changes to the record.
  • FirstName; string; Person's first name.
  • FullName; string
  • Honors; string; Higher qualification appended to a person's name such as PhD.
  • KnownAs; string; Person's preferred name.
  • LastName; string; Person's last name.
  • LegislationCode; string; Legislation code. Valid values are defined in the hcmCountriesLov.
  • LegislationName; string
  • ListName; string
  • LocalCreatedBy; string
  • LocalCreationDate; string
  • LocalDisplayName; string
  • LocalEffectiveEndDate; string; End date of the date-effective changes to the record.
  • LocalEffectiveStartDate; string; Start date of the date-effective changes to the record.
  • LocalFirstName; string; Person's first name in local language.
  • LocalFullName; string
  • LocalHonors; string; Higher qualification appended to a person's name such as PhD in local language.
  • LocalKnownAs; string; Person's preferred name in local language.
  • LocalLastName; string; Person's last name in local language.
  • LocalLastUpdateDate; string
  • LocalLastUpdatedBy; string
  • LocalLegislationCode; string; Legislation code of the local language. Valid values are defined in the hcmCountriesLov.
  • LocalLegislationName; string
  • LocalListName; string
  • LocalMiddleNames; string; Person's middle name in local language.
  • LocalMilitaryRank; string; Person's military rank in local language.
  • LocalNameInformation1; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation10; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation11; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation12; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation13; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation14; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation15; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation16; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation17; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation18; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation19; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation2; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation20; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation21; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation22; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation23; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation24; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation25; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation26; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation27; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation28; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation29; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation3; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation30; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation4; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation5; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation6; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation7; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation8; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • LocalNameInformation9; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • LocalNameLanguage; string; 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.
  • LocalNameLanguageMeaning; string
  • LocalOrderName; string
  • LocalPersonNameId; integer; Surrogate identifier for the local name record.
  • LocalPreNameAdjunct; string; Part of the name added before a person's first name in local language.
  • LocalPreviousLastName; string; Person's previous last name in local language.
  • LocalSuffix; string; Part of the name appended to a person's last name such as Jr., III, and so on, in local language.
  • LocalTitle; string; Person's salutation such as Mr., Ms., and so on in local language. Valid values are defined in the commonLookupsLOV.
  • LocalTitleMeaning; string
  • MiddleNames; string; Person's middle name.
  • MilitaryRank; string; Person's military rank.
  • NameInformation1; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • NameInformation10; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • NameInformation11; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • NameInformation12; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • NameInformation13; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • NameInformation14; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • NameInformation15; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • NameInformation16; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • NameInformation17; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • NameInformation18; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • NameInformation19; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • NameInformation2; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • NameInformation20; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • NameInformation21; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • NameInformation22; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • NameInformation23; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • NameInformation24; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • NameInformation25; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • NameInformation26; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • NameInformation27; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • NameInformation28; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • NameInformation29; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • NameInformation3; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • NameInformation30; string; Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.
  • NameInformation4; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • NameInformation5; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • NameInformation6; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • NameInformation7; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • NameInformation8; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • NameInformation9; string; Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.
  • NameLanguage; string
  • NameLanguageMeaning; string
  • OrderName; string
  • PersonNameId; integer
  • PreNameAdjunct; string; Part of the name added before a person's first name.
  • PreviousLastName; string; Person's previous last name.
  • Suffix; string; Part of the name appended to a person's last name such as Jr., III, and so on.
  • Title; string; Person salutation such as Mr., Ms., and so on. Valid values are defined in the commonLookupsLOV.
  • TitleMeaning; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • EffectiveEndDate; string; Descriptive flexfield for legislative information.
  • EffectiveStartDate; string; Descriptive flexfield for legislative information.
  • PersonLegislativeId; integer
  • __FLEX_Context; string; Descriptive flexfield for legislative information.
  • __FLEX_Context_DisplayValue; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • EffectiveEndDate; string; Descriptive flexfield for visa permits.
  • EffectiveStartDate; string; Descriptive flexfield for visa permits.
  • VisaPermitId; integer
  • __FLEX_Context; string; Descriptive flexfield for visa permits.
  • __FLEX_Context_DisplayValue; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • LegalEmployerName; string; Name of the legal employer for the work relationship.
  • LegalEntityId; integer; Unique identifier for the legal entity of the work relationship.
  • LegislationCode; string
  • PeriodOfServiceId; integer
  • PrimaryFlag; boolean; Indicates whether the work relationship is the primary work relationship for the worker. Valid values are Yes and No.
  • ProjectedTerminationDate; string; Projected last date of employment for the period of service.
  • ReadyToConvertFlag; boolean; Indicates whether the pending worker is ready to be converted to the proposed worker type.
  • StartDate; string; Start date of the period of employment.
  • TerminationDate; string
  • WorkerType; string; Worker type for the period of service such as Employee (E), Contingent Worker (C), Pending Worker (P), or Non-worker (N). Valid values are defined in the commonLookupsLOV.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • PersonId; integer
  • __FLEX_Context; string; Descriptive flexfield for workers.
  • __FLEX_Context_DisplayValue; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AreaCode; string; Area code of the phone number.
  • CountryCodeNumber; string; Country code of the phone number. Valid values are defined in the hcmCountriesLov.
  • Extension; string; Extension number for the phone.
  • LegislationCode; string; Phone legislation code.
  • LegislationName; string
  • PhoneId; integer
  • PhoneNumber; string; Phone number of various phone types such as Work, Home, and so on.
  • PhoneType; string; Type of phone such as Work, Home, and so on. Valid values are defined in the commonLookupsLOV.
  • PhoneTypeMeaning; string
  • PrimaryFlag; boolean; Indicates whether the phone number is the primary phone of the worker.
  • ToDate; string; Date until when the phone number is valid.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • FromDate; string; Date from when the message is effective.
  • MessageContent; string; Content of the message notification.
  • MessageId; integer
  • ToDate; string; Date until when the message is effective.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • EmailAddress; string; Email address of the person.
  • EmailAddressId; integer
  • EmailType; string; Type of email such as work, personal, and so on. Valid values are defined in the commonLookupsLOV.
  • EmailTypeMeaning; string
  • PrimaryFlag; boolean; Indicates whether the email is the person's primary email.
  • ToDate; string; Date until when the email address is valid.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ApplicantNumber; string; Applicant number in the external application.
  • BloodTypeMeaning; string
  • CorrLanguageMeaning; string
  • CountryOfBirthName; string
  • DateOfBirth; string; Date of birth of the person.
  • DisplayName; string
  • FullName; string
  • ListName; string
  • PersonId; integer; Surrogate identifier for the person.
  • PersonNumber; string; Number assigned to a person to identify the person uniquely. Does not depend on the person type such as employee, contingent worker, and so on.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AccommodationRequest; string; Request for accomodation.
  • Category; string; Category of the disability such as Physical or Intellectual.
  • CreatedBy; string
  • CreationDate; string
  • Degree; number; Extent to which the disability impacts the person's abilities.
  • Description; string; Description of the person's disability.
  • DisabilityCode; string; Code for the disability.
  • DisabilityId; integer; Surrogate identifier for the disability of a worker.
  • DisclosureDate; string; Date on which the disability has been disclosed by the worker. Used explicitly for the Japanese, United Kingdom, and United States legislation.
  • EffectiveEndDate; string; End date of the date-effective changes to the record.
  • EffectiveStartDate; string; Start date of the date-effective changes to the record.
  • LastUpdateDate; string
  • LastUpdatedBy; string
  • LegislationCode; string; Legislation code for the disability. Valid values are defined in the hcmCountriesLov.
  • OrganizationId; integer; Unique identifier of the organization.
  • OrganizationName; string; Organization name to which the disability is registered.
  • QuotaFTE; number; Person's full time equivalency.
  • Reason; string; Reason for the person's disability.
  • RegistrationDate; string; Date on which the disability was registered with the disability organization.
  • RegistrationExpDate; string; Expiration date of the disability registration.
  • RegistrationId; string; Identification detail given to the person by the disability organization.
  • SelfDisclosedType; string; Type of disability disclosed by the worker. Used explicitly for the Japanese, United Kingdom, and United States legislation.
  • Status; string; Status of the person's disability.
  • WorkRestriction; string; Details of any work restrictions due to the disability.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssignmentId; integer
  • AssignmentName; string
  • AssignmentNumber; string
  • DisplayName; string
  • Level; integer
  • PersonId; integer
  • PersonNumber; string
  • RelationshipType; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssignmentId; integer
  • AssignmentType; string
  • EffectiveEndDate; string; Descriptive flexfield for assignments.
  • EffectiveLatestChange; string; Descriptive flexfield for assignments.
  • EffectiveSequence; integer; Descriptive flexfield for assignments.
  • EffectiveStartDate; string; Descriptive flexfield for assignments.
  • __FLEX_Context; string; Descriptive flexfield for assignments.
  • __FLEX_Context_DisplayValue; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • LegislationCode; string; Religion legislation code. Valid values are defined in the hcmCountriesLov.
  • LegislationName; string
  • PrimaryFlag; boolean; Indicates whether the religion is the person's primary religion for this legislation.
  • Religion; string; Religion of the person. Valid values are defined in the commonLookupsLOV.
  • ReligionId; integer
  • ReligionMeaning; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ContractId; integer
  • EffectiveEndDate; string; Descriptive flexfield for contracts.
  • EffectiveStartDate; string; Descriptive flexfield for contracts.
  • __FLEX_Context; string; Descriptive flexfield for contracts.
  • __FLEX_Context_DisplayValue; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • NationalIdentifierId; integer
  • __FLEX_Context; string; Descriptive flexfield for national identifier.
  • __FLEX_Context_DisplayValue; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • DriversLicenseId; integer
  • IssuingCountry; string; Country in which the driver's license was issued. Valid values are defined in the hcmCountriesLov.
  • IssuingCountryName; string
  • LicenseNumber; string; Driver's license number.
  • LicenseSuspendedFlag; boolean; Indicates whether the driver's license is suspended.
  • LicenseType; string; Type of license. Valid values are defined in the commonLookupsLOV.
  • LicenseTypeMeaning; string
  • SuspendedFromDate; string; Start date of suspension period, if any.
  • SuspendedToDate; string; End date of suspension period, if any.
  • ToDate; string; Date until when the the driver's license is valid.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • PeriodOfServiceId; integer
  • __FLEX_Context; string; Descriptive flexfield for work relationships.
  • __FLEX_Context_DisplayValue; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActionCode; string; Action being performed for this assignment, such as, Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.
  • AssignmentCategory; string; User-defined category for the assignment such as full-time, permanent, and so on. Valid values are defined in the commonLookupsLOV.
  • AssignmentId; integer
  • AssignmentName; string; Business title of the worker assignment.
  • AssignmentNumber; string; Unique identifier for the assignment.
  • AssignmentStatusType; string
  • AssignmentType; string
  • BargainingUnitCode; string; Code for the bargaining unit.
  • BusinessUnitId; integer; Unique identifier for the business unit of the assignment.
  • BusinessUnitName; string; Name of the business unit for the worker assignment. Valid values are defined in the hcmBusinesUnitsLOV.
  • CollectiveAgreementId; integer; Surrogate identifier for the collective agreement.
  • CollectiveAgreementName; string; Name for the collective agreement. Valid values are defined in the collectiveAgreementsLov.
  • ContractId; integer; Surrogate identifier for the contract.
  • ContractNumber; string; Number of the contract.
  • DefaultExpenseAccount; string; Default expense account of the assignment. If the expense account is configured with multiple segments, then provide the concatenated value. Separate the values using the separator configured for the expense account.
  • DepartmentId; integer; Unique identifier for the worker's department.
  • DepartmentName; string; Name of the department for the worker assignment. Valid values are defined in the departmentsLov.
  • EffectiveEndDate; string; End date of the date-effective changes to the record.
  • EffectiveLatestChange; string; Set to Y if this is the last change on the effective start date. Otherwise, set to N.
  • EffectiveSequence; integer; Sequence number of the change on the effective start date. For the first change on the effective start date, set this value to 1. For incremental changes, leave this value blank to generate the next number in the sequence.
  • EffectiveStartDate; string; Start date of the date-effective changes to the record.
  • FullPartTime; string; Indicates whether the worker works full-time or part-time. Valid values are defined in the commonLookupsLOV.
  • GradeCode; string; Code of the assignment grade. Valid values are defined in the gradesLov.
  • GradeId; integer; Unique identifier for the worker's grade.
  • GradeLadderId; integer; Unique identifier for the grade ladder used for benefits.
  • GradeLadderName; string; Name of the grade ladder used for benefits. Valid values are defined in the gradeLaddersLov.
  • GradeStepEligibilityFlag; boolean; Indicates whether the assignment is eligible for grade-step progression. Valid values are true or false.
  • HourlySalariedCode; string; Identifies whether the assignment is paid by the hour or by a salary. Either maintained at the assignment level or employment or placement terms but not both. Valid values are defined in the commonLookupsLOV.
  • JobCode; string; Code for the worker's job. Valid values are defined in the jobsLov.
  • JobId; integer; Unique identifier for the worker's job.
  • LabourUnionMemberFlag; boolean; Indicates whether the worker is a labor union member.
  • LocationCode; string; Code for the worker's location.
  • LocationId; integer; Unique identifier for the worker's location.
  • ManagerFlag; boolean; Indicates whether the worker is a manager.
  • NoticePeriod; integer; Notice period for the assignment. Specify with the NoticePeriodUOM attribute.
  • NoticePeriodUOM; string; Unit of measure for the notice period. Specify with the NoticePeriod attribute. Valid values are defined in the commonLookupsLOV.
  • PeopleGroup; string; People Group Key flexfield for the assignment. If people group is configured with multiple segments, provide the concatenated value, separating the values with the separator configured for the People Group Key flexfield.
  • PermanentTemporary; string; Indicates whether the worker is regular or temporary. Valid values are defined in the commonLookupsLOV.
  • PositionCode; string; Code for the worker's position.
  • PositionId; integer; Unique identifier for the worker's position.
  • PrimaryAssignmentFlag; boolean; Indicates whether the current assignment is primary for the work relationship. Valid values are true or false.
  • PrimaryFlag; boolean
  • ProbationEndDate; string; End date of the probation period.
  • ProbationPeriod; number; Duration of the probation period. Specify with the ProbationPeriodUnit attribute.
  • ProbationPeriodUnit; string; Unit of measure for the probation period. Specify with the ProbationPeriod attribute. Valid values are defined in the commonLookupsLOV.
  • ProjectedEndDate; string; Date when the assignment is expected to end.
  • ProjectedStartDate; string; Expected start date for applicants. This value is required for pending workers.
  • ProposedUserPersonType; string; Code of the proposed user person type. Valid values are defined in the personTypesLOV.
  • ProposedUserPersonTypeId; string; Unique identifier for the proposed user person type.
  • ReportingEstablishmentId; integer; Unique identifier for the reporting establishment.
  • ReportingEstablishmentName; string; Name of the reporting establishment. Valid values are defined in the reportingEstablishmentsLOV.
  • RetirementAge; integer; Age at which the worker is retiring.
  • RetirementDate; string; Planned retirement date of the worker.
  • SeniorityBasis; string; Basis for calculating seniority for the person. Valid values are defined in the commonLookupsLOV.
  • SynchronizeFromPositionFlag; boolean; Indicates whether attributes from the position can be overridden on the assignment when using position synchronization. Valid values are true or false.
  • UnionId; integer; Unique identifier of the worker union for the assignment.
  • UnionName; string; Name of the worker union for the assignment. Valid values are defined in the unionsLov.
  • UserPersonTypeId; integer; Unique identifier for the user person type.
  • WorkAtHomeFlag; boolean; Indicates whether the worker works at home for the assignment.
  • WorkerCategory; string; Category of the worker such as blue collar, civil servant, and so on. Valid values are defined in the commonLookupsLOV.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AccountName; string; Name of the account.
  • DeliveryMethodId; integer
  • EndDate; string; End date of the account.
  • Provider; string; Provider of the account such as Facebook and Twitter. Valid values are defined in the commonLookupsLOV.
  • ProviderMeaning; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Citizenship; string; Citizenship legislation code. Valid values are defined in the hcmCountriesLov.
  • CitizenshipId; integer
  • CitizenshipMeaning; string
  • CitizenshipStatus; string; Status of the citizenship. Valid values are defined in the commonLookupsLOV.
  • CitizenshipStatusMeaning; string
  • ToDate; string; Date until when the citizenship is valid.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssignmentId; integer; Unique identifier of the assignment to which this external identifier relates.
  • AssignmentName; string
  • AssignmentNumber; string; Assignment number to which the external identifier belongs.
  • ExternalIdentifierId; integer
  • ExternalIdentifierNumber; string; External identifier number.
  • ExternalIdentifierSequence; integer; Sequence of the external identifier.
  • ExternalIdentifierType; string; Type of external identifier, such as Third-Party Payroll ID. Valid values are defined in the commonLookupsLOV.
  • ExternalIdentifierTypeMeaning; string
  • FromDate; string; Date and time from when the external identifier is valid.
  • ToDate; string; Date and time until when the external identifier is valid.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • EffectiveEndDate; string; End date of the date-effective changes to the record.
  • EffectiveStartDate; string; Start date of the date-effective changes to the record.
  • ExpirationDate; string; Expiration date of the visa or permit.
  • IssuingCountry; string; Country in which the visa or permit was issued. Valid values are defined in the hcmCountriesLov.
  • IssuingCountryName; string
  • VisaPermitCategory; string; Category of the visa or permit. Valid values are defined in the commonLookupsLOV.
  • VisaPermitCategoryMeaning; string
  • VisaPermitId; integer
  • VisaPermitNumber; string; Visa or permit number.
  • VisaPermitStatus; string; Indicates if the visa or permit is current. Valid values are defined in the commonLookupsLOV.
  • VisaPermitStatusDate; string; Date from when the permit status is effective.
  • VisaPermitStatusMeaning; string
  • VisaPermitType; string; Visa or permit type. Valid values are defined in the commonLookupsLOV.
  • VisaPermitTypeMeaning; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActionCode; string; Action code for the employment contract.
  • ContractEndDate; string; Date when the contract ends.
  • ContractExtensionFlag; boolean; Indicates whether the contract should be extended. Valid values are Yes and No. The default value is null.
  • ContractId; integer; Surrogate identifier for the contract.
  • ContractNumber; string; Number of the contract.
  • ContractType; string; Type of the contract.
  • EffectiveEndDate; string; End date of the date-effective changes to the record.
  • EffectiveStartDate; string; Start date of the date-effective changes to the record.
  • ExtensionNumber; integer
  • ExtensionPeriod; number; Extension period of the contract.
  • ExtensionPeriodUnits; string; Unit for the extension period of the contract.
  • InitialDuration; number; Initial duration of the contract.
  • InitialDurationUnits; string; Unit for the initial duration of the contract.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • CitizenshipId; integer
  • __FLEX_Context; string; Descriptive flexfield for citizenship.
  • __FLEX_Context_DisplayValue; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • DriversLicenseTypeId; integer
  • __FLEX_Context; string; Descriptive flexfield for driver's license.
  • __FLEX_Context_DisplayValue; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • PhoneId; integer
  • __FLEX_Context; string; Descriptive flexfield for phone.
  • __FLEX_Context_DisplayValue; string
• totalResults: boolean
  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

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  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-citizenships-citizenshipsDFF

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/workers-citizenships-citizenshipsDFF-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object workers-citizenships-citizenshipsDFF-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/workers-citizenships-citizenshipsDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : workers-citizenships-citizenshipsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield for citizenship.
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• CitizenshipId: integer (int64)
  Title: Citizenship ID
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CitizenshipId":{
            "title":"Citizenship ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield for citizenship.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top