Get all the candidate resumes in a collection

get

/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers

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 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
  • 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:
    • 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.
  • 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 : recruitingCECandidateResumeParsers
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : recruitingCECandidateResumeParsers-item-response
Type: object
Show Source
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 : 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: object
Show Source
Nested Schema : recruitingCECandidateResumeParsers-educations-item-response
Type: object
Show Source
Nested Schema : recruitingCECandidateResumeParsers-languages-item-response
Type: object
Show Source
Nested Schema : recruitingCECandidateResumeParsers-licensesAndCertifications-item-response
Type: object
Show Source
Nested Schema : recruitingCECandidateResumeParsers-skills-item-response
Type: object
Show Source
Nested Schema : recruitingCECandidateResumeParsers-workExperiences-item-response
Type: object
Show Source
Nested Schema : recruitingCECandidateResumeParsers-workPreferences-item-response
Type: object
Show Source
Back to Top