Human Capital Management REST API Developer Reference

The HCM Talent Acquisition Services

The HCM Rest API contains:

  • candidates returns candidates with related education and work experience records based on candidate name, candidate email, or candidate ID, and optionally custom fields of candidate, education, and work experience objects that are passed as parameters in the request URL
  • candidatefeedbacks returns candidate feedback records based on candidate ID, candidate email, candidate feedback record ID, or job application ID, and/or customer fields of Candidate Feedback object that are passed as parameters in the request URL.
  • candidateresumeparser insert candidate records with related education and work experience records fetched from resume
  • jobapplications returns job applications based on job application ID, job application's candidate ID, job application's candidate email, job application's applicant ID, or job application's job opening ID, and optionally custom fields of Job Application object that are passed as parameters in request URL
  • jobquestionsets returns job question sets with related job question records based on job question set name or job question set ID, and optionally custom fields of Job Question Set and Job Question objects that are passed as parameters in request URL
  • jobrequisitions returns job requisition records based on job requisition's title, job requisition's posting date, job requisition's location name, job requisition's job opening ID, or job requisition's ID, and optionally custom fields of Job Requisition object that are passed as parameters in request URLrequest URL
  • newhires inserts new hire records
  • responses returns response records based on response ID, job question ID, or job application ID, and optionally custom fields of response that were passed as parameters in request URL

Service-specific notes:

API Note
candidates When creating or updating a candidate record, you must populate the email address field.
candidateresumeparser
1. When creating or updating a candidate record, you must populate the email address field.
2. In the POST request sample the binary data for the file body is omitted for brevity and replaced with "Binary data goes here". An actual POST request will contain the full binary content.
jobapplications Bulk limit: For the POST and PATCH operations, the limit of records created and updated is 400 on platform. This limit depends on custom triggers on the object.
jobrequisitions Bulk limit: For the POST operation, the limit of records created is 600 on platform. This limit depends on custom triggers on the object.
newhires Bulk limit: For the POST operation, the limit of records created is 40 on platform.

For efficiency, this API does not call the following custom fields:

Object Custom Field Type
Candidate__c Paste_Resume__c Rich Text Area(32768)
  Cover_Letter__c Rich Text Area(32768)
  Resume__c Long Text Area(32768)
  Other_Detail__c Long Text Area(10000)
Candidate_education__c Responsibilities__c Long Text Area(25000)
Note:

You can include Salesforce Notes & Attachments. See Creating Notes and Creating Attachments.

© Copyright 2009–2019 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.