Get all the candidate resumes in a collection
get
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers
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.
- 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:
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 : recruitingCECandidateResumeParsers
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 : recruitingCECandidateResumeParsers-item-response
Type:
Show Source
object
-
AddressLine1: string
Read Only:
true
First address line in the candidate resume. -
AddressLine2: string
Read Only:
true
Second address line in the candidate resume. -
AttachmentId: string
Read Only:
true
Maximum Length:255
Attachment ID of the candidate resume. -
attachments: array
Attachments
Title:
Attachments
The 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. -
City: string
Read Only:
true
City in the candidate resume. -
Country: string
Read Only:
true
Country in the candidate resume. -
DisplayName: string
Read Only:
true
Display name in the candidate resume. -
educations: array
Educations
Title:
Educations
The 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:
true
Email 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:
true
First name in the candidate resume. -
FlowVersionId: integer
Flow version ID of the candidate resume.
-
languages: array
Languages
Title:
Languages
The 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:
true
Last name in the candidate resume. -
licensesAndCertifications: array
Licenses and Certifications
Title:
Licenses and Certifications
The 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:
Links
The link relations associated with the resource instance. -
MiddleNames: string
Read Only:
true
Middle name in the candidate resume. -
MilitaryRank: string
Read Only:
true
Military rank in the candidate resume. -
MobilePhoneAreaCode: string
Read Only:
true
Mobile phone number area code in the candidate resume. -
MobilePhoneCountryCode: string
Read Only:
true
Mobile phone number country code in the candidate resume. -
MobilePhoneNumber: string
Read Only:
true
Mobile phone number in the candidate resume. -
MockParam: string
Read Only:
true
Mock parameter in the candidate resume -
PostalCode: string
Read Only:
true
Postal code of the candidate address in the candidate resume. -
PreNameAdjunct: string
Read Only:
true
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
Read Only:
true
Provider token of the candidate resume. -
Region1: string
Read Only:
true
Region 1 in the candidate resume. -
Region2: string
Read Only:
true
Region 2 in the candidate resume. -
Region3: string
Read Only:
true
Region 3 in the candidate resume. -
skills: array
Skills
Title:
Skills
The 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:
true
Suffix in the candidate resume. -
Title: string
Read Only:
true
Title of the candidate resume. -
workExperiences: array
Work Experiences
Title:
Work Experiences
The 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 Preferences
The 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:
array
Title:
Attachments
The 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:
array
Title:
Educations
The 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:
array
Title:
Languages
The 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:
array
Title:
Licenses and Certifications
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Skills
Type:
array
Title:
Skills
The 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:
array
Title:
Work Experiences
The 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:
array
Title:
Work Preferences
The 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 : recruitingCECandidateResumeParsers-attachments-item-response
Type:
Show Source
object
-
Attachment: string
Read Only:
true
Attachment in the candidate resume. -
AttachmentData: string
Attachment data in the candidate resume.
-
Category: string
Read Only:
true
Category of the attachment in the candidate resume. -
Description: string
Read Only:
true
Description of the attachment in the candidate resume. -
FileContents: string
Read Only:
true
File Contents of the attachment in the candidate resume. -
Id: integer
Unique ID of the attachment in the candidate resume.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProfileId: string
Read Only:
true
Profile ID of the attachment in the candidate resume. -
Title: string
Read Only:
true
Title of the attachment in the candidate resume. -
Type: string
Read Only:
true
Type of attachment in the candidate resume.
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 : recruitingCECandidateResumeParsers-educations-item-response
Type:
Show Source
object
-
ContentItemId: string
Read Only:
true
Content item ID of the education in the candidate resume. -
ContentTypeId: integer
Read Only:
true
Content type ID of the education in the candidate resume. -
CountryCode: string
Read Only:
true
Country code for education in the candidate resume. -
DegreeName: string
Read Only:
true
Degree name for education in the candidate resume. -
EducationalEstablishment: string
Read Only:
true
Name of the education establishment in the candidate resume. -
EducationalEstablishmentId: string
Read Only:
true
Education establishment ID in the candidate resume. -
EducationData: string
Education data in the candidate resume.
-
EndDate: string
Read Only:
true
End date for the completion of education in the candidate resume. -
GraduatedFlag: boolean
Read Only:
true
Indicates that the candidate is a graduate. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Major: string
Read Only:
true
Education major in the candidate resume. -
ProfileId: string
Read Only:
true
Profile ID for education in the candidate resume. -
ProfileItemId: integer
Profile item ID for education in the candidate resume.
-
StartDate: string
Read Only:
true
Start date for education in the candidate resume. -
StateProvinceCode: string
Read Only:
true
State province code of the educational establishment in the candidate resume.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidateResumeParsers-languages-item-response
Type:
Show Source
object
-
AbleToTeachFlag: boolean
Read Only:
true
Indicates that the candidate can teach the language. -
AbleToTranslateFlag: boolean
Read Only:
true
Indicates that the candidate can translate the language. -
ContentItemId: string
Read Only:
true
Content 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:
true
Language in the candidate resume. -
LanguageData: string
Language data in the candidate resume.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NativeSpeakerFlag: boolean
Read Only:
true
Indicates that it's the native language of the candidate. -
ProfileId: string
Read Only:
true
Profile ID for languages in the candidate resume. -
ProfileItemId: integer
Profile item ID for languages in the candidate resume.
-
ReadingLevelId: integer
Read Only:
true
ID assigned to the language reading proficiency. -
SpeakingLevelId: integer
Read Only:
true
ID assigned to the language speaking proficiency. -
WritingLevelId: integer
Read Only:
true
ID assigned to the language writing proficiency.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidateResumeParsers-licensesAndCertifications-item-response
Type:
Show Source
object
-
CertificationNumber: string
Read Only:
true
Certification number for the licenses and certifications in the candidate resume. -
Comments: string
Read Only:
true
Comments on the licenses and certifications in the candidate resume. -
ContentTypeId: integer
Read Only:
true
Content type ID of the certifications in the candidate resume. -
ExpirationDate: string
Read Only:
true
Expiration date of the licenses in the candidate resume. -
IssueDate: string
Read Only:
true
Issue date of the licenses and certifications in the candidate resume. -
IssuedBy: string
Read Only:
true
Authority 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:
Links
The link relations associated with the resource instance. -
ProfileId: string
Read Only:
true
Profile 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:
true
Title of the licenses and certifications in the candidate resume.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidateResumeParsers-skills-item-response
Type:
Show Source
object
-
Comments: string
Read Only:
true
Comments on the skills in the candidate resume. -
ContentTypeId: integer
Read Only:
true
Content type ID of the skills in the candidate resume. -
DateAchieved: string
(date)
Read Only:
true
Achieved date of the skills in the candidate resume. -
Description: string
Read Only:
true
Description of the skills in the candidate resume. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProfileId: string
Read Only:
true
Profile ID for skills in the candidate resume. -
ProfileItemId: integer
Profile item ID for skills in the candidate resume.
-
ProjectName: string
Read Only:
true
Project name of the skills in the candidate resume -
SkillData: string
Skill data in the candidate resume
-
Skills: string
Read Only:
true
Name of the skills in the candidate resume. -
Speciality: string
Read Only:
true
Speciality of the skills in the candidate resume. -
YearsOfExperience: integer
Read Only:
true
Years of experience of the skills in the candidate resume.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidateResumeParsers-workExperiences-item-response
Type:
Show Source
object
-
Achievements: string
Read Only:
true
Achievements in the work experience in the candidate resume. -
BusinessType: string
Read Only:
true
Business type of the work experiences of the candidate resume. -
ContentTypeId: integer
Read Only:
true
Content type ID for the work experiences in the candidate resume. -
CurrentJobFlag: boolean
Read Only:
true
Indicates that it's the current job of the candidate as per their work experiences. -
EmployerName: string
Read Only:
true
Employer name of the work experiences in the candidate resume. -
EndDate: string
Read Only:
true
End date of the work experiences in the candidate resume. -
JobTitle: string
Read Only:
true
Job title for the work experiences in the candidate resume. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProfileId: string
Read Only:
true
Profile 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:
true
Start date of the work experience mentioned in the candidate resume. -
WorkExperienceData: string
Work experience data in the candidate resume
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidateResumeParsers-workPreferences-item-response
Type:
Show Source
object
-
ContentTypeId: integer
Content type ID for the work preferences in the candidate resume.
-
CurrencyCode: string
Read Only:
true
Currency code for the work preferences in the candidate resume. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinimumPay: string
Read Only:
true
Minimum pay for the work preferences in the candidate resume. -
NatTravelFlag: boolean
Read Only:
true
Indicates that the candidate is ready for domestic travel as per their work preferences. -
NatTravelFrequenc: string
Read Only:
true
Nat travel frequency for work preferences in the candidate resume. -
PartAssignFlag: boolean
Read Only:
true
Indicates that the candidate has opted for part payment as per their work preferences. -
PayFrequency: string
Read Only:
true
Pay frequency for the work preferences in the candidate resume. -
ProfileId: string
Read Only:
true
Profile 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:
true
Indicates the candidate is ready to relocate as per their work preferences. -
TempAssignFlag: boolean
Read Only:
true
Indicates a temporary assignment for the candidate as per their work preferences. -
WorkPreferenceData: string
Work preference data in the candidate resume.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source