1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Recruiting Candidates

Get all candidates

get

/hcmRestApi/resources/11.13.18.05/recruitingCandidates

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 all candidates using a unique ID.
      Finder Variables
      • CandidateNumber; string; Unique ID and candidate number used to find candidates.
    • findByPersonId Finds all candidates using a person ID.
      Finder Variables
      • personId; string; Person ID used to find candidates.
    • search Finds all candidates using search.
      Finder Variables
      • keywords; string; Search and keywords; string; used to find candidates.
  • 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:
    • CandLastModifiedDate; string; Candidate last modified date.
    • CandidateType; string; Candidate type in recruiting candidates.
    • FullName; string; Full name in recruiting candidates.
    • LastName; string; Last name in recruiting candidates.
    • PreferredTimezone; string; Preferred time zone of the candidate.
  • 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 : recruitingCandidates
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : recruitingCandidates-item-response
Type: object
Show Source
Nested Schema : Attachments of the Candidates
Type: array
Title: Attachments of the Candidates
The attachments resource is a child of the recruitingCandidates resource and provides details about attachments provided by the candidate.
Show Source
Nested Schema : Address of the Recruiting Candidates
Type: array
Title: Address of the Recruiting Candidates
The candidateAddress resource is a child of the recruitingCandidates resource and provides details about the address of the candidate.
Show Source
Nested Schema : Phone of the Recruiting Candidates
Type: array
Title: Phone of the Recruiting Candidates
The candidatePhones resource is a child of the recruitingCandidates resource and provides details about the phone numbers of the candidate.
Show Source
Nested Schema : Citizenships of Candidates
Type: array
Title: Citizenships of Candidates
The citizenships resource is a child of the recruitingCandidates resource and provides details about the citizenship of the candidate.
Show Source
Nested Schema : Education of the Recruiting Candidates
Type: array
Title: Education of the Recruiting Candidates
The education resource is a child of the recruitingCandidates resource and provides details about the education of the candidate.
Show Source
Nested Schema : Experience of the Recruiting Candidates
Type: array
Title: Experience of the Recruiting Candidates
The experience resource is a child of the recruitingCandidates resource and provides details about the work experience of the candidate.
Show Source
Nested Schema : Languages of the Recruiting Candidates
Type: array
Title: Languages of the Recruiting Candidates
The languages resource is a child of the recruitingCandidates resource and provides details about the languages of the candidate.
Show Source
Nested Schema : Licenses and Certifications of the Recruiting Candidates
Type: array
Title: Licenses and Certifications of the Recruiting Candidates
The licensesAndCertificates resource is a child of the recruitingCandidates resource and provides details about the licenses and certificates of the candidate.
Show Source
Nested Schema : Skills of the Recruiting Candidates
Type: array
Title: Skills of the Recruiting Candidates
The skills resource is a child of the recruitingCandidates resource and provides details about the skills of the candidate.
Show Source
Nested Schema : Work Preferences of the Recruiting Candidates
Type: array
Title: Work Preferences of the Recruiting Candidates
The workPreferences resource is a child of the recruitingCandidates resource and provides details about the work preferences of the candidate.
Show Source
Nested Schema : recruitingCandidates-attachments-item-response
Type: object
Show Source
Nested Schema : recruitingCandidates-candidateAddress-item-response
Type: object
Show Source
Nested Schema : recruitingCandidates-candidatePhones-item-response
Type: object
Show Source
Nested Schema : recruitingCandidates-citizenships-item-response
Type: object
Show Source
Nested Schema : recruitingCandidates-education-item-response
Type: object
Show Source
Nested Schema : recruitingCandidates-experience-item-response
Type: object
Show Source
Nested Schema : recruitingCandidates-languages-item-response
Type: object
Show Source
Nested Schema : recruitingCandidates-licensesAndCertificates-item-response
Type: object
Show Source
Nested Schema : recruitingCandidates-skills-item-response
Type: object
Show Source
Nested Schema : recruitingCandidates-workPreferences-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all candidates by submitting a collection GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -X GET http://host:port/hcmCoreApi/resources/11.13.18.05/recruitingCandidates?q=LastName=Hopkins

Example of Response Header

The following is an example of the response header.

HTTP/1.1 200 OK
Content-Type : application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "items": [
        {
            "CandidateNumber": "2647",
            "PreferredLanguage": null,
            "LastName": "Hopkins",
            "MiddleNames": null,
            "FirstName": "Jack",
            "Title": "MR.",
            "Suffix": null,
            "PreNameAdjunct": null,
            "KnownAs": null,
            "PreviousLastName": null,
            "Honors": null,
            "MilitaryRank": null,
            "FullName": "Hopkins, Jack",
            "DisplayName": "Jack Hopkins",
            "ListName": "Hopkins, Jack",
            "Email": null,
            "CampaignOptIn": null,
            "SourceMedium": null,
            "SourceName": null,
            "CandidateType": "ORA_INTERNAL_CANDIDATE",
            "PersonId": 11143,
            "CreatedBy": “JH-HOPKINS”,
    	    "CreationDate": "2019-03-21T19:08:31.003+00:00",
    	    "LastUpdatedBy": "JH-HOPKINS",
    	    "LastUpdateDate": "2019-03-21T19:08:31.334+00:00",
            "links": [
                {...}
            ]
        },
        {
            "CandidateNumber": "28104",
            "PreferredLanguage": null,
            "LastName": "Hopkins",
            "MiddleNames": null,
            "FirstName": "Montana",
            "Title": "MR.",
            "Suffix": null,
            "PreNameAdjunct": null,
            "KnownAs": null,
            "PreviousLastName": null,
            "Honors": null,
            "MilitaryRank": null,
            "FullName": "Montana Hopkins",
            "DisplayName": "Montana Hopkins",
            "ListName": "Hopkins,Montana",
            "Email": "montana.hopkins@oracle.com",
            "CampaignOptIn": null,
            "SourceMedium": null,
            "SourceName": null,
            "CandidateType": "ORA_INTERNAL_CANDIDATE",
            "PersonId": 100010026262572,
            "CreatedBy": “JH-HOPKINS”,
    	    "CreationDate": "2019-03-21T19:08:31.003+00:00",
    	    "LastUpdatedBy": "JH-HOPKINS",
    	    "LastUpdateDate": "2019-03-21T19:08:31.334+00:00",
            "links": [
                {...}
            ]
        }
    ],
    "links": [
        {...}
    ]
}
Back to Top