1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Recruiting Candidate Extra Information Details

Get all extra information of a candidate

get

/hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation

Request

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

    Format: ?fields=Attribute1,Attribute2

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

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

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds recruitingCandidateExtraInformation by a unique ID
      Finder Variables
      • PersonId; integer; Finds recruitingCandidateExtraInformation by the primary key PersonId; integer;
    • findByPersonId Finds recruitingCandidateExtraInformation by a person ID
      Finder Variables
      • PersonId; integer; Finds recruitingCandidateExtraInformation by a unique person ID
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

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

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CandidateNumber; string; Unique number assigned to each candidate in the candidate extra info.
    • CategoryCode; string; Unique code for the extensible flexfield category.
    • PersonId; integer; Person's unique identifier that the extra information is requested for.
  • 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
  • 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 : recruitingCandidateExtraInformation
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : recruitingCandidateExtraInformation-item-response
Type: object
Show Source
Nested Schema : jPersonExtraInformation
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 : 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 : Links
Type: array
Title: Links
The link relations associated with the resource instance.
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 : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FCN_5FMILITARY_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FCN_5FOTHER_5FEMPLOYEE_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FCN_5FPERSONAL_5FFILE_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FCN_5FPERSONALITY_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FCN_5FPOLITICAL_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FIN_5FMISCELLANEOUSprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextHRX_5FIN_5FNOMINATIONprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FCA_5FDESIGNATED_5FGROUPSprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FFR_5FDISC_5FACTIONSprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FFR_5FMED_5FEXAMprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FFR_5FPERSO_5FREPprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FGB_5FSWC_5FQUAL_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FIT_5FDISC_5FACTIONSprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FIT_5FORG_5FROLEprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingCandidateExtraInformation-jPersonExtraInformation-PersonExtraInformationContextORA_5FHRX_5FIT_5FTRADE_5FUNION_5FRELprivateVO-item-response
Type: object
Show Source
Back to Top