Human Capital Management REST API Developer Reference

jobrequisitions

Represents a JobRequisition REST API structure

GET

URI /services/apexrest/v1.0/jobrequisitions/*
Description 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 URL.

Input Parameters

ids Comma-separated Salesforce record IDs of job requisitions
titles Comma-separated title of job requisitions
postingdates Comma-separated posting date of job requisitions
locationnames Comma-separated location name of job requisitions
jobopeningid Comma-separated job opening ID of job requisitions
customfields Comma-separated custom field names of Job Requisition object

Sample Code


// GET Response
[{
   "ZipPostalCode": "5674732",
   "TargetStartDate": "2016-12-12",
   "SummaryDescription": "Job_Posting_Summary",
   "StateProvince": "NewState",
   "SelfIdentificationText": "IdentificationSummary",
   "ScheduledHours": 8,
   "SalaryTo": 50000,
   "SalaryFrom": 35000,
   "SalaryFrequency": "week",
   "RequestWorkHistory": true,
   "RequestSelfIdentification": true,
   "RequestEducationHistory": true,
   "RegularTemporary": "Regular",
   "Region": "a3K15000000MjDCEA0",
   "RecruiterEmail": null,
   "Recruiter": "a4G15000000PiPGEA0",
   "QuestionsOrder": "1,2,3,4",
   "QuestionSet": "a2K15000001xTkHEAU",
   "PostInternally": true,
   "PostingURL": "https://postUrl/jobOpening1",
   "PostingDate": "2016-11-02",
   "PostingAge": "0 year(s)  -6 month(s) -191 day(s)",
   "PostExternally": true,
   "PositionTitle": "New Position",
   "PositionFTE": 3,
   "Position": "a3B15000000MIefEAG",
   "OwnerId": "00515000006AFf4AAG",
   "NumberofOpenings": 5,
   "NumberofCandidates": 0,
   "Name": "JobOpening 1",
   "LocationName": "New York City",
   "Location": "a2W150000007KDjEAM",
   "LastModifiedDate": "2016-04-25T12:11:41.000Z",
   "LastModifiedById": "00515000006AFf4AAG",
   "JobType": "Permanent",
   "JobOpeningURL": "Job_Detail?Id=a2J15000000p6Gq",
   "JobOpeningStatus": "Submitted",
   "JobOpeningID": "00096",
   "JobFunction": "a2I15000000pfcJEAQ",
   "JobBoardDescription": "Job_Board_Posting_Description",
   "Job": "a2N15000001hVqKEAU",
   "InterviewerEmail": null,
   "Interviewer": "a4G15000000PiPGEA0",
   "InternalPositionDescription": "Internal_Position_Description",
   "Industry": "Accountancy",
   "IncludeSharingButtons": true,
   "IncludeQuestions": true,
   "IncludeJobSummary": true,
   "IncludeDisclaimer": true,
   "IncludeCoverLetter": true,
   "IncludeAttachments": true,
   "IncludeApplywithLinkedIn": true,
   "Id": "a2J15000000p6GqEAI",
   "HiringTeamEmail2": null,
   "HiringTeamEmail1": null,
   "HiringTeam2": "a4G15000000PiPGEA0",
   "HiringTeam1": "a4G15000000PiPGEA0",
   "HiringRequest": "New",
   "HiringManagerEmail": null,
   "HiringManager": "a4G15000000PiPGEA0",
   "FullPartTimeJob": "Full Time",
   "ExternalPositionDescription": "External_Position_Description",
   "ExpenseTotal": 0,
   "EEOJobCategory": "Mid Officials",
   "DivisionName": "Delivery Management",
   "Division": "a1s15000003JokCAAS",
   "DepartmentName": "IT",
   "Department": "a1m150000037JzEAAU",
   "CustomFields": [],
   "CurrencyCode": "CAD",
   "CreatedDate": "2016-04-25T12:11:41.000Z",
   "CreatedById": "00515000006AFf4AAG",
   "CountryCode": null,
   "Country": null,
   "CostCenter": "a1b15000006ZLt8AAG",
   "CityTown": "NewYork",
   "BonusPercent": 23,
   "BonusEligible": "Yes",
   "BonusAmount": 20000,
   "AttachResume": true,
   "ApplicationDisclaimer": "Application_Disclaimer",
   "Agencies": "UK"
}]

POST

URI /services/apexrest/v1.0/jobrequisitions/*
Description Insert job requisition records

Input Parameters

records Job requisition records that need to be inserted

Sample Code


// POST Request
{
   "records": [{
      "Name": "Test B",
      "Agencies": "UK",
      "ApplicationDisclaimer": "Application_Disclaimer",
      "AttachResume": true,
      "BonusPercent": 23,
      "BonusAmount": 20000,
      "BonusEligible": "Yes",
      "CityTown": "NewYork",
      "CurrencyCode": "CAD",
      "ExternalPositionDescription": "External_Position_Description",
      "InternalPositionDescription": "Internal_Position_Description",
      "EEOJobCategory": "Mid Officials",
      "FullPartTimeJob": "Full Time",
      "HiringRequest": "New",
      "IncludeApplywithLinkedIn": true,
      "IncludeAttachments": true,
      "IncludeCoverLetter": true,
      "IncludeDisclaimer": true,
      "IncludeJobSummary": true,
      "IncludeQuestions": true,
      "IncludeSharingButtons": true,
      "Industry": "Accountancy",
      "JobBoardDescription": "Job_Board_Posting_Description",
      "JobOpeningStatus": "Submitted",
      "JobType": "Permanent",
      "NumberofOpenings": 5,
      "PositionFTE": 3,
      "PositionTitle": "New Position",
      "PostExternally": true,
      "PostingDate": "2016-11-02",
      "PostingURL": "https://postUrl/jobOpening1",
      "PostInternally": true,
      "QuestionsOrder": "1,2,3,4",
      "RegularTemporary": "Regular",
      "RequestEducationHistory": true,
      "RequestSelfIdentification": true,
      "RequestWorkHistory": true,
      "SalaryFrom": 35000,
      "SalaryFrequency": "week",
      "SalaryTo": 50000,
      "ScheduledHours": 8,
      "SelfIdentificationText": "IdentificationSummary",
      "StateProvince": "NewState",
      "SummaryDescription": "Job_Posting_Summary",
      "TargetStartDate": "2016-12-12",
      "ZipPostalCode": "5674732",
      "CustomFields": [{
         "FieldName": "Custom_JobRequisition1__c",
         "Value": "Test Custom Field1"
      }, {
         "FieldName": "Custom_JobRequisition2__c",
         "Value": 10
      }, {
         "FieldName": "Custom_JobRequisition3__c",
         "Value": "2015-12-02"
      }, {
         "FieldName": "Custom_JobRequisition4__c",
         "Value": "2014-05-02 00:55:55"
      }, {
         "FieldName": "Custom_JobRequisition5__c",
         "Value": true
      }]
   }]
}

// POST Response
["a2J15000000p6GvEAI"]

PATCH

URI /services/apexrest/v1.0/jobrequisitions/*
Description Insert or update job requisition records

Input Parameters

records Job requisition records that need to be inserted or updated

Sample Code


// PATCH Request
{
   "records": [{
      "Id": "a2J15000000p5kx",
      "Name": "JobOpening 1",
      "Agencies": "USA",
      "ApplicationDisclaimer": "Application_Disclaimer",
      "AttachResume": true,
      "BonusPercent": 5,
      "BonusAmount": 20000,
      "BonusEligible": "Yes",
      "CityTown": "California",
      "CurrencyCode": "USD",
      "ExternalPositionDescription": "External_Position_Description",
      "InternalPositionDescription": "Internal_Position_Description",
      "EEOJobCategory": "Mid Officials",
      "FullPartTimeJob": "Full Time",
      "HiringRequest": "New",
      "IncludeApplywithLinkedIn": true,
      "IncludeAttachments": true,
      "IncludeCoverLetter": true,
      "IncludeDisclaimer": true,
      "IncludeJobSummary": true,
      "IncludeQuestions": true,
      "IncludeSharingButtons": true,
      "Industry": "Accountancy",
      "JobBoardDescription": "Job_Board_Posting_Description",
      "JobOpeningStatus": "Submitted",
      "JobType": "Contract",
      "NumberofOpenings": 5,
      "PositionFTE": 3,
      "PositionTitle": "New Position",
      "PostExternally": true,
      "PostingDate": "2016-11-02",
      "PostingURL": "https://postUrl/jobOpening1",
      "PostInternally": true,
      "QuestionsOrder": "1,2,3,4",
      "RegularTemporary": "Regular",
      "RequestEducationHistory": true,
      "RequestSelfIdentification": true,
      "RequestWorkHistory": true,
      "SalaryFrom": 35000,
      "SalaryFrequency": "week",
      "SalaryTo": 50000,
      "ScheduledHours": 8,
      "SelfIdentificationText": "IdentificationSummary",
      "StateProvince": "NewState",
      "SummaryDescription": "Job_Posting_Summary",
      "TargetStartDate": "2016-12-12",
      "ZipPostalCode": "5674732",
      "CostCenter": "a1b15000006ZLs0",
      "CountryCode": "a1b15000006ZLs0",
      "Department": "a1b15000006ZLs0",
      "Division": "a1b15000006ZLs0",
      "HiringManager": "a1b15000006ZLs0",
      "HiringTeam1": "a1b15000006ZLs0",
      "HiringTeam2": "a1b15000006ZLs0",
      "Interviewer": “a1b15000006ZLs0 ",
      "Job": "a1b15000006ZLs0",
      "JobFunction": "a1b15000006ZLs0",
      "Location": "a1b15000006ZLs0",
      "Position": "a1b15000006ZLs0",
      "QuestionSet": "a1b15000006ZLs0",
      "Recruiter": "a1b15000006ZLs0",
      "Region": "a1b15000006ZLs0",
      "CustomFields": [{
         "FieldName": "Custom_JobRequisition1__c",
         "Value": "Updated Test Custom Field1"
      }, {
         "FieldName": "Custom_JobRequisition2__c",
         "Value": 100
      }, {
         "FieldName": "Custom_JobRequisition3__c",
         "Value": "2015-12-05"
      }, {
         "FieldName": "Custom_JobRequisition4__c",
         "Value": "2016-05-02 00:55:55"
      }, {
         "FieldName": "Custom_JobRequisition5__c",
         "Value": false
      }]
   }]

}

// PATCH Response
["a2J15000000p6GvEAI"]
© Copyright 2009–2018 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.