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

Get all details of recruitingCECandidates

get

/hcmRestApi/resources/11.13.18.05/recruitingCECandidates

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 recruitingCECandidates by a unique ID
      Finder Variables
      • CandidateNumber; string; Finds recruitingCECandidates by a unique ID and the candidate number
  • 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:
    • AddressLine4; string; Value of line 4 of the candidate's address.
    • CwkCandidateFlag; boolean; Indicates if it's a contingent worker candidate in recruitingCECandidates
    • DateOfBirth; string; Date of birth in recruitingCECandidates
    • EmailChangeConfirmed; string; Email Change Confirmed in recruitingCECandidates.
    • EmailChangeRequested; string; Email Change Requested in recruitingCECandidates.
    • EmailPreferredFlag; boolean; Indicates that the candidate has selected email as the preferred communication channel.
    • EmailVerificationRequested; string; Indicates that the candidate has requested for an email verification.
    • EmailVerifiedFlag; boolean; Indicates that the email ID is verified.
    • ExWorkerFlag; boolean; Indicates if the candidate is an ex worker in recruitingCECandidates.
    • NewPhone; string; Phone number specified by the candidate in the event of a change in the existing phone number.
    • PhonePreferredFlag; boolean; Indicates that the candidate has selected phone as the preferred communication channel.
    • PhoneVerificationRequested; string; Indicates that the candidate has requested for a phone verification.
    • PhoneVerifiedFlag; boolean; Indicates that the phone number is verified.
    • PreferredLanguage; string; Preferred language in recruitingCECandidates.
    • PreferredTimezone; string; Preferred time zone of the external candidate.
    • PreviousPhone; string; Previous phone number specified by the candidate before the change in the number.
    • SiteNumber; string; Site Number in recruitingCECandidates.
  • 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 : recruitingCECandidates
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : recruitingCECandidates-item-response
Type: object
Show Source
Nested Schema : Candidate Details with Attachments
Type: array
Title: Candidate Details with Attachments
The attachments resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with attachments. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Candidate Details with Extra Information Data
Type: array
Title: Candidate Details with Extra Information Data
The CandidateExtraInformation resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Candidate Details with PII Data
Type: array
Title: Candidate Details with PII Data
The CandidatePIIData resource is a child of the recruitingCECandidates resource. It includes the details of the candidate national identifiers and date of birth. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCECandidates-attachments-item-response
Type: object
Show Source
Nested Schema : recruitingCECandidates-candidateExtraInformation-item-response
Type: object
Show Source
Nested Schema : Candidate Details with Extra Information Rows
Type: array
Title: Candidate Details with Extra Information Rows
The Rows resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information rows. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCECandidates-candidateExtraInformation-dataRows-item-response
Type: object
Show Source
Nested Schema : Candidate Details with Extra Information Attributes
Type: array
Title: Candidate Details with Extra Information Attributes
The attributes resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information row attributes. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCECandidates-candidateExtraInformation-dataRows-attributes-item-response
Type: object
Show Source
  • Unique identifier for extra information row context corresponding to the attributes.
  • Unique identifier for extra information row data corresponding to the attributes.
  • Links
  • Maximum Length: 255
    Name of the candidate extra information row attribute.
  • Maximum Length: 255
    Value of the candidate extra information row attribute.
Nested Schema : recruitingCECandidates-CandidatePIIData-item-response
Type: object
Show Source
Back to Top