Get all the candidate resumes in a collection
get
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports
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 a candidate by the ID
Finder Variables- ProfileId; string; Finds a candidate by the ID and the profile ID
- findByProfileType Finds a candidate by the profile type
Finder Variables- bAttachmentId; string; Finds a candidate by the profile type and the attachment ID
- bFlowVersionId; integer; Finds a candidate by the profile type and the flow version ID
- bMockParam; string; Finds a candidate by the profile type and the mock parameter
- bProfileType; string; Finds a candidate by the profile type and the profile type ID
- PrimaryKey Finds a candidate by the 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:- AddressLine1; string; First address line in the candidate resume.
- AddressLine2; string; Second address line in the candidate resume.
- AttachmentId; string; Attachment ID of the candidate resume.
- AttachmentTrackerId; string; Attachment tracker identifier of the candidate resume.
- Citizenship; string; Citizenship information in the candidate resume.
- City; string; City in the candidate resume.
- Country; string; Country in the candidate resume.
- DisplayName; string; Display name in the candidate resume.
- Email; string; Email ID in the candidate resume.
- FileContents; string; File content in the candidate resume.
- FileTitle; string; File title in the candidate resume.
- FirstName; string; First name in the candidate resume.
- FlowVersionId; integer; Flow version ID of the candidate resume.
- LastName; string; Last name in the candidate resume.
- MiddleNames; string; Middle name in the candidate resume.
- MilitaryRank; string; Military rank in the candidate resume.
- MobilePhoneAreaCode; string; Mobile phone number area code in the candidate resume.
- MobilePhoneCountryCode; string; Mobile phone number country code in the candidate resume.
- MobilePhoneNumber; string; Mobile phone number in the candidate resume.
- MockParam; string; Mock parameter in the candidate resume
- PostalCode; string; Postal code of the candidate address in the candidate resume.
- PreNameAdjunct; string; Previous name adjunct in the candidate resume.
- ProfileId; string; Profile ID of the candidate resume.
- ProfileType; string; Profile type of the candidate resume.
- ProviderKey; string; Provider token of the candidate resume.
- ProviderToken; string; Provider token of the candidate resume.
- Region1; string; Region 1 in the candidate resume.
- Region2; string; Region 2 in the candidate resume.
- Region3; string; Region 3 in the candidate resume.
- StatusCode; integer; Status code returned to the partner.
- Suffix; string; Suffix in the candidate resume.
- Title; string; Title of the candidate resume.
-
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: string
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: string
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 : recruitingCECandidateProfileImports
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:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidateProfileImports-item-response
Type:
Show Source
object-
AddressLine1: string
Read Only:
trueFirst address line in the candidate resume. -
AddressLine2: string
Read Only:
trueSecond address line in the candidate resume. -
AttachmentId: string
Maximum Length:
255Attachment ID of the candidate resume. -
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is a child of recruitingCECandidateResumeParsers. It includes the details of all attachments added by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use. -
AttachmentTrackerId: string
Maximum Length:
255Attachment tracker identifier of the candidate resume. -
Citizenship: string
Read Only:
trueMaximum Length:255Citizenship information in the candidate resume. -
City: string
Read Only:
trueCity in the candidate resume. -
Country: string
Read Only:
trueCountry in the candidate resume. -
DisplayName: string
Read Only:
trueDisplay name in the candidate resume. -
educations: array
Educations
Title:
EducationsThe educations resource is a child of recruitingCECandidateResumeParsers. It includes details of the educational qualifications of the candidate. Note that the service endpoints in this resource category are only for Oracle internal use. -
Email: string
Read Only:
trueEmail ID in the candidate resume. -
FileContents: string
File content in the candidate resume.
-
FileTitle: string
File title in the candidate resume.
-
FirstName: string
Read Only:
trueFirst name in the candidate resume. -
FlowVersionId: integer
Flow version ID of the candidate resume.
-
languages: array
Languages
Title:
LanguagesThe languages resource is a child of recruitingCECandidateResumeParsers. It includes details of the languages known to the candidate. Note that the service endpoints in this resource category are only for Oracle internal use. -
LastName: string
Read Only:
trueLast name in the candidate resume. -
licensesAndCertifications: array
Licenses and Certifications
Title:
Licenses and CertificationsThe licensesAndcertifications resource is a child of recruitingCECandidateResumeParsers. It includes the details of all the licenses and certifications obtained by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MiddleNames: string
Read Only:
trueMiddle name in the candidate resume. -
MilitaryRank: string
Read Only:
trueMilitary rank in the candidate resume. -
MobilePhoneAreaCode: string
Read Only:
trueMobile phone number area code in the candidate resume. -
MobilePhoneCountryCode: string
Read Only:
trueMobile phone number country code in the candidate resume. -
MobilePhoneNumber: string
Read Only:
trueMobile phone number in the candidate resume. -
MockParam: string
Read Only:
trueMock parameter in the candidate resume -
PostalCode: string
Read Only:
truePostal code of the candidate address in the candidate resume. -
PreNameAdjunct: string
Read Only:
truePrevious name adjunct in the candidate resume. -
ProfileId: string
Profile ID of the candidate resume.
-
ProfileType: string
Profile type of the candidate resume.
-
ProviderKey: string
Provider token of the candidate resume.
-
ProviderToken: string
Read Only:
trueProvider token of the candidate resume. -
Region1: string
Read Only:
trueRegion 1 in the candidate resume. -
Region2: string
Read Only:
trueRegion 2 in the candidate resume. -
Region3: string
Read Only:
trueRegion 3 in the candidate resume. -
skills: array
Skills
Title:
SkillsThe skills resource is a child of recruitingCECandidateResumeParsers. It includes the details of all the skills obtained by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use. -
StatusCode: integer
Status code returned to the partner.
-
Suffix: string
Read Only:
trueSuffix in the candidate resume. -
Title: string
Read Only:
trueTitle of the candidate resume. -
workExperiences: array
Work Experiences
Title:
Work ExperiencesThe workExperiences resource is a child of recruitingCECandidateResumeParsers. It includes the details of all the work experiences of the candidate. Note that the service endpoints in this resource category are only for Oracle internal use. -
workPreferences: array
Work Preferences
Title:
Work PreferencesThe workPreferences resource is a child of recruitingCECandidateResumeParsers. It includes the details of the work preferences of the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is a child of recruitingCECandidateResumeParsers. It includes the details of all attachments added by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Educations
Type:
arrayTitle:
EducationsThe educations resource is a child of recruitingCECandidateResumeParsers. It includes details of the educational qualifications of the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Languages
Type:
arrayTitle:
LanguagesThe languages resource is a child of recruitingCECandidateResumeParsers. It includes details of the languages known to the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Licenses and Certifications
Type:
arrayTitle:
Licenses and CertificationsThe licensesAndcertifications resource is a child of recruitingCECandidateResumeParsers. It includes the details of all the licenses and certifications obtained by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Skills
Type:
arrayTitle:
SkillsThe skills resource is a child of recruitingCECandidateResumeParsers. It includes the details of all the skills obtained by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Work Experiences
Type:
arrayTitle:
Work ExperiencesThe workExperiences resource is a child of recruitingCECandidateResumeParsers. It includes the details of all the work experiences of the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Work Preferences
Type:
arrayTitle:
Work PreferencesThe workPreferences resource is a child of recruitingCECandidateResumeParsers. It includes the details of the work preferences of the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCECandidateProfileImports-attachments-item-response
Type:
Show Source
object-
Attachment: string
Read Only:
trueAttachment in the candidate resume. -
AttachmentData: string
Attachment data in the candidate resume.
-
Category: string
Read Only:
trueCategory of the attachment in the candidate resume. -
Description: string
Read Only:
trueDescription of the attachment in the candidate resume. -
FileContents: string
Read Only:
trueFile Contents of the attachment in the candidate resume. -
Id: integer
Unique ID of the attachment in the candidate resume.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProfileId: string
Read Only:
trueProfile ID of the attachment in the candidate resume. -
Title: string
Read Only:
trueTitle of the attachment in the candidate resume. -
Type: string
Read Only:
trueType of attachment in the candidate resume.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : recruitingCECandidateProfileImports-educations-item-response
Type:
Show Source
object-
ContentItemId: string
Read Only:
trueContent item ID of the education in the candidate resume. -
ContentTypeId: integer
Read Only:
trueContent type ID of the education in the candidate resume. -
CountryCode: string
Read Only:
trueCountry code for education in the candidate resume. -
DegreeName: string
Read Only:
trueDegree name for education in the candidate resume. -
EducationalEstablishment: string
Read Only:
trueName of the education establishment in the candidate resume. -
EducationalEstablishmentId: string
Read Only:
trueEducation establishment ID in the candidate resume. -
EducationData: string
Education data in the candidate resume.
-
EndDate: string
Read Only:
trueEnd date for the completion of education in the candidate resume. -
GraduatedFlag: boolean
Read Only:
trueIndicates that the candidate is a graduate. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Major: string
Read Only:
trueEducation major in the candidate resume. -
ProfileId: string
Read Only:
trueProfile ID for education in the candidate resume. -
ProfileItemId: integer
Profile item ID for education in the candidate resume.
-
StartDate: string
Read Only:
trueStart date for education in the candidate resume. -
StateProvinceCode: string
Read Only:
trueState province code of the educational establishment in the candidate resume.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidateProfileImports-languages-item-response
Type:
Show Source
object-
AbleToTeachFlag: boolean
Read Only:
trueIndicates that the candidate can teach the language. -
AbleToTranslateFlag: boolean
Read Only:
trueIndicates that the candidate can translate the language. -
ContentItemId: string
Read Only:
trueContent item ID of the languages in the candidate resume. -
ContentTypeId: integer
Content type ID of the languages in the candidate resume.
-
language: string
Read Only:
trueLanguage in the candidate resume. -
LanguageData: string
Language data in the candidate resume.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NativeSpeakerFlag: boolean
Read Only:
trueIndicates that it's the native language of the candidate. -
ProfileId: string
Read Only:
trueProfile ID for languages in the candidate resume. -
ProfileItemId: integer
Profile item ID for languages in the candidate resume.
-
ReadingLevelId: integer
Read Only:
trueID assigned to the language reading proficiency. -
SpeakingLevelId: integer
Read Only:
trueID assigned to the language speaking proficiency. -
WritingLevelId: integer
Read Only:
trueID assigned to the language writing proficiency.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidateProfileImports-licensesAndCertifications-item-response
Type:
Show Source
object-
CertificationNumber: string
Read Only:
trueCertification number for the licenses and certifications in the candidate resume. -
Comments: string
Read Only:
trueComments on the licenses and certifications in the candidate resume. -
ContentTypeId: integer
Read Only:
trueContent type ID of the certifications in the candidate resume. -
ExpirationDate: string
Read Only:
trueExpiration date of the licenses in the candidate resume. -
IssueDate: string
Read Only:
trueIssue date of the licenses and certifications in the candidate resume. -
IssuedBy: string
Read Only:
trueAuthority that has issued the licenses and certifications in the candidate resume. -
LicenceAndCertificationData: string
License and certification data in the candidate resume.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProfileId: string
Read Only:
trueProfile ID of the licenses and certifications in the candidate resume. -
ProfileItemId: integer
Profile item ID for licenses and certifications in the candidate resume.
-
Title: string
Read Only:
trueTitle of the licenses and certifications in the candidate resume.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidateProfileImports-skills-item-response
Type:
Show Source
object-
Comments: string
Read Only:
trueComments on the skills in the candidate resume. -
ContentTypeId: integer
Read Only:
trueContent type ID of the skills in the candidate resume. -
DateAchieved: string
(date)
Read Only:
trueAchieved date of the skills in the candidate resume. -
Description: string
Read Only:
trueDescription of the skills in the candidate resume. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProfileId: string
Read Only:
trueProfile ID for skills in the candidate resume. -
ProfileItemId: integer
Profile item ID for skills in the candidate resume.
-
ProjectName: string
Read Only:
trueProject name of the skills in the candidate resume -
SkillData: string
Skill data in the candidate resume
-
Skills: string
Read Only:
trueName of the skills in the candidate resume. -
Speciality: string
Read Only:
trueSpeciality of the skills in the candidate resume. -
YearsOfExperience: integer
Read Only:
trueYears of experience of the skills in the candidate resume.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidateProfileImports-workExperiences-item-response
Type:
Show Source
object-
Achievements: string
Read Only:
trueAchievements in the work experience in the candidate resume. -
BusinessType: string
Read Only:
trueBusiness type of the work experiences of the candidate resume. -
ContentTypeId: integer
Read Only:
trueContent type ID for the work experiences in the candidate resume. -
CurrentJobFlag: boolean
Read Only:
trueIndicates that it's the current job of the candidate as per their work experiences. -
EmployerName: string
Read Only:
trueEmployer name of the work experiences in the candidate resume. -
EndDate: string
Read Only:
trueEnd date of the work experiences in the candidate resume. -
JobTitle: string
Read Only:
trueJob title for the work experiences in the candidate resume. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProfileId: string
Read Only:
trueProfile ID for the work experiences in the candidate resume. -
ProfileItemId: integer
Profile item ID for the work experiences in the candidate resume.
-
StartDate: string
Read Only:
trueStart date of the work experience mentioned in the candidate resume. -
WorkExperienceData: string
Work experience data in the candidate resume
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidateProfileImports-workPreferences-item-response
Type:
Show Source
object-
ContentTypeId: integer
Content type ID for the work preferences in the candidate resume.
-
CurrencyCode: string
Read Only:
trueCurrency code for the work preferences in the candidate resume. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MinimumPay: string
Read Only:
trueMinimum pay for the work preferences in the candidate resume. -
NatTravelFlag: boolean
Read Only:
trueIndicates that the candidate is ready for domestic travel as per their work preferences. -
NatTravelFrequenc: string
Read Only:
trueNat travel frequency for work preferences in the candidate resume. -
PartAssignFlag: boolean
Read Only:
trueIndicates that the candidate has opted for part payment as per their work preferences. -
PayFrequency: string
Read Only:
truePay frequency for the work preferences in the candidate resume. -
ProfileId: string
Read Only:
trueProfile ID for the work preferences in the candidate resume. -
ProfileItemId: integer
Profile item ID for the work preferences in the candidate resume.
-
RelocateFlag: boolean
Read Only:
trueIndicates the candidate is ready to relocate as per their work preferences. -
TempAssignFlag: boolean
Read Only:
trueIndicates a temporary assignment for the candidate as per their work preferences. -
WorkPreferenceData: string
Work preference data in the candidate resume.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- getRPConfiguration
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/action/getRPConfigurationGets a resume parser configuration.