Get all details of recruitingCECandidates
get
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates
Request
Query Parameters
-
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 recruitingCECandidates by a unique ID
Finder Variables- CandidateNumber; string; Finds recruitingCECandidates by a unique ID and the candidate number
- PrimaryKey Finds recruitingCECandidates by a unique ID
-
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:- 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.
-
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : recruitingCECandidates
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidates-item-response
Type:
Show Source
object
-
Action: string
Maximum Length:
255
Action in recruitingCECandidates. -
AddlAddressAttribute1: string
Maximum Length:
255
Additional address attribute 1 in recruitingCECandidates. -
AddlAddressAttribute2: string
Maximum Length:
255
Additional address attribute 2 in recruitingCECandidates. -
AddlAddressAttribute3: string
Maximum Length:
255
Additional address attribute 3 in recruitingCECandidates. -
AddlAddressAttribute4: string
Maximum Length:
255
Additional address attribute 4 in recruitingCECandidates. -
AddlAddressAttribute5: string
Maximum Length:
255
Additional address attribute 5 in recruitingCECandidates. -
AddressLine1: string
Maximum Length:
240
Address Line 1 in recruitingCECandidates. -
AddressLine2: string
Maximum Length:
240
Address Line 2 in recruitingCECandidates. -
AddressLine3: string
Maximum Length:
255
Address Line 3 in recruitingCECandidates. -
AddressLine4: string
Maximum Length:
255
Value of line 4 of the candidate's address. -
attachments: array
Candidate Details with Attachments
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. -
Building: string
Maximum Length:
255
Building in recruitingCECandidates. -
candidateExtraInformation: array
Candidate Details with Extra Information Data
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. -
CandidateLastModifiedDate: string
(date-time)
Read Only:
true
Candidate last modified date. -
CandidateNumber: string
Maximum Length:
240
Candidate Number in recruitingCECandidates. -
CandidatePIIData: array
Candidate Details with PII Data
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. -
City: string
Maximum Length:
60
City in recruitingCECandidates. -
Country: string
Maximum Length:
60
Country in recruitingCECandidates. -
CwkCandidateFlag: boolean
Read Only:
true
Indicates if it's a contingent worker candidate in recruitingCECandidates -
DateOfBirth: string
(date)
Date of birth in recruitingCECandidates
-
DisplayName: string
Maximum Length:
240
Display Name in recruitingCECandidates. -
Email: string
Maximum Length:
240
Email in recruitingCECandidates. -
EmailChangeConfirmed: string
Maximum Length:
255
Email Change Confirmed in recruitingCECandidates. -
EmailChangeRequested: string
Maximum Length:
255
Email Change Requested in recruitingCECandidates. -
EmailPreferredFlag: boolean
Maximum Length:
255
Indicates that the candidate has selected email as the preferred communication channel. -
EmailVerificationRequested: string
Maximum Length:
255
Indicates that the candidate has requested for an email verification. -
EmailVerifiedFlag: boolean
Maximum Length:
255
Indicates that the email ID is verified. -
ExWorkerFlag: boolean
Read Only:
true
Maximum Length:255
Indicates if the candidate is an ex worker in recruitingCECandidates. -
FirstName: string
Maximum Length:
150
First Name in recruitingCECandidates. -
FloorNumber: string
Maximum Length:
255
Floor Number in recruitingCECandidates. -
Honors: string
Maximum Length:
255
Honors in recruitingCECandidates. -
KnownAs: string
Maximum Length:
255
Attribute to represent a candidate's name also KnownAs. -
LastName: string
Maximum Length:
150
Last Name in recruitingCECandidates. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListName: string
Maximum Length:
240
List Name in recruitingCECandidates. -
LongPostalCode: string
Maximum Length:
255
Long Postal Code in recruitingCECandidates. -
MiddleNames: string
Maximum Length:
80
Middle Names in recruitingCECandidates. -
MilitaryRank: string
Maximum Length:
255
Military Rank in recruitingCECandidates. -
MobilePhoneAreaCode: string
Maximum Length:
30
Mobile Phone Area Code in recruitingCECandidates. -
MobilePhoneCountryCode: string
Maximum Length:
30
Mobile Phone Country Code in recruitingCECandidates. -
MobilePhoneLegislationCode: string
Maximum Length:
30
Mobile phone legislation code in recruitingCECandidates. -
MobilePhoneNumber: string
Maximum Length:
60
Mobile Phone Number in recruitingCECandidates. -
NamInformation1: string
NamInformation 1 is a configurable attribute in recruitingCECandidates.
-
NamInformation10: string
NamInformation 10 is a configurable attribute in recruitingCECandidates.
-
NamInformation11: string
NamInformation 11 is a configurable attribute in recruitingCECandidates.
-
NamInformation12: string
NamInformation 12 is a configurable attribute in recruitingCECandidates.
-
NamInformation13: string
NamInformation 13 is a configurable attribute in recruitingCECandidates.
-
NamInformation14: string
NamInformation 14 is a configurable attribute in recruitingCECandidates.
-
NamInformation15: string
NamInformation 15 is a configurable attribute in recruitingCECandidates.
-
NamInformation16: string
NamInformation 16 is a configurable attribute in recruitingCECandidates.
-
NamInformation17: string
NamInformation 17 is a configurable attribute in recruitingCECandidates.
-
NamInformation18: string
NamInformation 18 is a configurable attribute in recruitingCECandidates.
-
NamInformation19: string
NamInformation 19 is a configurable attribute in recruitingCECandidates.
-
NamInformation2: string
NamInformation 2 is a configurable attribute in recruitingCECandidates.
-
NamInformation20: string
NamInformation 20 is a configurable attribute in recruitingCECandidates.
-
NamInformation21: string
NamInformation 21 is a configurable attribute in recruitingCECandidates.
-
NamInformation22: string
NamInformation 22 is a configurable attribute in recruitingCECandidates.
-
NamInformation23: string
NamInformation 23 is a configurable attribute in recruitingCECandidates.
-
NamInformation24: string
NamInformation 24 is a configurable attribute in recruitingCECandidates.
-
NamInformation25: string
NamInformation 25 is a configurable attribute in recruitingCECandidates.
-
NamInformation26: string
NamInformation 26 is a configurable attribute in recruitingCECandidates.
-
NamInformation27: string
NamInformation 27 is a configurable attribute in recruitingCECandidates.
-
NamInformation28: string
NamInformation 28 is a configurable attribute in recruitingCECandidates.
-
NamInformation29: string
NamInformation 29 is a configurable attribute in recruitingCECandidates.
-
NamInformation3: string
NamInformation 3 is a configurable attribute in recruitingCECandidates.
-
NamInformation30: string
NamInformation 30 is a configurable attribute in recruitingCECandidates.
-
NamInformation4: string
NamInformation 4 is a configurable attribute in recruitingCECandidates.
-
NamInformation5: string
NamInformation 5 is a configurable attribute in recruitingCECandidates.
-
NamInformation6: string
NamInformation 6 is a configurable attribute in recruitingCECandidates.
-
NamInformation7: string
NamInformation 7 is a configurable attribute in recruitingCECandidates.
-
NamInformation8: string
NamInformation 8 is a configurable attribute in recruitingCECandidates.
-
NamInformation9: string
NamInformation 9 is a configurable attribute in recruitingCECandidates.
-
NewEmail: string
Maximum Length:
255
New email ID in recruitingCECandidates. -
NewPhone: string
Maximum Length:
255
Phone number specified by the candidate in the event of a change in the existing phone number. -
PhonePreferredFlag: boolean
Maximum Length:
255
Indicates that the candidate has selected phone as the preferred communication channel. -
PhoneVerificationRequested: string
Maximum Length:
255
Indicates that the candidate has requested for a phone verification. -
PhoneVerifiedFlag: boolean
Maximum Length:
255
Indicates that the phone number is verified. -
PostalCode: string
Maximum Length:
30
Postal code in recruitingCECandidates. -
PreferredLanguage: string
Preferred language in recruitingCECandidates.
-
PreferredTimezone: string
Preferred time zone of the external candidate.
-
PreNameAdjunct: string
Maximum Length:
255
Previous name adjunct as entered by the candidate. -
PreviousEmail: string
Maximum Length:
255
Previous email ID in recruitingCECandidates. -
PreviousLastName: string
Maximum Length:
255
Previous last name in recruitingCECandidates. -
PreviousPhone: string
Maximum Length:
255
Previous phone number specified by the candidate before the change in the number. -
Region1: string
Maximum Length:
120
Region 1 in recruitingCECandidates. -
Region2: string
Maximum Length:
120
Region 2 in recruitingCECandidates. -
Region3: string
Maximum Length:
120
Region 3 in recruitingCECandidates. -
SiteNumber: string
Maximum Length:
255
Site Number in recruitingCECandidates. -
Suffix: string
Maximum Length:
80
Suffix in recruitingCECandidates. -
Title: string
Maximum Length:
30
Title in recruitingCECandidates.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidates-attachments-item-response
Type:
Show Source
object
-
Attachment: string
Attachment in the recruitingCECandidates attachments.
-
Category: string
Maximum Length:
30
Category in recruitingCECandidates attachments. -
Description: string
Maximum Length:
255
Description in recruitingCECandidates attachments. -
FileContents: string
File Contents in recruitingCECandidates attachments.
-
Id: string
Maximum Length:
255
ID assigned to the recruitingCECandidates attachments. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MimeType: string
Mime type in the recruitingCECandidates attachments.
-
SourceAttachmentId: integer
ID assigned to the source attachment in the recruitingCECandidates attachments.
-
Title: string
Maximum Length:
80
Title of the attachment. -
Type: string
Type of recruitingCECandidates attachments.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : recruitingCECandidates-candidateExtraInformation-item-response
Type:
Show Source
object
-
CandidateNumber: string
Maximum Length:
255
Unique identifier for the candidate. -
ContextLink: string
Maximum Length:
2000
Name of the extra information context. -
ContextName: string
Maximum Length:
255
Unique identifier for the extra information data of the candidate. -
DataId: integer
Unique identifier for the person.
-
dataRows: array
Candidate Details with Extra Information Rows
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidates-candidateExtraInformation-dataRows-item-response
Type:
Show Source
object
-
attributes: array
Candidate Details with Extra Information Attributes
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. -
ContextRowId: string
Maximum Length:
255
Name of the context corresponding to the extra information rows. -
ContextRowLink: string
Maximum Length:
3000
Unique identifier for the extra information context row. -
DataId: integer
Unique link corresponding to the extra information context row.
-
DataRowId: integer
Unique identifier for the extra information data row.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RowAction: string
Maximum Length:
255
Unique identifier for extra information row attribute.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidates-candidateExtraInformation-dataRows-attributes-item-response
Type:
Show Source
object
-
AttributeId: integer
Unique identifier for extra information row context corresponding to the attributes.
-
DataRowId: integer
Unique identifier for extra information row data corresponding to the attributes.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Maximum Length:
255
Name of the candidate extra information row attribute. -
Value: string
Maximum Length:
255
Value of the candidate extra information row attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidates-CandidatePIIData-item-response
Type:
Show Source
object
-
ExpirationDate: string
(date)
Expiration date in the recruiting candidate PII data.
-
Id: string
ID for Candidate PII data
-
IssueDate: string
(date)
Date of issue in the recruiting candidate PII data.
-
LegislationCode: string
Legislation code in the recruiting candidate PII data.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NationalIdentifierNumber: string
National identifier number in the recruiting candidate PII data.
-
NationalIdentifierType: string
National identifier type in the recruiting candidate PII data.
-
PlaceOfIssue: string
Place of issue in the recruiting candidate PII data.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source