> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # sap-successfactors-recruiting > SAP SuccessFactors Recruiting **Server path:** `/sap-successfactors-recruiting` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | | [`sap_successfactors_recruiting_create_candidate`](#sap_successfactors_recruiting_create_candidate) | Add new entity to Candidate | | [`sap_successfactors_recruiting_create_candidate_background_education`](#sap_successfactors_recruiting_create_candidate_background_education) | Add new entity to CandidateBackground\_Education | | [`sap_successfactors_recruiting_create_candidate_background_inside_work_experience`](#sap_successfactors_recruiting_create_candidate_background_inside_work_experience) | Add new entity to CandidateBackground\_InsideWorkExperience | | [`sap_successfactors_recruiting_create_candidate_background_outside_work_experience`](#sap_successfactors_recruiting_create_candidate_background_outside_work_experience) | Add new entity to CandidateBackground\_OutsideWorkExperience | | [`sap_successfactors_recruiting_create_job_application`](#sap_successfactors_recruiting_create_job_application) | Add new entity to JobApplication | | [`sap_successfactors_recruiting_create_job_application_interview`](#sap_successfactors_recruiting_create_job_application_interview) | Add new entity to JobApplicationInterview | | [`sap_successfactors_recruiting_create_job_offer`](#sap_successfactors_recruiting_create_job_offer) | Add new entity to JobOffer | | [`sap_successfactors_recruiting_create_job_requisition`](#sap_successfactors_recruiting_create_job_requisition) | Add new entity to JobRequisition | | [`sap_successfactors_recruiting_create_job_requisition_std_position_objlist`](#sap_successfactors_recruiting_create_job_requisition_std_position_objlist) | Add new entity to related std\_position\_objlist | | [`sap_successfactors_recruiting_create_offer_letter`](#sap_successfactors_recruiting_create_offer_letter) | Add new entity to OfferLetter | | [`sap_successfactors_recruiting_delete_job_application_interview`](#sap_successfactors_recruiting_delete_job_application_interview) | Delete entity from JobApplicationInterview | | [`sap_successfactors_recruiting_delete_job_offer`](#sap_successfactors_recruiting_delete_job_offer) | Delete entity from JobOffer | | [`sap_successfactors_recruiting_delete_job_requisition`](#sap_successfactors_recruiting_delete_job_requisition) | Delete entity from JobRequisition | | [`sap_successfactors_recruiting_delete_offer_letter`](#sap_successfactors_recruiting_delete_offer_letter) | Delete entity from OfferLetter | | [`sap_successfactors_recruiting_get_candidate`](#sap_successfactors_recruiting_get_candidate) | Get entity from Candidate by key | | [`sap_successfactors_recruiting_get_candidate_background_education`](#sap_successfactors_recruiting_get_candidate_background_education) | Get entity from CandidateBackground\_Education by key | | [`sap_successfactors_recruiting_get_candidate_background_inside_work_experience`](#sap_successfactors_recruiting_get_candidate_background_inside_work_experience) | Get entity from CandidateBackground\_InsideWorkExperience by key | | [`sap_successfactors_recruiting_get_candidate_background_outside_work_experience`](#sap_successfactors_recruiting_get_candidate_background_outside_work_experience) | Get entity from CandidateBackground\_OutsideWorkExperience by key | | [`sap_successfactors_recruiting_get_job_application`](#sap_successfactors_recruiting_get_job_application) | Get entity from JobApplication by key | | [`sap_successfactors_recruiting_get_job_application_interview`](#sap_successfactors_recruiting_get_job_application_interview) | Get entity from JobApplicationInterview by key | | [`sap_successfactors_recruiting_get_job_offer`](#sap_successfactors_recruiting_get_job_offer) | Get entity from JobOffer by key | | [`sap_successfactors_recruiting_get_job_req_question`](#sap_successfactors_recruiting_get_job_req_question) | Get entity from JobReqQuestion by key | | [`sap_successfactors_recruiting_get_job_requisition`](#sap_successfactors_recruiting_get_job_requisition) | Get entity from JobRequisition by key | | [`sap_successfactors_recruiting_get_job_requisition_std_position_objlist`](#sap_successfactors_recruiting_get_job_requisition_std_position_objlist) | Get entities from related std\_position\_objlist | | [`sap_successfactors_recruiting_get_offer_letter`](#sap_successfactors_recruiting_get_offer_letter) | Get entity from OfferLetter by key | | [`sap_successfactors_recruiting_list_approve_offer`](#sap_successfactors_recruiting_list_approve_offer) | Invoke function approveOffer | | [`sap_successfactors_recruiting_list_candidate`](#sap_successfactors_recruiting_list_candidate) | Get entities from Candidate | | [`sap_successfactors_recruiting_list_candidate_background_education`](#sap_successfactors_recruiting_list_candidate_background_education) | Get entities from CandidateBackground\_Education | | [`sap_successfactors_recruiting_list_candidate_background_inside_work_experience`](#sap_successfactors_recruiting_list_candidate_background_inside_work_experience) | Get entities from CandidateBackground\_InsideWorkExperience | | [`sap_successfactors_recruiting_list_candidate_background_outside_work_experience`](#sap_successfactors_recruiting_list_candidate_background_outside_work_experience) | Get entities from CandidateBackground\_OutsideWorkExperience | | [`sap_successfactors_recruiting_list_decline_offer`](#sap_successfactors_recruiting_list_decline_offer) | Invoke function declineOffer | | [`sap_successfactors_recruiting_list_job_application`](#sap_successfactors_recruiting_list_job_application) | Get entities from JobApplication | | [`sap_successfactors_recruiting_list_job_application_interview`](#sap_successfactors_recruiting_list_job_application_interview) | Get entities from JobApplicationInterview | | [`sap_successfactors_recruiting_list_job_offer`](#sap_successfactors_recruiting_list_job_offer) | Get entities from JobOffer | | [`sap_successfactors_recruiting_list_job_req_question`](#sap_successfactors_recruiting_list_job_req_question) | Get entities from JobReqQuestion | | [`sap_successfactors_recruiting_list_job_requisition`](#sap_successfactors_recruiting_list_job_requisition) | Get entities from JobRequisition | | [`sap_successfactors_recruiting_list_offer_letter`](#sap_successfactors_recruiting_list_offer_letter) | Get entities from OfferLetter | | [`sap_successfactors_recruiting_replace_candidate`](#sap_successfactors_recruiting_replace_candidate) | Update entity in Candidate | | [`sap_successfactors_recruiting_replace_candidate_background_education`](#sap_successfactors_recruiting_replace_candidate_background_education) | Update entity in CandidateBackground\_Education | | [`sap_successfactors_recruiting_replace_candidate_background_inside_work_experience`](#sap_successfactors_recruiting_replace_candidate_background_inside_work_experience) | Update entity in CandidateBackground\_InsideWorkExperience | | [`sap_successfactors_recruiting_replace_candidate_background_outside_work_experience`](#sap_successfactors_recruiting_replace_candidate_background_outside_work_experience) | Update entity in CandidateBackground\_OutsideWorkExperience | | [`sap_successfactors_recruiting_replace_job_application`](#sap_successfactors_recruiting_replace_job_application) | Update entity in JobApplication | | [`sap_successfactors_recruiting_replace_job_application_interview`](#sap_successfactors_recruiting_replace_job_application_interview) | Update entity in JobApplicationInterview | | [`sap_successfactors_recruiting_replace_job_offer`](#sap_successfactors_recruiting_replace_job_offer) | Update entity in JobOffer | | [`sap_successfactors_recruiting_replace_job_requisition`](#sap_successfactors_recruiting_replace_job_requisition) | Update entity in JobRequisition | | [`sap_successfactors_recruiting_replace_offer_letter`](#sap_successfactors_recruiting_replace_offer_letter) | Update entity in OfferLetter | *** ## sap\_successfactors\_recruiting\_create\_candidate Add new entity to Candidate **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------- | ------- | -------- | ------- | --------------------------- | | `address` | string | No | — | The address value | | `address2` | string | No | — | The address2 value | | `agreeToPrivacyStatement` | string | No | — | Agree To Privacy Statement | | `anonymized` | string | No | — | The anonymized value | | `anonymizedDateTime` | string | No | — | Anonymized Date Time | | `candidateId` | string | No | — | Candidate Id | | `candidateLocale` | string | No | — | Candidate Locale | | `candidateProfileExtension` | object | No | — | Candidate Profile Extension | | `cellPhone` | string | No | — | Cell Phone | | `certificates` | object | No | — | The certificates value | | `city` | string | No | — | The city value | | `contactEmail` | string | No | — | Contact Email | | `country` | string | No | — | The country value | | `creationDateTime` | string | No | — | Creation Date Time | | `currentTitle` | string | No | — | Current Title | | `dataPrivacyId` | string | No | — | Data Privacy Id | | `dateofAvailability` | string | No | — | Dateof Availability | | `education` | object | No | — | The education value | | `externalCandidate` | boolean | No | — | External Candidate | | `firstName` | string | No | — | First Name | | `homePhone` | string | No | — | Home Phone | | `insideWorkExperience` | object | No | — | Inside Work Experience | | `languages` | object | No | — | The languages value | | `lastLoginDateTime` | string | No | — | Last Login Date Time | | `lastModifiedDateTime` | string | No | — | Last Modified Date Time | | `lastName` | string | No | — | Last Name | | `middleName` | string | No | — | Middle Name | | `outsideWorkExperience` | object | No | — | Outside Work Experience | | `partnerMemberId` | string | No | — | Partner Member Id | | `partnerSource` | string | No | — | Partner Source | | `password` | string | No | — | The password value | | `primaryEmail` | string | No | — | Primary Email | | `privacyAcceptDateTime` | string | No | — | Privacy Accept Date Time | | `publicIntranet` | boolean | No | — | Public Intranet | | `shareProfile` | string | No | — | Share Profile | | `tags` | object | No | — | The tags value | | `talentPool` | object | No | — | Talent Pool | | `talentPoolcorp` | object | No | — | Talent Poolcorp | | `usersSysId` | string | No | — | Users Sys Id | | `visibilityOption` | boolean | No | — | Visibility Option | | `zip` | string | No | — | The zip value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "address": { "type": "string", "description": "The address value" }, "address2": { "type": "string", "description": "The address2 value" }, "agreeToPrivacyStatement": { "type": "string", "description": "Agree To Privacy Statement" }, "anonymized": { "type": "string", "description": "The anonymized value" }, "anonymizedDateTime": { "type": "string", "description": "Anonymized Date Time" }, "candidateId": { "type": "string", "description": "Candidate Id" }, "candidateLocale": { "type": "string", "description": "Candidate Locale" }, "candidateProfileExtension": { "type": "object", "description": "Candidate Profile Extension", "properties": { "candidateId": { "type": "string", "description": "Candidate Id" }, "createdBy": { "type": "string", "description": "Created By" }, "createdDateTime": { "type": "string", "description": "Created Date Time" }, "lastModifiedBy": { "type": "string", "description": "Last Modified By" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "mdfSystemRecordStatus": { "type": "string", "description": "Mdf System Record Status" } } }, "cellPhone": { "type": "string", "description": "Cell Phone" }, "certificates": { "type": "object", "description": "The certificates value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "city": { "type": "string", "description": "The city value" }, "contactEmail": { "type": "string", "description": "Contact Email" }, "country": { "type": "string", "description": "The country value" }, "creationDateTime": { "type": "string", "description": "Creation Date Time" }, "currentTitle": { "type": "string", "description": "Current Title" }, "dataPrivacyId": { "type": "string", "description": "Data Privacy Id" }, "dateofAvailability": { "type": "string", "description": "Dateof Availability" }, "education": { "type": "object", "description": "The education value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "externalCandidate": { "type": "boolean", "description": "External Candidate" }, "firstName": { "type": "string", "description": "First Name" }, "homePhone": { "type": "string", "description": "Home Phone" }, "insideWorkExperience": { "type": "object", "description": "Inside Work Experience", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "languages": { "type": "object", "description": "The languages value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "lastLoginDateTime": { "type": "string", "description": "Last Login Date Time" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "lastName": { "type": "string", "description": "Last Name" }, "middleName": { "type": "string", "description": "Middle Name" }, "outsideWorkExperience": { "type": "object", "description": "Outside Work Experience", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "partnerMemberId": { "type": "string", "description": "Partner Member Id" }, "partnerSource": { "type": "string", "description": "Partner Source" }, "password": { "type": "string", "description": "The password value" }, "primaryEmail": { "type": "string", "description": "Primary Email" }, "privacyAcceptDateTime": { "type": "string", "description": "Privacy Accept Date Time" }, "publicIntranet": { "type": "boolean", "description": "Public Intranet" }, "shareProfile": { "type": "string", "description": "Share Profile" }, "tags": { "type": "object", "description": "The tags value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "talentPool": { "type": "object", "description": "Talent Pool", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "talentPoolcorp": { "type": "object", "description": "Talent Poolcorp", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "usersSysId": { "type": "string", "description": "Users Sys Id" }, "visibilityOption": { "type": "boolean", "description": "Visibility Option" }, "zip": { "type": "string", "description": "The zip value" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_create\_candidate\_background\_education Add new entity to CandidateBackground\_Education **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ------------------------ | | `backgroundElementId` | string | No | — | Background Element Id | | `bgOrderPos` | string | No | — | Bg Order Pos | | `candidate` | object | No | — | The candidate value | | `candidateId` | string | No | — | Candidate Id | | `degree` | string | No | — | The degree value | | `degreeDate` | string | No | — | Degree Date | | `endDate` | string | No | — | End date for filtering | | `lastModifiedDateTime` | string | No | — | Last Modified Date Time | | `major` | string | No | — | The major value | | `presentStudent` | integer | No | — | Present Student | | `school` | string | No | — | The school value | | `schoolAddress` | string | No | — | School Address | | `schoolCity` | string | No | — | School City | | `schoolCountry` | string | No | — | School Country | | `schoolPhone` | string | No | — | School Phone | | `schoolState` | string | No | — | School State | | `schoolType` | string | No | — | School Type | | `schoolZip` | string | No | — | School Zip | | `startDate` | string | No | — | Start date for filtering | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "string", "description": "Background Element Id" }, "bgOrderPos": { "type": "string", "description": "Bg Order Pos" }, "candidate": { "type": "object", "description": "The candidate value", "properties": { "address": { "type": "string", "description": "The address value" }, "address2": { "type": "string", "description": "The address2 value" }, "agreeToPrivacyStatement": { "type": "string", "description": "Agree To Privacy Statement" }, "anonymized": { "type": "string", "description": "The anonymized value" }, "anonymizedDateTime": { "type": "string", "description": "Anonymized Date Time" }, "candidateId": { "type": "string", "description": "Candidate Id" }, "candidateLocale": { "type": "string", "description": "Candidate Locale" }, "cellPhone": { "type": "string", "description": "Cell Phone" }, "city": { "type": "string", "description": "The city value" }, "contactEmail": { "type": "string", "description": "Contact Email" }, "country": { "type": "string", "description": "The country value" }, "creationDateTime": { "type": "string", "description": "Creation Date Time" }, "currentTitle": { "type": "string", "description": "Current Title" }, "dataPrivacyId": { "type": "string", "description": "Data Privacy Id" }, "dateofAvailability": { "type": "string", "description": "Dateof Availability" }, "externalCandidate": { "type": "boolean", "description": "External Candidate" }, "firstName": { "type": "string", "description": "First Name" }, "homePhone": { "type": "string", "description": "Home Phone" }, "lastLoginDateTime": { "type": "string", "description": "Last Login Date Time" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "lastName": { "type": "string", "description": "Last Name" }, "middleName": { "type": "string", "description": "Middle Name" }, "partnerMemberId": { "type": "string", "description": "Partner Member Id" }, "partnerSource": { "type": "string", "description": "Partner Source" }, "password": { "type": "string", "description": "The password value" }, "primaryEmail": { "type": "string", "description": "Primary Email" }, "privacyAcceptDateTime": { "type": "string", "description": "Privacy Accept Date Time" }, "publicIntranet": { "type": "boolean", "description": "Public Intranet" }, "shareProfile": { "type": "string", "description": "Share Profile" }, "usersSysId": { "type": "string", "description": "Users Sys Id" }, "visibilityOption": { "type": "boolean", "description": "Visibility Option" }, "zip": { "type": "string", "description": "The zip value" }, "candidateProfileExtension": { "type": "object", "description": "Candidate Profile Extension" }, "certificates": { "type": "object", "description": "The certificates value" }, "education": { "type": "object", "description": "The education value" }, "insideWorkExperience": { "type": "object", "description": "Inside Work Experience" }, "languages": { "type": "object", "description": "The languages value" }, "outsideWorkExperience": { "type": "object", "description": "Outside Work Experience" }, "tags": { "type": "object", "description": "The tags value" }, "talentPool": { "type": "object", "description": "Talent Pool" }, "talentPoolcorp": { "type": "object", "description": "Talent Poolcorp" } } }, "candidateId": { "type": "string", "description": "Candidate Id" }, "degree": { "type": "string", "description": "The degree value" }, "degreeDate": { "type": "string", "description": "Degree Date" }, "endDate": { "type": "string", "description": "End date for filtering" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "major": { "type": "string", "description": "The major value" }, "presentStudent": { "type": "integer", "description": "Present Student" }, "school": { "type": "string", "description": "The school value" }, "schoolAddress": { "type": "string", "description": "School Address" }, "schoolCity": { "type": "string", "description": "School City" }, "schoolCountry": { "type": "string", "description": "School Country" }, "schoolPhone": { "type": "string", "description": "School Phone" }, "schoolState": { "type": "string", "description": "School State" }, "schoolType": { "type": "string", "description": "School Type" }, "schoolZip": { "type": "string", "description": "School Zip" }, "startDate": { "type": "string", "description": "Start date for filtering" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_create\_candidate\_background\_inside\_work\_experience Add new entity to CandidateBackground\_InsideWorkExperience **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------ | -------- | ------- | ------------------------ | | `backgroundElementId` | string | No | — | Background Element Id | | `bgOrderPos` | string | No | — | Bg Order Pos | | `candidate` | object | No | — | The candidate value | | `candidateId` | string | No | — | Candidate Id | | `department` | string | No | — | The department value | | `endDate` | string | No | — | End date for filtering | | `lastModifiedDateTime` | string | No | — | Last Modified Date Time | | `startDate` | string | No | — | Start date for filtering | | `title` | string | No | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "string", "description": "Background Element Id" }, "bgOrderPos": { "type": "string", "description": "Bg Order Pos" }, "candidate": { "type": "object", "description": "The candidate value", "properties": { "address": { "type": "string", "description": "The address value" }, "address2": { "type": "string", "description": "The address2 value" }, "agreeToPrivacyStatement": { "type": "string", "description": "Agree To Privacy Statement" }, "anonymized": { "type": "string", "description": "The anonymized value" }, "anonymizedDateTime": { "type": "string", "description": "Anonymized Date Time" }, "candidateId": { "type": "string", "description": "Candidate Id" }, "candidateLocale": { "type": "string", "description": "Candidate Locale" }, "cellPhone": { "type": "string", "description": "Cell Phone" }, "city": { "type": "string", "description": "The city value" }, "contactEmail": { "type": "string", "description": "Contact Email" }, "country": { "type": "string", "description": "The country value" }, "creationDateTime": { "type": "string", "description": "Creation Date Time" }, "currentTitle": { "type": "string", "description": "Current Title" }, "dataPrivacyId": { "type": "string", "description": "Data Privacy Id" }, "dateofAvailability": { "type": "string", "description": "Dateof Availability" }, "externalCandidate": { "type": "boolean", "description": "External Candidate" }, "firstName": { "type": "string", "description": "First Name" }, "homePhone": { "type": "string", "description": "Home Phone" }, "lastLoginDateTime": { "type": "string", "description": "Last Login Date Time" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "lastName": { "type": "string", "description": "Last Name" }, "middleName": { "type": "string", "description": "Middle Name" }, "partnerMemberId": { "type": "string", "description": "Partner Member Id" }, "partnerSource": { "type": "string", "description": "Partner Source" }, "password": { "type": "string", "description": "The password value" }, "primaryEmail": { "type": "string", "description": "Primary Email" }, "privacyAcceptDateTime": { "type": "string", "description": "Privacy Accept Date Time" }, "publicIntranet": { "type": "boolean", "description": "Public Intranet" }, "shareProfile": { "type": "string", "description": "Share Profile" }, "usersSysId": { "type": "string", "description": "Users Sys Id" }, "visibilityOption": { "type": "boolean", "description": "Visibility Option" }, "zip": { "type": "string", "description": "The zip value" }, "candidateProfileExtension": { "type": "object", "description": "Candidate Profile Extension" }, "certificates": { "type": "object", "description": "The certificates value" }, "education": { "type": "object", "description": "The education value" }, "insideWorkExperience": { "type": "object", "description": "Inside Work Experience" }, "languages": { "type": "object", "description": "The languages value" }, "outsideWorkExperience": { "type": "object", "description": "Outside Work Experience" }, "tags": { "type": "object", "description": "The tags value" }, "talentPool": { "type": "object", "description": "Talent Pool" }, "talentPoolcorp": { "type": "object", "description": "Talent Poolcorp" } } }, "candidateId": { "type": "string", "description": "Candidate Id" }, "department": { "type": "string", "description": "The department value" }, "endDate": { "type": "string", "description": "End date for filtering" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "startDate": { "type": "string", "description": "Start date for filtering" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_create\_candidate\_background\_outside\_work\_experience Add new entity to CandidateBackground\_OutsideWorkExperience **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------ | -------- | ------- | ------------------------ | | `backgroundElementId` | string | No | — | Background Element Id | | `bgOrderPos` | string | No | — | Bg Order Pos | | `businessType` | string | No | — | Business Type | | `candidate` | object | No | — | The candidate value | | `candidateId` | string | No | — | Candidate Id | | `employer` | string | No | — | The employer value | | `employerAddress` | string | No | — | Employer Address | | `employerCity` | string | No | — | Employer City | | `employerContact` | string | No | — | Employer Contact | | `employerCountry` | string | No | — | Employer Country | | `employerEmail` | string | No | — | Employer Email | | `employerPhone` | string | No | — | Employer Phone | | `employerState` | string | No | — | Employer State | | `employerZip` | string | No | — | Employer Zip | | `endDate` | string | No | — | End date for filtering | | `lastModifiedDateTime` | string | No | — | Last Modified Date Time | | `presentEmployer` | string | No | — | Present Employer | | `startDate` | string | No | — | Start date for filtering | | `startTitle` | string | No | — | Start Title | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "string", "description": "Background Element Id" }, "bgOrderPos": { "type": "string", "description": "Bg Order Pos" }, "businessType": { "type": "string", "description": "Business Type" }, "candidate": { "type": "object", "description": "The candidate value", "properties": { "address": { "type": "string", "description": "The address value" }, "address2": { "type": "string", "description": "The address2 value" }, "agreeToPrivacyStatement": { "type": "string", "description": "Agree To Privacy Statement" }, "anonymized": { "type": "string", "description": "The anonymized value" }, "anonymizedDateTime": { "type": "string", "description": "Anonymized Date Time" }, "candidateId": { "type": "string", "description": "Candidate Id" }, "candidateLocale": { "type": "string", "description": "Candidate Locale" }, "cellPhone": { "type": "string", "description": "Cell Phone" }, "city": { "type": "string", "description": "The city value" }, "contactEmail": { "type": "string", "description": "Contact Email" }, "country": { "type": "string", "description": "The country value" }, "creationDateTime": { "type": "string", "description": "Creation Date Time" }, "currentTitle": { "type": "string", "description": "Current Title" }, "dataPrivacyId": { "type": "string", "description": "Data Privacy Id" }, "dateofAvailability": { "type": "string", "description": "Dateof Availability" }, "externalCandidate": { "type": "boolean", "description": "External Candidate" }, "firstName": { "type": "string", "description": "First Name" }, "homePhone": { "type": "string", "description": "Home Phone" }, "lastLoginDateTime": { "type": "string", "description": "Last Login Date Time" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "lastName": { "type": "string", "description": "Last Name" }, "middleName": { "type": "string", "description": "Middle Name" }, "partnerMemberId": { "type": "string", "description": "Partner Member Id" }, "partnerSource": { "type": "string", "description": "Partner Source" }, "password": { "type": "string", "description": "The password value" }, "primaryEmail": { "type": "string", "description": "Primary Email" }, "privacyAcceptDateTime": { "type": "string", "description": "Privacy Accept Date Time" }, "publicIntranet": { "type": "boolean", "description": "Public Intranet" }, "shareProfile": { "type": "string", "description": "Share Profile" }, "usersSysId": { "type": "string", "description": "Users Sys Id" }, "visibilityOption": { "type": "boolean", "description": "Visibility Option" }, "zip": { "type": "string", "description": "The zip value" }, "candidateProfileExtension": { "type": "object", "description": "Candidate Profile Extension" }, "certificates": { "type": "object", "description": "The certificates value" }, "education": { "type": "object", "description": "The education value" }, "insideWorkExperience": { "type": "object", "description": "Inside Work Experience" }, "languages": { "type": "object", "description": "The languages value" }, "outsideWorkExperience": { "type": "object", "description": "Outside Work Experience" }, "tags": { "type": "object", "description": "The tags value" }, "talentPool": { "type": "object", "description": "Talent Pool" }, "talentPoolcorp": { "type": "object", "description": "Talent Poolcorp" } } }, "candidateId": { "type": "string", "description": "Candidate Id" }, "employer": { "type": "string", "description": "The employer value" }, "employerAddress": { "type": "string", "description": "Employer Address" }, "employerCity": { "type": "string", "description": "Employer City" }, "employerContact": { "type": "string", "description": "Employer Contact" }, "employerCountry": { "type": "string", "description": "Employer Country" }, "employerEmail": { "type": "string", "description": "Employer Email" }, "employerPhone": { "type": "string", "description": "Employer Phone" }, "employerState": { "type": "string", "description": "Employer State" }, "employerZip": { "type": "string", "description": "Employer Zip" }, "endDate": { "type": "string", "description": "End date for filtering" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "presentEmployer": { "type": "string", "description": "Present Employer" }, "startDate": { "type": "string", "description": "Start date for filtering" }, "startTitle": { "type": "string", "description": "Start Title" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_create\_job\_application Add new entity to JobApplication **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------------- | ------- | -------- | ------- | ----------------------------------------- | | `address` | string | No | — | The address value | | `address2` | string | No | — | The address2 value | | `agencyInfo` | string | No | — | Agency Info | | `anonymizedDate` | string | No | — | Anonymized Date | | `anonymizedFlag` | string | No | — | Anonymized Flag | | `applicationId` | string | No | — | Application Id | | `applicationTemplateId` | string | No | — | Application Template Id | | `appLocale` | string | No | — | App Locale | | `appStatusSetItemId` | string | No | — | App Status Set Item Id | | `averageRating` | string | No | — | Average Rating | | `baseSalary` | string | No | — | Base Salary | | `candConversionProcessed` | string | No | — | Cand Conversion Processed | | `candidateId` | string | No | — | Candidate Id | | `candJust` | string | No | — | Cand Just | | `candTypeWhenHired` | string | No | — | Cand Type When Hired | | `cellPhone` | string | No | — | Cell Phone | | `city` | string | No | — | The city value | | `confnumber` | string | No | — | The confnumber value | | `contactEmail` | string | No | — | Contact Email | | `conviction_details` | string | No | — | Conviction Details | | `country` | string | No | — | The country value | | `countryCode` | string | No | — | Country Code | | `criminalconvictionlabel` | string | No | — | The criminalconvictionlabel value | | `crimincalconvictioninstructions` | string | No | — | The crimincalconvictioninstructions value | | `currentLocation` | string | No | — | Current Location | | `currentTitle` | string | No | — | Current Title | | `cust_refCheckFirstName` | string | No | — | Cust Ref Check First Name | | `cust_refCheckLastName` | string | No | — | Cust Ref Check Last Name | | `cust_refCheckOrg1` | string | No | — | Cust Ref Check Org1 | | `cust_refCheckPhone1` | string | No | — | Cust Ref Check Phone1 | | `cust_refCheckTitle1` | string | No | — | Cust Ref Check Title1 | | `dataSource` | string | No | — | Data Source | | `dateAvail` | string | No | — | Date Avail | | `dateOfBirth` | string | No | — | Date Of Birth | | `duplicateProfile` | string | No | — | Duplicate Profile | | `exportedOn` | string | No | — | Exported On | | `extTitle` | string | No | — | Ext Title | | `firstName` | string | No | — | First Name | | `formerEmployee` | boolean | No | — | Former Employee | | `gender` | string | No | — | The gender value | | `haveyoubeenconvicted` | string | No | — | The haveyoubeenconvicted value | | `hireDate` | string | No | — | Hire Date | | `hiredOn` | string | No | — | Hired On | | `homePhone` | string | No | — | Home Phone | | `inductionAdd` | string | No | — | Induction Add | | `inductionDate` | string | No | — | Induction Date | | `initials` | string | No | — | The initials value | | `instr_AdditionalDocuments` | string | No | — | Instr Additional Documents | | `instr_AppAdditionalInfo` | string | No | — | Instr App Additional Info | | `instr_AppAdvice` | string | No | — | Instr App Advice | | `instr_CandAppDetails` | string | No | — | Instr Cand App Details | | `instr_CandPersInfo` | string | No | — | Instr Cand Pers Info | | `instr_EEOinstructions` | string | No | — | Instr EE Oinstructions | | `instr_EEOlable` | string | No | — | Instr EE Olable | | `instrAppReturn` | string | No | — | Instr App Return | | `instrCandApproval` | string | No | — | Instr Cand Approval | | `instrCandAssess` | string | No | — | Instr Cand Assess | | `instrCandFields` | string | No | — | Instr Cand Fields | | `instrCandScreen` | string | No | — | Instr Cand Screen | | `instrubkgrndChkAttachment` | string | No | — | Instrubkgrnd Chk Attachment | | `instrWotc` | string | No | — | Instr Wotc | | `jobAppGuid` | string | No | — | Job App Guid | | `jobApplicationAssessmentOrder` | object | No | — | Job Application Assessment Order | | `jobApplicationAssessmentOrder_1` | object | No | — | Job Application Assessment Order 1 | | `jobApplicationComments` | object | No | — | Job Application Comments | | `jobApplicationOnboardingData` | object | No | — | Job Application Onboarding Data | | `jobApplicationQuestionResponse` | object | No | — | Job Application Question Response | | `jobApplicationStatusAuditTrail` | object | No | — | Job Application Status Audit Trail | | `jobAppStatus` | object | No | — | Job App Status | | `jobCode` | string | No | — | Job Code | | `jobofferdate` | string | No | — | The jobofferdate value | | `jobRateOfPay` | string | No | — | Job Rate Of Pay | | `jobReqId` | string | No | — | Job Req Id | | `jobStartDate` | string | No | — | Job Start Date | | `knownAs` | string | No | — | Known As | | `lastModifiedBy` | string | No | — | Last Modified By | | `lastModifiedByProxy` | string | No | — | Last Modified By Proxy | | `lastModifiedDateTime` | string | No | — | Last Modified Date Time | | `lastName` | string | No | — | Last Name | | `medDate` | string | No | — | Med Date | | `medLoc` | string | No | — | Med Loc | | `medTime` | string | No | — | Med Time | | `middleName` | string | No | — | Middle Name | | `nonApplicantStatus` | string | No | — | Non Applicant Status | | `owner` | string | No | — | The owner value | | `ownershpDate` | string | No | — | Ownershp Date | | `phoneScreenDate` | string | No | — | Phone Screen Date | | `phoneScreenDetails` | string | No | — | Phone Screen Details | | `pleaseselect` | string | No | — | The pleaseselect value | | `posTitle` | string | No | — | Pos Title | | `profileUpdated` | string | No | — | Profile Updated | | `psychTestDte` | string | No | — | Psych Test Dte | | `psychTestTme` | string | No | — | Psych Test Tme | | `rating` | string | No | — | The rating value | | `reasonableaccomodation` | string | No | — | The reasonableaccomodation value | | `reference` | string | No | — | The reference value | | `referenceComments` | string | No | — | Reference Comments | | `referredBy` | string | No | — | Referred By | | `resumeUploadDate` | string | No | — | Resume Upload Date | | `screendate` | string | No | — | The screendate value | | `snapShotDate` | string | No | — | Snap Shot Date | | `source` | string | No | — | The source value | | `sourceLabel` | string | No | — | Source Label | | `ssn` | string | No | — | The ssn value | | `startDate` | string | No | — | Start date for filtering | | `stateOther` | string | No | — | State Other | | `status` | string | No | — | The status value | | `statusComments` | string | No | — | Status Comments | | `timeToHire` | number | No | — | Time To Hire | | `title` | string | No | — | The title value | | `usersSysId` | string | No | — | Users Sys Id | | `visaNum` | string | No | — | Visa Num | | `voluntaryselfID` | string | No | — | Voluntaryself ID | | `whyask` | string | No | — | The whyask value | | `wotcFormsURL` | string | No | — | Wotc Forms URL | | `wotcId` | string | No | — | Wotc Id | | `wotcScreeningURL` | string | No | — | Wotc Screening URL | | `wotcStatus` | string | No | — | Wotc Status | | `yesanswer` | string | No | — | The yesanswer value | | `zip` | string | No | — | The zip value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "address": { "type": "string", "description": "The address value" }, "address2": { "type": "string", "description": "The address2 value" }, "agencyInfo": { "type": "string", "description": "Agency Info" }, "anonymizedDate": { "type": "string", "description": "Anonymized Date" }, "anonymizedFlag": { "type": "string", "description": "Anonymized Flag" }, "applicationId": { "type": "string", "description": "Application Id" }, "applicationTemplateId": { "type": "string", "description": "Application Template Id" }, "appLocale": { "type": "string", "description": "App Locale" }, "appStatusSetItemId": { "type": "string", "description": "App Status Set Item Id" }, "averageRating": { "type": "string", "description": "Average Rating" }, "baseSalary": { "type": "string", "description": "Base Salary" }, "candConversionProcessed": { "type": "string", "description": "Cand Conversion Processed" }, "candidateId": { "type": "string", "description": "Candidate Id" }, "candJust": { "type": "string", "description": "Cand Just" }, "candTypeWhenHired": { "type": "string", "description": "Cand Type When Hired" }, "cellPhone": { "type": "string", "description": "Cell Phone" }, "city": { "type": "string", "description": "The city value" }, "confnumber": { "type": "string", "description": "The confnumber value" }, "contactEmail": { "type": "string", "description": "Contact Email" }, "conviction_details": { "type": "string", "description": "Conviction Details" }, "country": { "type": "string", "description": "The country value" }, "countryCode": { "type": "string", "description": "Country Code" }, "criminalconvictionlabel": { "type": "string", "description": "The criminalconvictionlabel value" }, "crimincalconvictioninstructions": { "type": "string", "description": "The crimincalconvictioninstructions value" }, "currentLocation": { "type": "string", "description": "Current Location" }, "currentTitle": { "type": "string", "description": "Current Title" }, "cust_refCheckFirstName": { "type": "string", "description": "Cust Ref Check First Name" }, "cust_refCheckLastName": { "type": "string", "description": "Cust Ref Check Last Name" }, "cust_refCheckOrg1": { "type": "string", "description": "Cust Ref Check Org1" }, "cust_refCheckPhone1": { "type": "string", "description": "Cust Ref Check Phone1" }, "cust_refCheckTitle1": { "type": "string", "description": "Cust Ref Check Title1" }, "dataSource": { "type": "string", "description": "Data Source" }, "dateAvail": { "type": "string", "description": "Date Avail" }, "dateOfBirth": { "type": "string", "description": "Date Of Birth" }, "duplicateProfile": { "type": "string", "description": "Duplicate Profile" }, "exportedOn": { "type": "string", "description": "Exported On" }, "extTitle": { "type": "string", "description": "Ext Title" }, "firstName": { "type": "string", "description": "First Name" }, "formerEmployee": { "type": "boolean", "description": "Former Employee" }, "gender": { "type": "string", "description": "The gender value" }, "haveyoubeenconvicted": { "type": "string", "description": "The haveyoubeenconvicted value" }, "hireDate": { "type": "string", "description": "Hire Date" }, "hiredOn": { "type": "string", "description": "Hired On" }, "homePhone": { "type": "string", "description": "Home Phone" }, "inductionAdd": { "type": "string", "description": "Induction Add" }, "inductionDate": { "type": "string", "description": "Induction Date" }, "initials": { "type": "string", "description": "The initials value" }, "instr_AdditionalDocuments": { "type": "string", "description": "Instr Additional Documents" }, "instr_AppAdditionalInfo": { "type": "string", "description": "Instr App Additional Info" }, "instr_AppAdvice": { "type": "string", "description": "Instr App Advice" }, "instr_CandAppDetails": { "type": "string", "description": "Instr Cand App Details" }, "instr_CandPersInfo": { "type": "string", "description": "Instr Cand Pers Info" }, "instr_EEOinstructions": { "type": "string", "description": "Instr EE Oinstructions" }, "instr_EEOlable": { "type": "string", "description": "Instr EE Olable" }, "instrAppReturn": { "type": "string", "description": "Instr App Return" }, "instrCandApproval": { "type": "string", "description": "Instr Cand Approval" }, "instrCandAssess": { "type": "string", "description": "Instr Cand Assess" }, "instrCandFields": { "type": "string", "description": "Instr Cand Fields" }, "instrCandScreen": { "type": "string", "description": "Instr Cand Screen" }, "instrubkgrndChkAttachment": { "type": "string", "description": "Instrubkgrnd Chk Attachment" }, "instrWotc": { "type": "string", "description": "Instr Wotc" }, "jobAppGuid": { "type": "string", "description": "Job App Guid" }, "jobApplicationAssessmentOrder": { "type": "object", "description": "Job Application Assessment Order", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobApplicationAssessmentOrder_1": { "type": "object", "description": "Job Application Assessment Order 1", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobApplicationComments": { "type": "object", "description": "Job Application Comments", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobApplicationOnboardingData": { "type": "object", "description": "Job Application Onboarding Data", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobApplicationQuestionResponse": { "type": "object", "description": "Job Application Question Response", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobApplicationStatusAuditTrail": { "type": "object", "description": "Job Application Status Audit Trail", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobAppStatus": { "type": "object", "description": "Job App Status", "properties": { "appStatusId": { "type": "string", "description": "App Status Id" }, "appStatusName": { "type": "string", "description": "App Status Name" }, "appStatusSetId": { "type": "string", "description": "App Status Set Id" }, "jobAppStatusLabel": { "type": "object", "description": "Job App Status Label" }, "jobApplications": { "type": "object", "description": "Job Applications" } } }, "jobCode": { "type": "string", "description": "Job Code" }, "jobofferdate": { "type": "string", "description": "The jobofferdate value" }, "jobRateOfPay": { "type": "string", "description": "Job Rate Of Pay" }, "jobReqId": { "type": "string", "description": "Job Req Id" }, "jobStartDate": { "type": "string", "description": "Job Start Date" }, "knownAs": { "type": "string", "description": "Known As" }, "lastModifiedBy": { "type": "string", "description": "Last Modified By" }, "lastModifiedByProxy": { "type": "string", "description": "Last Modified By Proxy" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "lastName": { "type": "string", "description": "Last Name" }, "medDate": { "type": "string", "description": "Med Date" }, "medLoc": { "type": "string", "description": "Med Loc" }, "medTime": { "type": "string", "description": "Med Time" }, "middleName": { "type": "string", "description": "Middle Name" }, "nonApplicantStatus": { "type": "string", "description": "Non Applicant Status" }, "owner": { "type": "string", "description": "The owner value" }, "ownershpDate": { "type": "string", "description": "Ownershp Date" }, "phoneScreenDate": { "type": "string", "description": "Phone Screen Date" }, "phoneScreenDetails": { "type": "string", "description": "Phone Screen Details" }, "pleaseselect": { "type": "string", "description": "The pleaseselect value" }, "posTitle": { "type": "string", "description": "Pos Title" }, "profileUpdated": { "type": "string", "description": "Profile Updated" }, "psychTestDte": { "type": "string", "description": "Psych Test Dte" }, "psychTestTme": { "type": "string", "description": "Psych Test Tme" }, "rating": { "type": "string", "description": "The rating value" }, "reasonableaccomodation": { "type": "string", "description": "The reasonableaccomodation value" }, "reference": { "type": "string", "description": "The reference value" }, "referenceComments": { "type": "string", "description": "Reference Comments" }, "referredBy": { "type": "string", "description": "Referred By" }, "resumeUploadDate": { "type": "string", "description": "Resume Upload Date" }, "screendate": { "type": "string", "description": "The screendate value" }, "snapShotDate": { "type": "string", "description": "Snap Shot Date" }, "source": { "type": "string", "description": "The source value" }, "sourceLabel": { "type": "string", "description": "Source Label" }, "ssn": { "type": "string", "description": "The ssn value" }, "startDate": { "type": "string", "description": "Start date for filtering" }, "stateOther": { "type": "string", "description": "State Other" }, "status": { "type": "string", "description": "The status value" }, "statusComments": { "type": "string", "description": "Status Comments" }, "timeToHire": { "type": "number", "description": "Time To Hire" }, "title": { "type": "string", "description": "The title value" }, "usersSysId": { "type": "string", "description": "Users Sys Id" }, "visaNum": { "type": "string", "description": "Visa Num" }, "voluntaryselfID": { "type": "string", "description": "Voluntaryself ID" }, "whyask": { "type": "string", "description": "The whyask value" }, "wotcFormsURL": { "type": "string", "description": "Wotc Forms URL" }, "wotcId": { "type": "string", "description": "Wotc Id" }, "wotcScreeningURL": { "type": "string", "description": "Wotc Screening URL" }, "wotcStatus": { "type": "string", "description": "Wotc Status" }, "yesanswer": { "type": "string", "description": "The yesanswer value" }, "zip": { "type": "string", "description": "The zip value" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_create\_job\_application\_interview Add new entity to JobApplicationInterview **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------------- | ------- | -------- | ------- | ---------------------------- | | `applicationId` | string | No | — | Application Id | | `applicationInterviewId` | string | No | — | Application Interview Id | | `candSlotMapId` | string | No | — | Cand Slot Map Id | | `endDate` | string | No | — | End date for filtering | | `interviewOverallAssessment` | object | No | — | Interview Overall Assessment | | `isTimeSet` | integer | No | — | Is Time Set | | `notes` | string | No | — | The notes value | | `recruitEventStaffId` | string | No | — | Recruit Event Staff Id | | `source` | string | No | — | The source value | | `startDate` | string | No | — | Start date for filtering | | `status` | string | No | — | The status value | | `templateType` | string | No | — | Template Type | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "applicationId": { "type": "string", "description": "Application Id" }, "applicationInterviewId": { "type": "string", "description": "Application Interview Id" }, "candSlotMapId": { "type": "string", "description": "Cand Slot Map Id" }, "endDate": { "type": "string", "description": "End date for filtering" }, "interviewOverallAssessment": { "type": "object", "description": "Interview Overall Assessment", "properties": { "averageRating": { "type": "number", "description": "Average Rating" }, "comments": { "type": "string", "description": "The comments value" }, "interviewOverallAssessmentId": { "type": "string", "description": "Interview Overall Assessment Id" }, "interviewRefId": { "type": "string", "description": "Interview Ref Id" }, "overallRating": { "type": "string", "description": "Overall Rating" }, "type": { "type": "string", "description": "The type value" }, "interviewIndividualAssessment": { "type": "object", "description": "Interview Individual Assessment" } } }, "isTimeSet": { "type": "integer", "description": "Is Time Set" }, "notes": { "type": "string", "description": "The notes value" }, "recruitEventStaffId": { "type": "string", "description": "Recruit Event Staff Id" }, "source": { "type": "string", "description": "The source value" }, "startDate": { "type": "string", "description": "Start date for filtering" }, "status": { "type": "string", "description": "The status value" }, "templateType": { "type": "string", "description": "Template Type" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_create\_job\_offer Add new entity to JobOffer **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------- | ------ | -------- | ------- | --------------------------- | | `annual_cashPay` | string | No | — | Annual Cash Pay | | `annual_FB` | string | No | — | Annual FB | | `annual_gratuity` | string | No | — | Annual Gratuity | | `annual_PF` | string | No | — | Annual PF | | `annual_retirals` | string | No | — | Annual Retirals | | `annual_SA` | string | No | — | Annual SA | | `anonymizedDate` | string | No | — | Anonymized Date | | `anonymizedFlag` | string | No | — | Anonymized Flag | | `applicationId` | string | No | — | Application Id | | `approvers` | object | No | — | The approvers value | | `candidateName` | string | No | — | Candidate Name | | `candJust` | string | No | — | Cand Just | | `commission` | string | No | — | The commission value | | `createdBy` | string | No | — | Created By | | `createdDate` | string | No | — | Created Date | | `currency` | string | No | — | The currency value | | `currentLocation` | string | No | — | Current Location | | `formDataId` | string | No | — | Form Data Id | | `formTemplateId` | string | No | — | Form Template Id | | `initialComment` | string | No | — | Initial Comment | | `internalStatus` | string | No | — | Internal Status | | `jobRateOfPay` | string | No | — | Job Rate Of Pay | | `lastModifiedBy` | string | No | — | Last Modified By | | `lastModifiedDate` | string | No | — | Last Modified Date | | `location` | string | No | — | The location value | | `monthly_cashPay` | string | No | — | Monthly Cash Pay | | `monthly_FB` | string | No | — | Monthly FB | | `monthly_gratuity` | string | No | — | Monthly Gratuity | | `monthly_PF` | string | No | — | Monthly PF | | `monthly_retirals` | string | No | — | Monthly Retirals | | `monthly_SA` | string | No | — | Monthly SA | | `monthly_salary` | string | No | — | Monthly Salary | | `offerApprovalId` | string | No | — | Offer Approval Id | | `redefineTemplateApprovers` | string | No | — | Redefine Template Approvers | | `salaryBase` | string | No | — | Salary Base | | `stockPackage` | string | No | — | Stock Package | | `targetBonusAmount` | string | No | — | Target Bonus Amount | | `tempDate` | string | No | — | Temp Date | | `templateId` | string | No | — | Template Id | | `total_earnings` | string | No | — | Total Earnings | | `total_fixed_pay` | string | No | — | Total Fixed Pay | | `version` | string | No | — | The version value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "annual_cashPay": { "type": "string", "description": "Annual Cash Pay" }, "annual_FB": { "type": "string", "description": "Annual FB" }, "annual_gratuity": { "type": "string", "description": "Annual Gratuity" }, "annual_PF": { "type": "string", "description": "Annual PF" }, "annual_retirals": { "type": "string", "description": "Annual Retirals" }, "annual_SA": { "type": "string", "description": "Annual SA" }, "anonymizedDate": { "type": "string", "description": "Anonymized Date" }, "anonymizedFlag": { "type": "string", "description": "Anonymized Flag" }, "applicationId": { "type": "string", "description": "Application Id" }, "approvers": { "type": "object", "description": "The approvers value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "candidateName": { "type": "string", "description": "Candidate Name" }, "candJust": { "type": "string", "description": "Cand Just" }, "commission": { "type": "string", "description": "The commission value" }, "createdBy": { "type": "string", "description": "Created By" }, "createdDate": { "type": "string", "description": "Created Date" }, "currency": { "type": "string", "description": "The currency value" }, "currentLocation": { "type": "string", "description": "Current Location" }, "formDataId": { "type": "string", "description": "Form Data Id" }, "formTemplateId": { "type": "string", "description": "Form Template Id" }, "initialComment": { "type": "string", "description": "Initial Comment" }, "internalStatus": { "type": "string", "description": "Internal Status" }, "jobRateOfPay": { "type": "string", "description": "Job Rate Of Pay" }, "lastModifiedBy": { "type": "string", "description": "Last Modified By" }, "lastModifiedDate": { "type": "string", "description": "Last Modified Date" }, "location": { "type": "string", "description": "The location value" }, "monthly_cashPay": { "type": "string", "description": "Monthly Cash Pay" }, "monthly_FB": { "type": "string", "description": "Monthly FB" }, "monthly_gratuity": { "type": "string", "description": "Monthly Gratuity" }, "monthly_PF": { "type": "string", "description": "Monthly PF" }, "monthly_retirals": { "type": "string", "description": "Monthly Retirals" }, "monthly_SA": { "type": "string", "description": "Monthly SA" }, "monthly_salary": { "type": "string", "description": "Monthly Salary" }, "offerApprovalId": { "type": "string", "description": "Offer Approval Id" }, "redefineTemplateApprovers": { "type": "string", "description": "Redefine Template Approvers" }, "salaryBase": { "type": "string", "description": "Salary Base" }, "stockPackage": { "type": "string", "description": "Stock Package" }, "targetBonusAmount": { "type": "string", "description": "Target Bonus Amount" }, "tempDate": { "type": "string", "description": "Temp Date" }, "templateId": { "type": "string", "description": "Template Id" }, "total_earnings": { "type": "string", "description": "Total Earnings" }, "total_fixed_pay": { "type": "string", "description": "Total Fixed Pay" }, "version": { "type": "string", "description": "The version value" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_create\_job\_requisition Add new entity to JobRequisition **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------------------- | ------- | -------- | ------- | ----------------------------------------- | | `accommodation_cost` | string | No | — | Accommodation Cost | | `age` | string | No | — | The age value | | `agency_fee` | string | No | — | Agency Fee | | `annual_cashPay` | string | No | — | Annual Cash Pay | | `annual_FB` | string | No | — | Annual FB | | `annual_gratuity` | string | No | — | Annual Gratuity | | `annual_PF` | string | No | — | Annual PF | | `annual_retirals` | string | No | — | Annual Retirals | | `annual_SA` | string | No | — | Annual SA | | `approver` | object | No | — | The approver value | | `appTemplateId` | string | No | — | App Template Id | | `assessRatingScaleName` | string | No | — | Assess Rating Scale Name | | `candidateProgress` | string | No | — | Candidate Progress | | `city` | string | No | — | The city value | | `classificationTime` | string | No | — | Classification Time | | `classificationType` | string | No | — | Classification Type | | `closedDateTime` | string | No | — | Closed Date Time | | `comment` | string | No | — | The comment value | | `commentEquip` | string | No | — | Comment Equip | | `commission` | string | No | — | The commission value | | `coordinator` | object | No | — | The coordinator value | | `corporatePosting` | boolean | No | — | Corporate Posting | | `costCenterId` | string | No | — | Cost Center Id | | `costOfHire` | string | No | — | Cost Of Hire | | `country` | string | No | — | The country value | | `createdDateTime` | string | No | — | Created Date Time | | `currency` | string | No | — | The currency value | | `currentOwner` | object | No | — | Current Owner | | `customString10` | string | No | — | Custom String10 | | `customString3` | string | No | — | Custom String3 | | `customString4` | string | No | — | Custom String4 | | `customString8` | string | No | — | Custom String8 | | `defaultLanguage` | string | No | — | Default Language | | `deleted` | string | No | — | The deleted value | | `department` | string | No | — | The department value | | `division` | string | No | — | The division value | | `erpAmount` | string | No | — | Erp Amount | | `facility` | string | No | — | The facility value | | `formDataId` | string | No | — | Form Data Id | | `formDueDate` | string | No | — | Form Due Date | | `function` | string | No | — | The function value | | `hiringManager` | object | No | — | Hiring Manager | | `hiringManagerNote` | string | No | — | Hiring Manager Note | | `hiringManagerTeam` | object | No | — | Hiring Manager Team | | `hiringManagerTeamGroup` | object | No | — | Hiring Manager Team Group | | `industry` | string | No | — | The industry value | | `instr_rec_cost` | string | No | — | Instr Rec Cost | | `instrCostHire` | string | No | — | Instr Cost Hire | | `instrEquest` | string | No | — | Instr Equest | | `instrEquipment` | string | No | — | Instr Equipment | | `instrERS` | string | No | — | Instr ERS | | `instrInterview` | string | No | — | Instr Interview | | `instrInvolvedParties` | string | No | — | Instr Involved Parties | | `instrManagernote` | string | No | — | Instr Managernote | | `instrOverallComments` | string | No | — | Instr Overall Comments | | `instrPD` | string | No | — | Instr PD | | `instrReq` | string | No | — | Instr Req | | `instrReqDates` | string | No | — | Instr Req Dates | | `instrReqDetails` | string | No | — | Instr Req Details | | `instrReqJustify` | string | No | — | Instr Req Justify | | `instrReqRequire` | string | No | — | Instr Req Require | | `instrSalary` | string | No | — | Instr Salary | | `internalStatus` | string | No | — | Internal Status | | `intranetPosting` | boolean | No | — | Intranet Posting | | `isDraft` | boolean | No | — | Is Draft | | `jobCode` | string | No | — | Job Code | | `jobReqGUId` | string | No | — | Job Req GU Id | | `jobReqId` | string | No | — | Job Req Id | | `jobReqLocale` | object | No | — | Job Req Locale | | `jobReqPostings` | object | No | — | Job Req Postings | | `jobReqScreeningQuestions` | object | No | — | Job Req Screening Questions | | `jobRole` | string | No | — | Job Role | | `jobStartDate` | string | No | — | Job Start Date | | `lastModifiedBy` | string | No | — | Last Modified By | | `lastModifiedDateTime` | string | No | — | Last Modified Date Time | | `lastModifiedProxyUserId` | string | No | — | Last Modified Proxy User Id | | `legentity` | string | No | — | The legentity value | | `location` | string | No | — | The location value | | `misc_cost` | string | No | — | Misc Cost | | `monthly_cashPay` | string | No | — | Monthly Cash Pay | | `monthly_FB` | string | No | — | Monthly FB | | `monthly_gratuity` | string | No | — | Monthly Gratuity | | `monthly_PF` | string | No | — | Monthly PF | | `monthly_retirals` | string | No | — | Monthly Retirals | | `monthly_SA` | string | No | — | Monthly SA | | `monthly_salary` | string | No | — | Monthly Salary | | `numberOpenings` | string | No | — | Number Openings | | `openingsFilled` | string | No | — | Openings Filled | | `originator` | object | No | — | The originator value | | `otherBonus` | string | No | — | Other Bonus | | `otherCompensation` | string | No | — | Other Compensation | | `otherEquip` | string | No | — | Other Equip | | `othrComms` | string | No | — | Othr Comms | | `overallScaleName` | string | No | — | Overall Scale Name | | `positionNumber` | string | No | — | Position Number | | `postalcode` | string | No | — | The postalcode value | | `questions` | object | No | — | The questions value | | `ratedApplicantCount` | string | No | — | Rated Applicant Count | | `recruiter` | object | No | — | The recruiter value | | `recruiterTeam` | object | No | — | Recruiter Team | | `recruiterTeamGroup` | object | No | — | Recruiter Team Group | | `recruitJust` | string | No | — | Recruit Just | | `replforwhom` | string | No | — | The replforwhom value | | `restorehiringManagerTeamAdminDefaults` | boolean | No | — | Restorehiring Manager Team Admin Defaults | | `restorerecruiterTeamAdminDefaults` | boolean | No | — | Restorerecruiter Team Admin Defaults | | `restoresourcerTeamAdminDefaults` | boolean | No | — | Restoresourcer Team Admin Defaults | | `restorevpOfStaffingTeamAdminDefaults` | boolean | No | — | Restorevp Of Staffing Team Admin Defaults | | `reverseScale` | string | No | — | Reverse Scale | | `salaryBase` | string | No | — | Salary Base | | `salaryComment` | string | No | — | Salary Comment | | `salaryMax` | string | No | — | Salary Max | | `salaryMin` | string | No | — | Salary Min | | `salRateType` | string | No | — | Sal Rate Type | | `secondRecruiter` | object | No | — | Second Recruiter | | `sourcer` | object | No | — | The sourcer value | | `sourcerTeam` | object | No | — | Sourcer Team | | `sourcerTeamGroup` | object | No | — | Sourcer Team Group | | `stateProvince` | string | No | — | State Province | | `statusSetId` | string | No | — | Status Set Id | | `std_position_objlist` | any\[] | No | — | Std Position Objlist | | `stockPackage` | string | No | — | Stock Package | | `targetBonusAmount` | string | No | — | Target Bonus Amount | | `tempDate` | string | No | — | Temp Date | | `templateId` | string | No | — | Template Id | | `templateType` | string | No | — | Template Type | | `timeToFill` | string | No | — | Time To Fill | | `total_earnings` | string | No | — | Total Earnings | | `total_fixed_pay` | string | No | — | Total Fixed Pay | | `total_hire_cost` | string | No | — | Total Hire Cost | | `travel_cost` | string | No | — | Travel Cost | | `vpOfStaffing` | object | No | — | Vp Of Staffing | | `vpOfStaffingTeam` | object | No | — | Vp Of Staffing Team | | `vpOfStaffingTeamGroup` | object | No | — | Vp Of Staffing Team Group | | `workHours` | string | No | — | Work Hours | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accommodation_cost": { "type": "string", "description": "Accommodation Cost" }, "age": { "type": "string", "description": "The age value" }, "agency_fee": { "type": "string", "description": "Agency Fee" }, "annual_cashPay": { "type": "string", "description": "Annual Cash Pay" }, "annual_FB": { "type": "string", "description": "Annual FB" }, "annual_gratuity": { "type": "string", "description": "Annual Gratuity" }, "annual_PF": { "type": "string", "description": "Annual PF" }, "annual_retirals": { "type": "string", "description": "Annual Retirals" }, "annual_SA": { "type": "string", "description": "Annual SA" }, "approver": { "type": "object", "description": "The approver value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "appTemplateId": { "type": "string", "description": "App Template Id" }, "assessRatingScaleName": { "type": "string", "description": "Assess Rating Scale Name" }, "candidateProgress": { "type": "string", "description": "Candidate Progress" }, "city": { "type": "string", "description": "The city value" }, "classificationTime": { "type": "string", "description": "Classification Time" }, "classificationType": { "type": "string", "description": "Classification Type" }, "closedDateTime": { "type": "string", "description": "Closed Date Time" }, "comment": { "type": "string", "description": "The comment value" }, "commentEquip": { "type": "string", "description": "Comment Equip" }, "commission": { "type": "string", "description": "The commission value" }, "coordinator": { "type": "object", "description": "The coordinator value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "corporatePosting": { "type": "boolean", "description": "Corporate Posting" }, "costCenterId": { "type": "string", "description": "Cost Center Id" }, "costOfHire": { "type": "string", "description": "Cost Of Hire" }, "country": { "type": "string", "description": "The country value" }, "createdDateTime": { "type": "string", "description": "Created Date Time" }, "currency": { "type": "string", "description": "The currency value" }, "currentOwner": { "type": "object", "description": "Current Owner", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "customString10": { "type": "string", "description": "Custom String10" }, "customString3": { "type": "string", "description": "Custom String3" }, "customString4": { "type": "string", "description": "Custom String4" }, "customString8": { "type": "string", "description": "Custom String8" }, "defaultLanguage": { "type": "string", "description": "Default Language" }, "deleted": { "type": "string", "description": "The deleted value" }, "department": { "type": "string", "description": "The department value" }, "division": { "type": "string", "description": "The division value" }, "erpAmount": { "type": "string", "description": "Erp Amount" }, "facility": { "type": "string", "description": "The facility value" }, "formDataId": { "type": "string", "description": "Form Data Id" }, "formDueDate": { "type": "string", "description": "Form Due Date" }, "function": { "type": "string", "description": "The function value" }, "hiringManager": { "type": "object", "description": "Hiring Manager", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "hiringManagerNote": { "type": "string", "description": "Hiring Manager Note" }, "hiringManagerTeam": { "type": "object", "description": "Hiring Manager Team", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "hiringManagerTeamGroup": { "type": "object", "description": "Hiring Manager Team Group", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "industry": { "type": "string", "description": "The industry value" }, "instr_rec_cost": { "type": "string", "description": "Instr Rec Cost" }, "instrCostHire": { "type": "string", "description": "Instr Cost Hire" }, "instrEquest": { "type": "string", "description": "Instr Equest" }, "instrEquipment": { "type": "string", "description": "Instr Equipment" }, "instrERS": { "type": "string", "description": "Instr ERS" }, "instrInterview": { "type": "string", "description": "Instr Interview" }, "instrInvolvedParties": { "type": "string", "description": "Instr Involved Parties" }, "instrManagernote": { "type": "string", "description": "Instr Managernote" }, "instrOverallComments": { "type": "string", "description": "Instr Overall Comments" }, "instrPD": { "type": "string", "description": "Instr PD" }, "instrReq": { "type": "string", "description": "Instr Req" }, "instrReqDates": { "type": "string", "description": "Instr Req Dates" }, "instrReqDetails": { "type": "string", "description": "Instr Req Details" }, "instrReqJustify": { "type": "string", "description": "Instr Req Justify" }, "instrReqRequire": { "type": "string", "description": "Instr Req Require" }, "instrSalary": { "type": "string", "description": "Instr Salary" }, "internalStatus": { "type": "string", "description": "Internal Status" }, "intranetPosting": { "type": "boolean", "description": "Intranet Posting" }, "isDraft": { "type": "boolean", "description": "Is Draft" }, "jobCode": { "type": "string", "description": "Job Code" }, "jobReqGUId": { "type": "string", "description": "Job Req GU Id" }, "jobReqId": { "type": "string", "description": "Job Req Id" }, "jobReqLocale": { "type": "object", "description": "Job Req Locale", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobReqPostings": { "type": "object", "description": "Job Req Postings", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobReqScreeningQuestions": { "type": "object", "description": "Job Req Screening Questions", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobRole": { "type": "string", "description": "Job Role" }, "jobStartDate": { "type": "string", "description": "Job Start Date" }, "lastModifiedBy": { "type": "string", "description": "Last Modified By" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "lastModifiedProxyUserId": { "type": "string", "description": "Last Modified Proxy User Id" }, "legentity": { "type": "string", "description": "The legentity value" }, "location": { "type": "string", "description": "The location value" }, "misc_cost": { "type": "string", "description": "Misc Cost" }, "monthly_cashPay": { "type": "string", "description": "Monthly Cash Pay" }, "monthly_FB": { "type": "string", "description": "Monthly FB" }, "monthly_gratuity": { "type": "string", "description": "Monthly Gratuity" }, "monthly_PF": { "type": "string", "description": "Monthly PF" }, "monthly_retirals": { "type": "string", "description": "Monthly Retirals" }, "monthly_SA": { "type": "string", "description": "Monthly SA" }, "monthly_salary": { "type": "string", "description": "Monthly Salary" }, "numberOpenings": { "type": "string", "description": "Number Openings" }, "openingsFilled": { "type": "string", "description": "Openings Filled" }, "originator": { "type": "object", "description": "The originator value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "otherBonus": { "type": "string", "description": "Other Bonus" }, "otherCompensation": { "type": "string", "description": "Other Compensation" }, "otherEquip": { "type": "string", "description": "Other Equip" }, "othrComms": { "type": "string", "description": "Othr Comms" }, "overallScaleName": { "type": "string", "description": "Overall Scale Name" }, "positionNumber": { "type": "string", "description": "Position Number" }, "postalcode": { "type": "string", "description": "The postalcode value" }, "questions": { "type": "object", "description": "The questions value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "ratedApplicantCount": { "type": "string", "description": "Rated Applicant Count" }, "recruiter": { "type": "object", "description": "The recruiter value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "recruiterTeam": { "type": "object", "description": "Recruiter Team", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "recruiterTeamGroup": { "type": "object", "description": "Recruiter Team Group", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "recruitJust": { "type": "string", "description": "Recruit Just" }, "replforwhom": { "type": "string", "description": "The replforwhom value" }, "restorehiringManagerTeamAdminDefaults": { "type": "boolean", "description": "Restorehiring Manager Team Admin Defaults" }, "restorerecruiterTeamAdminDefaults": { "type": "boolean", "description": "Restorerecruiter Team Admin Defaults" }, "restoresourcerTeamAdminDefaults": { "type": "boolean", "description": "Restoresourcer Team Admin Defaults" }, "restorevpOfStaffingTeamAdminDefaults": { "type": "boolean", "description": "Restorevp Of Staffing Team Admin Defaults" }, "reverseScale": { "type": "string", "description": "Reverse Scale" }, "salaryBase": { "type": "string", "description": "Salary Base" }, "salaryComment": { "type": "string", "description": "Salary Comment" }, "salaryMax": { "type": "string", "description": "Salary Max" }, "salaryMin": { "type": "string", "description": "Salary Min" }, "salRateType": { "type": "string", "description": "Sal Rate Type" }, "secondRecruiter": { "type": "object", "description": "Second Recruiter", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "sourcer": { "type": "object", "description": "The sourcer value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "sourcerTeam": { "type": "object", "description": "Sourcer Team", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "sourcerTeamGroup": { "type": "object", "description": "Sourcer Team Group", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "stateProvince": { "type": "string", "description": "State Province" }, "statusSetId": { "type": "string", "description": "Status Set Id" }, "std_position_objlist": { "type": "array", "description": "Std Position Objlist" }, "stockPackage": { "type": "string", "description": "Stock Package" }, "targetBonusAmount": { "type": "string", "description": "Target Bonus Amount" }, "tempDate": { "type": "string", "description": "Temp Date" }, "templateId": { "type": "string", "description": "Template Id" }, "templateType": { "type": "string", "description": "Template Type" }, "timeToFill": { "type": "string", "description": "Time To Fill" }, "total_earnings": { "type": "string", "description": "Total Earnings" }, "total_fixed_pay": { "type": "string", "description": "Total Fixed Pay" }, "total_hire_cost": { "type": "string", "description": "Total Hire Cost" }, "travel_cost": { "type": "string", "description": "Travel Cost" }, "vpOfStaffing": { "type": "object", "description": "Vp Of Staffing", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "vpOfStaffingTeam": { "type": "object", "description": "Vp Of Staffing Team", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "vpOfStaffingTeamGroup": { "type": "object", "description": "Vp Of Staffing Team Group", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "workHours": { "type": "string", "description": "Work Hours" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_create\_job\_requisition\_std\_position\_objlist Add new entity to related std\_position\_objlist **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------ | | `externalCode` | string | No | — | External Code | | `fieldName` | string | No | — | Field Name | | `isPrimary` | boolean | No | — | Is Primary | | `jobReqId` | integer | No | — | Job Req Id | | `jobReqMultiSelectId` | integer | No | — | Job Req Multi Select Id | | `parentFieldValue` | integer | No | — | Parent Field Value | | `value` | object | No | — | Circular schema reference: #/components/schemas/SFOData.JobReqGOPosition | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "externalCode": { "type": "string", "description": "External Code" }, "fieldName": { "type": "string", "description": "Field Name" }, "isPrimary": { "type": "boolean", "description": "Is Primary" }, "jobReqId": { "type": "integer", "description": "Job Req Id" }, "jobReqMultiSelectId": { "type": "integer", "description": "Job Req Multi Select Id" }, "parentFieldValue": { "type": "integer", "description": "Parent Field Value" }, "value": { "type": "object", "description": "Circular schema reference: #/components/schemas/SFOData.JobReqGOPosition" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_create\_offer\_letter Add new entity to OfferLetter **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------ | -------- | ------- | ----------------------- | | `applicationId` | string | No | — | Application Id | | `body` | string | No | — | The body value | | `bodyLocale` | string | No | — | Body Locale | | `bodyTemplateId` | string | No | — | Body Template Id | | `bonusPayoutFreq` | string | No | — | Bonus Payout Freq | | `candResponseComments` | string | No | — | Cand Response Comments | | `candResponseDate` | string | No | — | Cand Response Date | | `comments` | string | No | — | The comments value | | `countryCode` | string | No | — | Country Code | | `countryName` | string | No | — | Country Name | | `createDate` | string | No | — | Create Date | | `createdBy` | string | No | — | Created By | | `currencyCode` | string | No | — | Currency Code | | `jobStartDate` | string | No | — | Job Start Date | | `jobTitle` | string | No | — | Job Title | | `lastModifiedBy` | string | No | — | Last Modified By | | `lastModifiedDate` | string | No | — | Last Modified Date | | `locale` | string | No | — | Locale or language code | | `localeCode` | string | No | — | Locale Code | | `mailboxes` | string | No | — | The mailboxes value | | `offerExpirationDate` | string | No | — | Offer Expiration Date | | `offerLetter` | string | No | — | Offer Letter | | `offerLetterId` | string | No | — | Offer Letter Id | | `offerSentDate` | string | No | — | Offer Sent Date | | `overtimeRate` | string | No | — | Overtime Rate | | `salaryRate` | string | No | — | Salary Rate | | `salaryRateType` | string | No | — | Salary Rate Type | | `sendMode` | string | No | — | Send Mode | | `status` | string | No | — | The status value | | `stockGrant` | string | No | — | Stock Grant | | `stockOption` | string | No | — | Stock Option | | `subject` | string | No | — | The subject value | | `targetBonusAmount` | string | No | — | Target Bonus Amount | | `targetBonusPercent` | string | No | — | Target Bonus Percent | | `templateId` | string | No | — | Template Id | | `templateName` | string | No | — | Template Name | | `tokens` | string | No | — | The tokens value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "applicationId": { "type": "string", "description": "Application Id" }, "body": { "type": "string", "description": "The body value" }, "bodyLocale": { "type": "string", "description": "Body Locale" }, "bodyTemplateId": { "type": "string", "description": "Body Template Id" }, "bonusPayoutFreq": { "type": "string", "description": "Bonus Payout Freq" }, "candResponseComments": { "type": "string", "description": "Cand Response Comments" }, "candResponseDate": { "type": "string", "description": "Cand Response Date" }, "comments": { "type": "string", "description": "The comments value" }, "countryCode": { "type": "string", "description": "Country Code" }, "countryName": { "type": "string", "description": "Country Name" }, "createDate": { "type": "string", "description": "Create Date" }, "createdBy": { "type": "string", "description": "Created By" }, "currencyCode": { "type": "string", "description": "Currency Code" }, "jobStartDate": { "type": "string", "description": "Job Start Date" }, "jobTitle": { "type": "string", "description": "Job Title" }, "lastModifiedBy": { "type": "string", "description": "Last Modified By" }, "lastModifiedDate": { "type": "string", "description": "Last Modified Date" }, "locale": { "type": "string", "description": "Locale or language code" }, "localeCode": { "type": "string", "description": "Locale Code" }, "mailboxes": { "type": "string", "description": "The mailboxes value" }, "offerExpirationDate": { "type": "string", "description": "Offer Expiration Date" }, "offerLetter": { "type": "string", "description": "Offer Letter" }, "offerLetterId": { "type": "string", "description": "Offer Letter Id" }, "offerSentDate": { "type": "string", "description": "Offer Sent Date" }, "overtimeRate": { "type": "string", "description": "Overtime Rate" }, "salaryRate": { "type": "string", "description": "Salary Rate" }, "salaryRateType": { "type": "string", "description": "Salary Rate Type" }, "sendMode": { "type": "string", "description": "Send Mode" }, "status": { "type": "string", "description": "The status value" }, "stockGrant": { "type": "string", "description": "Stock Grant" }, "stockOption": { "type": "string", "description": "Stock Option" }, "subject": { "type": "string", "description": "The subject value" }, "targetBonusAmount": { "type": "string", "description": "Target Bonus Amount" }, "targetBonusPercent": { "type": "string", "description": "Target Bonus Percent" }, "templateId": { "type": "string", "description": "Template Id" }, "templateName": { "type": "string", "description": "Template Name" }, "tokens": { "type": "string", "description": "The tokens value" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_delete\_job\_application\_interview Delete entity from JobApplicationInterview **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------- | -------- | ------- | --------------------------- | | `applicationInterviewId` | integer | Yes | — | key: applicationInterviewId | | `If-Match` | string | No | — | ETag | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "applicationInterviewId": { "type": "integer", "description": "key: applicationInterviewId" }, "If-Match": { "type": "string", "description": "ETag" } }, "required": [ "PCID", "applicationInterviewId" ] } ``` *** ## sap\_successfactors\_recruiting\_delete\_job\_offer Delete entity from JobOffer **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | -------------------- | | `offerApprovalId` | integer | Yes | — | key: offerApprovalId | | `If-Match` | string | No | — | ETag | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offerApprovalId": { "type": "integer", "description": "key: offerApprovalId" }, "If-Match": { "type": "string", "description": "ETag" } }, "required": [ "PCID", "offerApprovalId" ] } ``` *** ## sap\_successfactors\_recruiting\_delete\_job\_requisition Delete entity from JobRequisition **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ------------- | | `jobReqId` | integer | Yes | — | key: jobReqId | | `If-Match` | string | No | — | ETag | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobReqId": { "type": "integer", "description": "key: jobReqId" }, "If-Match": { "type": "string", "description": "ETag" } }, "required": [ "PCID", "jobReqId" ] } ``` *** ## sap\_successfactors\_recruiting\_delete\_offer\_letter Delete entity from OfferLetter **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | ------------------ | | `offerLetterId` | integer | Yes | — | key: offerLetterId | | `If-Match` | string | No | — | ETag | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offerLetterId": { "type": "integer", "description": "key: offerLetterId" }, "If-Match": { "type": "string", "description": "ETag" } }, "required": [ "PCID", "offerLetterId" ] } ``` *** ## sap\_successfactors\_recruiting\_get\_candidate Get entity from Candidate by key **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `candidateId` | integer | Yes | — | key: candidateId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "candidateId": { "type": "integer", "description": "key: candidateId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "address", "address2", "agreeToPrivacyStatement", "anonymized", "anonymizedDateTime", "candidateId", "candidateLocale", "cellPhone", "city", "contactEmail", "country", "creationDateTime", "currentTitle", "dataPrivacyId", "dateofAvailability", "externalCandidate", "firstName", "homePhone", "lastLoginDateTime", "lastModifiedDateTime", "lastName", "middleName", "partnerMemberId", "partnerSource", "password", "primaryEmail", "privacyAcceptDateTime", "publicIntranet", "shareProfile", "usersSysId", "visibilityOption", "zip" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "candidateProfileExtension", "certificates", "education", "insideWorkExperience", "languages", "outsideWorkExperience", "tags", "talentPool", "talentPoolcorp" ] }, "description": "Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)" } }, "required": [ "PCID", "candidateId" ] } ``` *** ## sap\_successfactors\_recruiting\_get\_candidate\_background\_education Get entity from CandidateBackground\_Education by key **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "bgOrderPos", "candidateId", "degree", "degreeDate", "endDate", "lastModifiedDateTime", "major", "presentStudent", "school", "schoolAddress", "schoolCity", "schoolCountry", "schoolPhone", "schoolState", "schoolType", "schoolZip", "startDate" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "candidate" ] }, "description": "Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)" } }, "required": [ "PCID", "backgroundElementId" ] } ``` *** ## sap\_successfactors\_recruiting\_get\_candidate\_background\_inside\_work\_experience Get entity from CandidateBackground\_InsideWorkExperience by key **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "bgOrderPos", "candidateId", "department", "endDate", "lastModifiedDateTime", "startDate", "title" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "candidate" ] }, "description": "Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)" } }, "required": [ "PCID", "backgroundElementId" ] } ``` *** ## sap\_successfactors\_recruiting\_get\_candidate\_background\_outside\_work\_experience Get entity from CandidateBackground\_OutsideWorkExperience by key **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "bgOrderPos", "businessType", "candidateId", "employer", "employerAddress", "employerCity", "employerContact", "employerCountry", "employerEmail", "employerPhone", "employerState", "employerZip", "endDate", "lastModifiedDateTime", "presentEmployer", "startDate", "startTitle" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "candidate" ] }, "description": "Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)" } }, "required": [ "PCID", "backgroundElementId" ] } ``` *** ## sap\_successfactors\_recruiting\_get\_job\_application Get entity from JobApplication by key **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `applicationId` | integer | Yes | — | key: applicationId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "applicationId": { "type": "integer", "description": "key: applicationId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "address", "address2", "agencyInfo", "anonymizedDate", "anonymizedFlag", "appLocale", "appStatusSetItemId", "applicationId", "applicationTemplateId", "averageRating", "baseSalary", "candConversionProcessed", "candJust", "candTypeWhenHired", "candidateId", "cellPhone", "city", "confnumber", "contactEmail", "conviction_details", "country", "countryCode", "criminalconvictionlabel", "crimincalconvictioninstructions", "currentLocation", "currentTitle", "cust_refCheckFirstName", "cust_refCheckLastName", "cust_refCheckOrg1", "cust_refCheckPhone1", "cust_refCheckTitle1", "dataSource", "dateAvail", "dateOfBirth", "duplicateProfile", "exportedOn", "extTitle", "firstName", "formerEmployee", "gender", "haveyoubeenconvicted", "hireDate", "hiredOn", "homePhone", "inductionAdd", "inductionDate", "initials", "instrAppReturn", "instrCandApproval", "instrCandAssess", "instrCandFields", "instrCandScreen", "instrWotc", "instr_AdditionalDocuments", "instr_AppAdditionalInfo", "instr_AppAdvice", "instr_CandAppDetails", "instr_CandPersInfo", "instr_EEOinstructions", "instr_EEOlable", "instrubkgrndChkAttachment", "jobAppGuid", "jobCode", "jobRateOfPay", "jobReqId", "jobStartDate", "jobofferdate", "knownAs", "lastModifiedBy", "lastModifiedByProxy", "lastModifiedDateTime", "lastName", "medDate", "medLoc", "medTime", "middleName", "nonApplicantStatus", "owner", "ownershpDate", "phoneScreenDate", "phoneScreenDetails", "pleaseselect", "posTitle", "profileUpdated", "psychTestDte", "psychTestTme", "rating", "reasonableaccomodation", "reference", "referenceComments", "referredBy", "resumeUploadDate", "screendate", "snapShotDate", "source", "sourceLabel", "ssn", "startDate", "stateOther", "status", "statusComments", "timeToHire", "title", "usersSysId", "visaNum", "voluntaryselfID", "whyask", "wotcFormsURL", "wotcId", "wotcScreeningURL", "wotcStatus", "yesanswer", "zip" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "jobAppStatus", "jobApplicationAssessmentOrder", "jobApplicationAssessmentOrder_1", "jobApplicationComments", "jobApplicationOnboardingData", "jobApplicationQuestionResponse", "jobApplicationStatusAuditTrail" ] }, "description": "Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)" } }, "required": [ "PCID", "applicationId" ] } ``` *** ## sap\_successfactors\_recruiting\_get\_job\_application\_interview Get entity from JobApplicationInterview by key **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `applicationInterviewId` | integer | Yes | — | key: applicationInterviewId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "applicationInterviewId": { "type": "integer", "description": "key: applicationInterviewId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "applicationId", "applicationInterviewId", "candSlotMapId", "endDate", "isTimeSet", "notes", "recruitEventStaffId", "source", "startDate", "status", "templateType" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "interviewOverallAssessment" ] }, "description": "Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)" } }, "required": [ "PCID", "applicationInterviewId" ] } ``` *** ## sap\_successfactors\_recruiting\_get\_job\_offer Get entity from JobOffer by key **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `offerApprovalId` | integer | Yes | — | key: offerApprovalId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offerApprovalId": { "type": "integer", "description": "key: offerApprovalId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "annual_FB", "annual_PF", "annual_SA", "annual_cashPay", "annual_gratuity", "annual_retirals", "anonymizedDate", "anonymizedFlag", "applicationId", "candJust", "candidateName", "commission", "createdBy", "createdDate", "currency", "currentLocation", "formDataId", "formTemplateId", "initialComment", "internalStatus", "jobRateOfPay", "lastModifiedBy", "lastModifiedDate", "location", "monthly_FB", "monthly_PF", "monthly_SA", "monthly_cashPay", "monthly_gratuity", "monthly_retirals", "monthly_salary", "offerApprovalId", "redefineTemplateApprovers", "salaryBase", "stockPackage", "targetBonusAmount", "tempDate", "templateId", "total_earnings", "total_fixed_pay", "version" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "approvers" ] }, "description": "Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)" } }, "required": [ "PCID", "offerApprovalId" ] } ``` *** ## sap\_successfactors\_recruiting\_get\_job\_req\_question Get entity from JobReqQuestion by key **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `questionId` | integer | Yes | — | key: questionId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "questionId": { "type": "integer", "description": "key: questionId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "questionCategory", "questionId", "questionName", "questionSource", "questionType" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" } }, "required": [ "PCID", "questionId" ] } ``` *** ## sap\_successfactors\_recruiting\_get\_job\_requisition Get entity from JobRequisition by key **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `jobReqId` | integer | Yes | — | key: jobReqId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobReqId": { "type": "integer", "description": "key: jobReqId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "accommodation_cost", "age", "agency_fee", "annual_FB", "annual_PF", "annual_SA", "annual_cashPay", "annual_gratuity", "annual_retirals", "appTemplateId", "assessRatingScaleName", "candidateProgress", "city", "classificationTime", "classificationType", "closedDateTime", "comment", "commentEquip", "commission", "corporatePosting", "costCenterId", "costOfHire", "country", "createdDateTime", "currency", "customString10", "customString3", "customString4", "customString8", "defaultLanguage", "deleted", "department", "division", "erpAmount", "facility", "formDataId", "formDueDate", "function", "hiringManagerNote", "industry", "instrCostHire", "instrERS", "instrEquest", "instrEquipment", "instrInterview", "instrInvolvedParties", "instrManagernote", "instrOverallComments", "instrPD", "instrReq", "instrReqDates", "instrReqDetails", "instrReqJustify", "instrReqRequire", "instrSalary", "instr_rec_cost", "internalStatus", "intranetPosting", "isDraft", "jobCode", "jobReqGUId", "jobReqId", "jobRole", "jobStartDate", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedProxyUserId", "legentity", "location", "misc_cost", "monthly_FB", "monthly_PF", "monthly_SA", "monthly_cashPay", "monthly_gratuity", "monthly_retirals", "monthly_salary", "numberOpenings", "openingsFilled", "otherBonus", "otherCompensation", "otherEquip", "othrComms", "overallScaleName", "positionNumber", "postalcode", "ratedApplicantCount", "recruitJust", "replforwhom", "restorehiringManagerTeamAdminDefaults", "restorerecruiterTeamAdminDefaults", "restoresourcerTeamAdminDefaults", "restorevpOfStaffingTeamAdminDefaults", "reverseScale", "salRateType", "salaryBase", "salaryComment", "salaryMax", "salaryMin", "stateProvince", "statusSetId", "stockPackage", "targetBonusAmount", "tempDate", "templateId", "templateType", "timeToFill", "total_earnings", "total_fixed_pay", "total_hire_cost", "travel_cost", "workHours" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "approver", "coordinator", "currentOwner", "hiringManager", "hiringManagerTeam", "hiringManagerTeamGroup", "jobReqLocale", "jobReqPostings", "jobReqScreeningQuestions", "originator", "questions", "recruiter", "recruiterTeam", "recruiterTeamGroup", "secondRecruiter", "sourcer", "sourcerTeam", "sourcerTeamGroup", "vpOfStaffing", "vpOfStaffingTeam", "vpOfStaffingTeamGroup" ] }, "description": "Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)" } }, "required": [ "PCID", "jobReqId" ] } ``` *** ## sap\_successfactors\_recruiting\_get\_job\_requisition\_std\_position\_objlist Get entities from related std\_position\_objlist **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `jobReqId` | integer | Yes | — | key: jobReqId | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625) | | `$count` | boolean | No | — | Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobReqId": { "type": "integer", "description": "key: jobReqId" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "externalCode", "externalCode desc", "fieldName", "fieldName desc", "isPrimary", "isPrimary desc", "jobReqId", "jobReqId desc", "jobReqMultiSelectId", "jobReqMultiSelectId desc", "parentFieldValue", "parentFieldValue desc" ] }, "description": "Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "externalCode", "fieldName", "isPrimary", "jobReqId", "jobReqMultiSelectId", "parentFieldValue" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "value" ] }, "description": "Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)" } }, "required": [ "PCID", "jobReqId" ] } ``` *** ## sap\_successfactors\_recruiting\_get\_offer\_letter Get entity from OfferLetter by key **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `offerLetterId` | integer | Yes | — | key: offerLetterId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offerLetterId": { "type": "integer", "description": "key: offerLetterId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "applicationId", "body", "bodyLocale", "bodyTemplateId", "bonusPayoutFreq", "candResponseComments", "candResponseDate", "comments", "countryCode", "countryName", "createDate", "createdBy", "currencyCode", "jobStartDate", "jobTitle", "lastModifiedBy", "lastModifiedDate", "locale", "localeCode", "mailboxes", "offerExpirationDate", "offerLetter", "offerLetterId", "offerSentDate", "overtimeRate", "salaryRate", "salaryRateType", "sendMode", "status", "stockGrant", "stockOption", "subject", "targetBonusAmount", "targetBonusPercent", "templateId", "templateName", "tokens" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" } }, "required": [ "PCID", "offerLetterId" ] } ``` *** ## sap\_successfactors\_recruiting\_list\_approve\_offer Invoke function approveOffer **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ----------------- | | `applicationId` | string | Yes | — | Application Id | | `comment` | string | Yes | — | The comment value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "applicationId": { "type": "string", "description": "Application Id" }, "comment": { "type": "string", "description": "The comment value" } }, "required": [ "PCID", "applicationId", "comment" ] } ``` *** ## sap\_successfactors\_recruiting\_list\_candidate Get entities from Candidate **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625) | | `$count` | boolean | No | — | Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "address", "address desc", "address2", "address2 desc", "agreeToPrivacyStatement", "agreeToPrivacyStatement desc", "anonymized", "anonymized desc", "anonymizedDateTime", "anonymizedDateTime desc", "candidateId", "candidateId desc", "candidateLocale", "candidateLocale desc", "cellPhone", "cellPhone desc", "city", "city desc", "contactEmail", "contactEmail desc", "country", "country desc", "creationDateTime", "creationDateTime desc", "currentTitle", "currentTitle desc", "dataPrivacyId", "dataPrivacyId desc", "dateofAvailability", "dateofAvailability desc", "externalCandidate", "externalCandidate desc", "firstName", "firstName desc", "homePhone", "homePhone desc", "lastLoginDateTime", "lastLoginDateTime desc", "lastModifiedDateTime", "lastModifiedDateTime desc", "lastName", "lastName desc", "middleName", "middleName desc", "partnerMemberId", "partnerMemberId desc", "partnerSource", "partnerSource desc", "password", "password desc", "primaryEmail", "primaryEmail desc", "privacyAcceptDateTime", "privacyAcceptDateTime desc", "publicIntranet", "publicIntranet desc", "shareProfile", "shareProfile desc", "usersSysId", "usersSysId desc", "visibilityOption", "visibilityOption desc", "zip", "zip desc" ] }, "description": "Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "address", "address2", "agreeToPrivacyStatement", "anonymized", "anonymizedDateTime", "candidateId", "candidateLocale", "cellPhone", "city", "contactEmail", "country", "creationDateTime", "currentTitle", "dataPrivacyId", "dateofAvailability", "externalCandidate", "firstName", "homePhone", "lastLoginDateTime", "lastModifiedDateTime", "lastName", "middleName", "partnerMemberId", "partnerSource", "password", "primaryEmail", "privacyAcceptDateTime", "publicIntranet", "shareProfile", "usersSysId", "visibilityOption", "zip" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "candidateProfileExtension", "certificates", "education", "insideWorkExperience", "languages", "outsideWorkExperience", "tags", "talentPool", "talentPoolcorp" ] }, "description": "Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_list\_candidate\_background\_education Get entities from CandidateBackground\_Education **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625) | | `$count` | boolean | No | — | Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "backgroundElementId desc", "bgOrderPos", "bgOrderPos desc", "candidateId", "candidateId desc", "degree", "degree desc", "degreeDate", "degreeDate desc", "endDate", "endDate desc", "lastModifiedDateTime", "lastModifiedDateTime desc", "major", "major desc", "presentStudent", "presentStudent desc", "school", "school desc", "schoolAddress", "schoolAddress desc", "schoolCity", "schoolCity desc", "schoolCountry", "schoolCountry desc", "schoolPhone", "schoolPhone desc", "schoolState", "schoolState desc", "schoolType", "schoolType desc", "schoolZip", "schoolZip desc", "startDate", "startDate desc" ] }, "description": "Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "bgOrderPos", "candidateId", "degree", "degreeDate", "endDate", "lastModifiedDateTime", "major", "presentStudent", "school", "schoolAddress", "schoolCity", "schoolCountry", "schoolPhone", "schoolState", "schoolType", "schoolZip", "startDate" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "candidate" ] }, "description": "Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_list\_candidate\_background\_inside\_work\_experience Get entities from CandidateBackground\_InsideWorkExperience **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625) | | `$count` | boolean | No | — | Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "backgroundElementId desc", "bgOrderPos", "bgOrderPos desc", "candidateId", "candidateId desc", "department", "department desc", "endDate", "endDate desc", "lastModifiedDateTime", "lastModifiedDateTime desc", "startDate", "startDate desc", "title", "title desc" ] }, "description": "Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "bgOrderPos", "candidateId", "department", "endDate", "lastModifiedDateTime", "startDate", "title" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "candidate" ] }, "description": "Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_list\_candidate\_background\_outside\_work\_experience Get entities from CandidateBackground\_OutsideWorkExperience **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625) | | `$count` | boolean | No | — | Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "backgroundElementId desc", "bgOrderPos", "bgOrderPos desc", "businessType", "businessType desc", "candidateId", "candidateId desc", "employer", "employer desc", "employerAddress", "employerAddress desc", "employerCity", "employerCity desc", "employerContact", "employerContact desc", "employerCountry", "employerCountry desc", "employerEmail", "employerEmail desc", "employerPhone", "employerPhone desc", "employerState", "employerState desc", "employerZip", "employerZip desc", "endDate", "endDate desc", "lastModifiedDateTime", "lastModifiedDateTime desc", "presentEmployer", "presentEmployer desc", "startDate", "startDate desc", "startTitle", "startTitle desc" ] }, "description": "Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "bgOrderPos", "businessType", "candidateId", "employer", "employerAddress", "employerCity", "employerContact", "employerCountry", "employerEmail", "employerPhone", "employerState", "employerZip", "endDate", "lastModifiedDateTime", "presentEmployer", "startDate", "startTitle" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "candidate" ] }, "description": "Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_list\_decline\_offer Invoke function declineOffer **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ----------------- | | `applicationId` | string | Yes | — | Application Id | | `comment` | string | Yes | — | The comment value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "applicationId": { "type": "string", "description": "Application Id" }, "comment": { "type": "string", "description": "The comment value" } }, "required": [ "PCID", "applicationId", "comment" ] } ``` *** ## sap\_successfactors\_recruiting\_list\_job\_application Get entities from JobApplication **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625) | | `$count` | boolean | No | — | Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "address", "address desc", "address2", "address2 desc", "agencyInfo", "agencyInfo desc", "anonymizedDate", "anonymizedDate desc", "anonymizedFlag", "anonymizedFlag desc", "appLocale", "appLocale desc", "appStatusSetItemId", "appStatusSetItemId desc", "applicationId", "applicationId desc", "applicationTemplateId", "applicationTemplateId desc", "averageRating", "averageRating desc", "baseSalary", "baseSalary desc", "candConversionProcessed", "candConversionProcessed desc", "candJust", "candJust desc", "candTypeWhenHired", "candTypeWhenHired desc", "candidateId", "candidateId desc", "cellPhone", "cellPhone desc", "city", "city desc", "confnumber", "confnumber desc", "contactEmail", "contactEmail desc", "conviction_details", "conviction_details desc", "country", "country desc", "countryCode", "countryCode desc", "criminalconvictionlabel", "criminalconvictionlabel desc", "crimincalconvictioninstructions", "crimincalconvictioninstructions desc", "currentLocation", "currentLocation desc", "currentTitle", "currentTitle desc", "cust_refCheckFirstName", "cust_refCheckFirstName desc", "cust_refCheckLastName", "cust_refCheckLastName desc", "cust_refCheckOrg1", "cust_refCheckOrg1 desc", "cust_refCheckPhone1", "cust_refCheckPhone1 desc", "cust_refCheckTitle1", "cust_refCheckTitle1 desc", "dataSource", "dataSource desc", "dateAvail", "dateAvail desc", "dateOfBirth", "dateOfBirth desc", "duplicateProfile", "duplicateProfile desc", "exportedOn", "exportedOn desc", "extTitle", "extTitle desc", "firstName", "firstName desc", "formerEmployee", "formerEmployee desc", "gender", "gender desc", "haveyoubeenconvicted", "haveyoubeenconvicted desc", "hireDate", "hireDate desc", "hiredOn", "hiredOn desc", "homePhone", "homePhone desc", "inductionAdd", "inductionAdd desc", "inductionDate", "inductionDate desc", "initials", "initials desc", "instrAppReturn", "instrAppReturn desc", "instrCandApproval", "instrCandApproval desc", "instrCandAssess", "instrCandAssess desc", "instrCandFields", "instrCandFields desc", "instrCandScreen", "instrCandScreen desc", "instrWotc", "instrWotc desc", "instr_AdditionalDocuments", "instr_AdditionalDocuments desc", "instr_AppAdditionalInfo", "instr_AppAdditionalInfo desc", "instr_AppAdvice", "instr_AppAdvice desc", "instr_CandAppDetails", "instr_CandAppDetails desc", "instr_CandPersInfo", "instr_CandPersInfo desc", "instr_EEOinstructions", "instr_EEOinstructions desc", "instr_EEOlable", "instr_EEOlable desc", "instrubkgrndChkAttachment", "instrubkgrndChkAttachment desc", "jobAppGuid", "jobAppGuid desc", "jobCode", "jobCode desc", "jobRateOfPay", "jobRateOfPay desc", "jobReqId", "jobReqId desc", "jobStartDate", "jobStartDate desc", "jobofferdate", "jobofferdate desc", "knownAs", "knownAs desc", "lastModifiedBy", "lastModifiedBy desc", "lastModifiedByProxy", "lastModifiedByProxy desc", "lastModifiedDateTime", "lastModifiedDateTime desc", "lastName", "lastName desc", "medDate", "medDate desc", "medLoc", "medLoc desc", "medTime", "medTime desc", "middleName", "middleName desc", "nonApplicantStatus", "nonApplicantStatus desc", "owner", "owner desc", "ownershpDate", "ownershpDate desc", "phoneScreenDate", "phoneScreenDate desc", "phoneScreenDetails", "phoneScreenDetails desc", "pleaseselect", "pleaseselect desc", "posTitle", "posTitle desc", "profileUpdated", "profileUpdated desc", "psychTestDte", "psychTestDte desc", "psychTestTme", "psychTestTme desc", "rating", "rating desc", "reasonableaccomodation", "reasonableaccomodation desc", "reference", "reference desc", "referenceComments", "referenceComments desc", "referredBy", "referredBy desc", "resumeUploadDate", "resumeUploadDate desc", "screendate", "screendate desc", "snapShotDate", "snapShotDate desc", "source", "source desc", "sourceLabel", "sourceLabel desc", "ssn", "ssn desc", "startDate", "startDate desc", "stateOther", "stateOther desc", "status", "status desc", "statusComments", "statusComments desc", "timeToHire", "timeToHire desc", "title", "title desc", "usersSysId", "usersSysId desc", "visaNum", "visaNum desc", "voluntaryselfID", "voluntaryselfID desc", "whyask", "whyask desc", "wotcFormsURL", "wotcFormsURL desc", "wotcId", "wotcId desc", "wotcScreeningURL", "wotcScreeningURL desc", "wotcStatus", "wotcStatus desc", "yesanswer", "yesanswer desc", "zip", "zip desc" ] }, "description": "Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "address", "address2", "agencyInfo", "anonymizedDate", "anonymizedFlag", "appLocale", "appStatusSetItemId", "applicationId", "applicationTemplateId", "averageRating", "baseSalary", "candConversionProcessed", "candJust", "candTypeWhenHired", "candidateId", "cellPhone", "city", "confnumber", "contactEmail", "conviction_details", "country", "countryCode", "criminalconvictionlabel", "crimincalconvictioninstructions", "currentLocation", "currentTitle", "cust_refCheckFirstName", "cust_refCheckLastName", "cust_refCheckOrg1", "cust_refCheckPhone1", "cust_refCheckTitle1", "dataSource", "dateAvail", "dateOfBirth", "duplicateProfile", "exportedOn", "extTitle", "firstName", "formerEmployee", "gender", "haveyoubeenconvicted", "hireDate", "hiredOn", "homePhone", "inductionAdd", "inductionDate", "initials", "instrAppReturn", "instrCandApproval", "instrCandAssess", "instrCandFields", "instrCandScreen", "instrWotc", "instr_AdditionalDocuments", "instr_AppAdditionalInfo", "instr_AppAdvice", "instr_CandAppDetails", "instr_CandPersInfo", "instr_EEOinstructions", "instr_EEOlable", "instrubkgrndChkAttachment", "jobAppGuid", "jobCode", "jobRateOfPay", "jobReqId", "jobStartDate", "jobofferdate", "knownAs", "lastModifiedBy", "lastModifiedByProxy", "lastModifiedDateTime", "lastName", "medDate", "medLoc", "medTime", "middleName", "nonApplicantStatus", "owner", "ownershpDate", "phoneScreenDate", "phoneScreenDetails", "pleaseselect", "posTitle", "profileUpdated", "psychTestDte", "psychTestTme", "rating", "reasonableaccomodation", "reference", "referenceComments", "referredBy", "resumeUploadDate", "screendate", "snapShotDate", "source", "sourceLabel", "ssn", "startDate", "stateOther", "status", "statusComments", "timeToHire", "title", "usersSysId", "visaNum", "voluntaryselfID", "whyask", "wotcFormsURL", "wotcId", "wotcScreeningURL", "wotcStatus", "yesanswer", "zip" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "jobAppStatus", "jobApplicationAssessmentOrder", "jobApplicationAssessmentOrder_1", "jobApplicationComments", "jobApplicationOnboardingData", "jobApplicationQuestionResponse", "jobApplicationStatusAuditTrail" ] }, "description": "Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_list\_job\_application\_interview Get entities from JobApplicationInterview **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625) | | `$count` | boolean | No | — | Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "applicationId", "applicationId desc", "applicationInterviewId", "applicationInterviewId desc", "candSlotMapId", "candSlotMapId desc", "endDate", "endDate desc", "isTimeSet", "isTimeSet desc", "notes", "notes desc", "recruitEventStaffId", "recruitEventStaffId desc", "source", "source desc", "startDate", "startDate desc", "status", "status desc", "templateType", "templateType desc" ] }, "description": "Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "applicationId", "applicationInterviewId", "candSlotMapId", "endDate", "isTimeSet", "notes", "recruitEventStaffId", "source", "startDate", "status", "templateType" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "interviewOverallAssessment" ] }, "description": "Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_list\_job\_offer Get entities from JobOffer **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625) | | `$count` | boolean | No | — | Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "annual_FB", "annual_FB desc", "annual_PF", "annual_PF desc", "annual_SA", "annual_SA desc", "annual_cashPay", "annual_cashPay desc", "annual_gratuity", "annual_gratuity desc", "annual_retirals", "annual_retirals desc", "anonymizedDate", "anonymizedDate desc", "anonymizedFlag", "anonymizedFlag desc", "applicationId", "applicationId desc", "candJust", "candJust desc", "candidateName", "candidateName desc", "commission", "commission desc", "createdBy", "createdBy desc", "createdDate", "createdDate desc", "currency", "currency desc", "currentLocation", "currentLocation desc", "formDataId", "formDataId desc", "formTemplateId", "formTemplateId desc", "initialComment", "initialComment desc", "internalStatus", "internalStatus desc", "jobRateOfPay", "jobRateOfPay desc", "lastModifiedBy", "lastModifiedBy desc", "lastModifiedDate", "lastModifiedDate desc", "location", "location desc", "monthly_FB", "monthly_FB desc", "monthly_PF", "monthly_PF desc", "monthly_SA", "monthly_SA desc", "monthly_cashPay", "monthly_cashPay desc", "monthly_gratuity", "monthly_gratuity desc", "monthly_retirals", "monthly_retirals desc", "monthly_salary", "monthly_salary desc", "offerApprovalId", "offerApprovalId desc", "redefineTemplateApprovers", "redefineTemplateApprovers desc", "salaryBase", "salaryBase desc", "stockPackage", "stockPackage desc", "targetBonusAmount", "targetBonusAmount desc", "tempDate", "tempDate desc", "templateId", "templateId desc", "total_earnings", "total_earnings desc", "total_fixed_pay", "total_fixed_pay desc", "version", "version desc" ] }, "description": "Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "annual_FB", "annual_PF", "annual_SA", "annual_cashPay", "annual_gratuity", "annual_retirals", "anonymizedDate", "anonymizedFlag", "applicationId", "candJust", "candidateName", "commission", "createdBy", "createdDate", "currency", "currentLocation", "formDataId", "formTemplateId", "initialComment", "internalStatus", "jobRateOfPay", "lastModifiedBy", "lastModifiedDate", "location", "monthly_FB", "monthly_PF", "monthly_SA", "monthly_cashPay", "monthly_gratuity", "monthly_retirals", "monthly_salary", "offerApprovalId", "redefineTemplateApprovers", "salaryBase", "stockPackage", "targetBonusAmount", "tempDate", "templateId", "total_earnings", "total_fixed_pay", "version" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "approvers" ] }, "description": "Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_list\_job\_req\_question Get entities from JobReqQuestion **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625) | | `$count` | boolean | No | — | Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "questionCategory", "questionCategory desc", "questionId", "questionId desc", "questionName", "questionName desc", "questionSource", "questionSource desc", "questionType", "questionType desc" ] }, "description": "Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "questionCategory", "questionId", "questionName", "questionSource", "questionType" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_list\_job\_requisition Get entities from JobRequisition **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625) | | `$count` | boolean | No | — | Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "accommodation_cost", "accommodation_cost desc", "age", "age desc", "agency_fee", "agency_fee desc", "annual_FB", "annual_FB desc", "annual_PF", "annual_PF desc", "annual_SA", "annual_SA desc", "annual_cashPay", "annual_cashPay desc", "annual_gratuity", "annual_gratuity desc", "annual_retirals", "annual_retirals desc", "appTemplateId", "appTemplateId desc", "assessRatingScaleName", "assessRatingScaleName desc", "candidateProgress", "candidateProgress desc", "city", "city desc", "classificationTime", "classificationTime desc", "classificationType", "classificationType desc", "closedDateTime", "closedDateTime desc", "comment", "comment desc", "commentEquip", "commentEquip desc", "commission", "commission desc", "corporatePosting", "corporatePosting desc", "costCenterId", "costCenterId desc", "costOfHire", "costOfHire desc", "country", "country desc", "createdDateTime", "createdDateTime desc", "currency", "currency desc", "customString10", "customString10 desc", "customString3", "customString3 desc", "customString4", "customString4 desc", "customString8", "customString8 desc", "defaultLanguage", "defaultLanguage desc", "deleted", "deleted desc", "department", "department desc", "division", "division desc", "erpAmount", "erpAmount desc", "facility", "facility desc", "formDataId", "formDataId desc", "formDueDate", "formDueDate desc", "function", "function desc", "hiringManagerNote", "hiringManagerNote desc", "industry", "industry desc", "instrCostHire", "instrCostHire desc", "instrERS", "instrERS desc", "instrEquest", "instrEquest desc", "instrEquipment", "instrEquipment desc", "instrInterview", "instrInterview desc", "instrInvolvedParties", "instrInvolvedParties desc", "instrManagernote", "instrManagernote desc", "instrOverallComments", "instrOverallComments desc", "instrPD", "instrPD desc", "instrReq", "instrReq desc", "instrReqDates", "instrReqDates desc", "instrReqDetails", "instrReqDetails desc", "instrReqJustify", "instrReqJustify desc", "instrReqRequire", "instrReqRequire desc", "instrSalary", "instrSalary desc", "instr_rec_cost", "instr_rec_cost desc", "internalStatus", "internalStatus desc", "intranetPosting", "intranetPosting desc", "isDraft", "isDraft desc", "jobCode", "jobCode desc", "jobReqGUId", "jobReqGUId desc", "jobReqId", "jobReqId desc", "jobRole", "jobRole desc", "jobStartDate", "jobStartDate desc", "lastModifiedBy", "lastModifiedBy desc", "lastModifiedDateTime", "lastModifiedDateTime desc", "lastModifiedProxyUserId", "lastModifiedProxyUserId desc", "legentity", "legentity desc", "location", "location desc", "misc_cost", "misc_cost desc", "monthly_FB", "monthly_FB desc", "monthly_PF", "monthly_PF desc", "monthly_SA", "monthly_SA desc", "monthly_cashPay", "monthly_cashPay desc", "monthly_gratuity", "monthly_gratuity desc", "monthly_retirals", "monthly_retirals desc", "monthly_salary", "monthly_salary desc", "numberOpenings", "numberOpenings desc", "openingsFilled", "openingsFilled desc", "otherBonus", "otherBonus desc", "otherCompensation", "otherCompensation desc", "otherEquip", "otherEquip desc", "othrComms", "othrComms desc", "overallScaleName", "overallScaleName desc", "positionNumber", "positionNumber desc", "postalcode", "postalcode desc", "ratedApplicantCount", "ratedApplicantCount desc", "recruitJust", "recruitJust desc", "replforwhom", "replforwhom desc", "restorehiringManagerTeamAdminDefaults", "restorehiringManagerTeamAdminDefaults desc", "restorerecruiterTeamAdminDefaults", "restorerecruiterTeamAdminDefaults desc", "restoresourcerTeamAdminDefaults", "restoresourcerTeamAdminDefaults desc", "restorevpOfStaffingTeamAdminDefaults", "restorevpOfStaffingTeamAdminDefaults desc", "reverseScale", "reverseScale desc", "salRateType", "salRateType desc", "salaryBase", "salaryBase desc", "salaryComment", "salaryComment desc", "salaryMax", "salaryMax desc", "salaryMin", "salaryMin desc", "stateProvince", "stateProvince desc", "statusSetId", "statusSetId desc", "stockPackage", "stockPackage desc", "targetBonusAmount", "targetBonusAmount desc", "tempDate", "tempDate desc", "templateId", "templateId desc", "templateType", "templateType desc", "timeToFill", "timeToFill desc", "total_earnings", "total_earnings desc", "total_fixed_pay", "total_fixed_pay desc", "total_hire_cost", "total_hire_cost desc", "travel_cost", "travel_cost desc", "workHours", "workHours desc" ] }, "description": "Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "accommodation_cost", "age", "agency_fee", "annual_FB", "annual_PF", "annual_SA", "annual_cashPay", "annual_gratuity", "annual_retirals", "appTemplateId", "assessRatingScaleName", "candidateProgress", "city", "classificationTime", "classificationType", "closedDateTime", "comment", "commentEquip", "commission", "corporatePosting", "costCenterId", "costOfHire", "country", "createdDateTime", "currency", "customString10", "customString3", "customString4", "customString8", "defaultLanguage", "deleted", "department", "division", "erpAmount", "facility", "formDataId", "formDueDate", "function", "hiringManagerNote", "industry", "instrCostHire", "instrERS", "instrEquest", "instrEquipment", "instrInterview", "instrInvolvedParties", "instrManagernote", "instrOverallComments", "instrPD", "instrReq", "instrReqDates", "instrReqDetails", "instrReqJustify", "instrReqRequire", "instrSalary", "instr_rec_cost", "internalStatus", "intranetPosting", "isDraft", "jobCode", "jobReqGUId", "jobReqId", "jobRole", "jobStartDate", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedProxyUserId", "legentity", "location", "misc_cost", "monthly_FB", "monthly_PF", "monthly_SA", "monthly_cashPay", "monthly_gratuity", "monthly_retirals", "monthly_salary", "numberOpenings", "openingsFilled", "otherBonus", "otherCompensation", "otherEquip", "othrComms", "overallScaleName", "positionNumber", "postalcode", "ratedApplicantCount", "recruitJust", "replforwhom", "restorehiringManagerTeamAdminDefaults", "restorerecruiterTeamAdminDefaults", "restoresourcerTeamAdminDefaults", "restorevpOfStaffingTeamAdminDefaults", "reverseScale", "salRateType", "salaryBase", "salaryComment", "salaryMax", "salaryMin", "stateProvince", "statusSetId", "stockPackage", "targetBonusAmount", "tempDate", "templateId", "templateType", "timeToFill", "total_earnings", "total_fixed_pay", "total_hire_cost", "travel_cost", "workHours" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "approver", "coordinator", "currentOwner", "hiringManager", "hiringManagerTeam", "hiringManagerTeamGroup", "jobReqLocale", "jobReqPostings", "jobReqScreeningQuestions", "originator", "questions", "recruiter", "recruiterTeam", "recruiterTeamGroup", "secondRecruiter", "sourcer", "sourcerTeam", "sourcerTeamGroup", "vpOfStaffing", "vpOfStaffingTeam", "vpOfStaffingTeamGroup" ] }, "description": "Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_list\_offer\_letter Get entities from OfferLetter **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625) | | `$count` | boolean | No | — | Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374630)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374631)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "applicationId", "applicationId desc", "body", "body desc", "bodyLocale", "bodyLocale desc", "bodyTemplateId", "bodyTemplateId desc", "bonusPayoutFreq", "bonusPayoutFreq desc", "candResponseComments", "candResponseComments desc", "candResponseDate", "candResponseDate desc", "comments", "comments desc", "countryCode", "countryCode desc", "countryName", "countryName desc", "createDate", "createDate desc", "createdBy", "createdBy desc", "currencyCode", "currencyCode desc", "jobStartDate", "jobStartDate desc", "jobTitle", "jobTitle desc", "lastModifiedBy", "lastModifiedBy desc", "lastModifiedDate", "lastModifiedDate desc", "locale", "locale desc", "localeCode", "localeCode desc", "mailboxes", "mailboxes desc", "offerExpirationDate", "offerExpirationDate desc", "offerLetter", "offerLetter desc", "offerLetterId", "offerLetterId desc", "offerSentDate", "offerSentDate desc", "overtimeRate", "overtimeRate desc", "salaryRate", "salaryRate desc", "salaryRateType", "salaryRateType desc", "sendMode", "sendMode desc", "status", "status desc", "stockGrant", "stockGrant desc", "stockOption", "stockOption desc", "subject", "subject desc", "targetBonusAmount", "targetBonusAmount desc", "targetBonusPercent", "targetBonusPercent desc", "templateId", "templateId desc", "templateName", "templateName desc", "tokens", "tokens desc" ] }, "description": "Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "applicationId", "body", "bodyLocale", "bodyTemplateId", "bonusPayoutFreq", "candResponseComments", "candResponseDate", "comments", "countryCode", "countryName", "createDate", "createdBy", "currencyCode", "jobStartDate", "jobTitle", "lastModifiedBy", "lastModifiedDate", "locale", "localeCode", "mailboxes", "offerExpirationDate", "offerLetter", "offerLetterId", "offerSentDate", "overtimeRate", "salaryRate", "salaryRateType", "sendMode", "status", "stockGrant", "stockOption", "subject", "targetBonusAmount", "targetBonusPercent", "templateId", "templateName", "tokens" ] }, "description": "Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_recruiting\_replace\_candidate Update entity in Candidate **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------- | ------- | -------- | ------- | --------------------------- | | `candidateId` | integer | Yes | — | key: candidateId | | `address` | string | No | — | The address value | | `address2` | string | No | — | The address2 value | | `agreeToPrivacyStatement` | string | No | — | Agree To Privacy Statement | | `anonymized` | string | No | — | The anonymized value | | `anonymizedDateTime` | string | No | — | Anonymized Date Time | | `candidateLocale` | string | No | — | Candidate Locale | | `candidateProfileExtension` | object | No | — | Candidate Profile Extension | | `cellPhone` | string | No | — | Cell Phone | | `certificates` | object | No | — | The certificates value | | `city` | string | No | — | The city value | | `contactEmail` | string | No | — | Contact Email | | `country` | string | No | — | The country value | | `creationDateTime` | string | No | — | Creation Date Time | | `currentTitle` | string | No | — | Current Title | | `dataPrivacyId` | string | No | — | Data Privacy Id | | `dateofAvailability` | string | No | — | Dateof Availability | | `education` | object | No | — | The education value | | `externalCandidate` | boolean | No | — | External Candidate | | `firstName` | string | No | — | First Name | | `homePhone` | string | No | — | Home Phone | | `insideWorkExperience` | object | No | — | Inside Work Experience | | `languages` | object | No | — | The languages value | | `lastLoginDateTime` | string | No | — | Last Login Date Time | | `lastModifiedDateTime` | string | No | — | Last Modified Date Time | | `lastName` | string | No | — | Last Name | | `middleName` | string | No | — | Middle Name | | `outsideWorkExperience` | object | No | — | Outside Work Experience | | `partnerMemberId` | string | No | — | Partner Member Id | | `partnerSource` | string | No | — | Partner Source | | `password` | string | No | — | The password value | | `primaryEmail` | string | No | — | Primary Email | | `privacyAcceptDateTime` | string | No | — | Privacy Accept Date Time | | `publicIntranet` | boolean | No | — | Public Intranet | | `shareProfile` | string | No | — | Share Profile | | `tags` | object | No | — | The tags value | | `talentPool` | object | No | — | Talent Pool | | `talentPoolcorp` | object | No | — | Talent Poolcorp | | `usersSysId` | string | No | — | Users Sys Id | | `visibilityOption` | boolean | No | — | Visibility Option | | `zip` | string | No | — | The zip value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "candidateId": { "type": "integer", "description": "key: candidateId" }, "address": { "type": "string", "description": "The address value" }, "address2": { "type": "string", "description": "The address2 value" }, "agreeToPrivacyStatement": { "type": "string", "description": "Agree To Privacy Statement" }, "anonymized": { "type": "string", "description": "The anonymized value" }, "anonymizedDateTime": { "type": "string", "description": "Anonymized Date Time" }, "candidateLocale": { "type": "string", "description": "Candidate Locale" }, "candidateProfileExtension": { "type": "object", "description": "Candidate Profile Extension", "properties": { "candidateId": { "type": "string", "description": "Candidate Id" }, "createdBy": { "type": "string", "description": "Created By" }, "createdDateTime": { "type": "string", "description": "Created Date Time" }, "lastModifiedBy": { "type": "string", "description": "Last Modified By" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "mdfSystemRecordStatus": { "type": "string", "description": "Mdf System Record Status" } } }, "cellPhone": { "type": "string", "description": "Cell Phone" }, "certificates": { "type": "object", "description": "The certificates value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "city": { "type": "string", "description": "The city value" }, "contactEmail": { "type": "string", "description": "Contact Email" }, "country": { "type": "string", "description": "The country value" }, "creationDateTime": { "type": "string", "description": "Creation Date Time" }, "currentTitle": { "type": "string", "description": "Current Title" }, "dataPrivacyId": { "type": "string", "description": "Data Privacy Id" }, "dateofAvailability": { "type": "string", "description": "Dateof Availability" }, "education": { "type": "object", "description": "The education value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "externalCandidate": { "type": "boolean", "description": "External Candidate" }, "firstName": { "type": "string", "description": "First Name" }, "homePhone": { "type": "string", "description": "Home Phone" }, "insideWorkExperience": { "type": "object", "description": "Inside Work Experience", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "languages": { "type": "object", "description": "The languages value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "lastLoginDateTime": { "type": "string", "description": "Last Login Date Time" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "lastName": { "type": "string", "description": "Last Name" }, "middleName": { "type": "string", "description": "Middle Name" }, "outsideWorkExperience": { "type": "object", "description": "Outside Work Experience", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "partnerMemberId": { "type": "string", "description": "Partner Member Id" }, "partnerSource": { "type": "string", "description": "Partner Source" }, "password": { "type": "string", "description": "The password value" }, "primaryEmail": { "type": "string", "description": "Primary Email" }, "privacyAcceptDateTime": { "type": "string", "description": "Privacy Accept Date Time" }, "publicIntranet": { "type": "boolean", "description": "Public Intranet" }, "shareProfile": { "type": "string", "description": "Share Profile" }, "tags": { "type": "object", "description": "The tags value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "talentPool": { "type": "object", "description": "Talent Pool", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "talentPoolcorp": { "type": "object", "description": "Talent Poolcorp", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "usersSysId": { "type": "string", "description": "Users Sys Id" }, "visibilityOption": { "type": "boolean", "description": "Visibility Option" }, "zip": { "type": "string", "description": "The zip value" } }, "required": [ "PCID", "candidateId" ] } ``` *** ## sap\_successfactors\_recruiting\_replace\_candidate\_background\_education Update entity in CandidateBackground\_Education **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ------------------------ | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `bgOrderPos` | string | No | — | Bg Order Pos | | `candidate` | object | No | — | The candidate value | | `candidateId` | string | No | — | Candidate Id | | `degree` | string | No | — | The degree value | | `degreeDate` | string | No | — | Degree Date | | `endDate` | string | No | — | End date for filtering | | `lastModifiedDateTime` | string | No | — | Last Modified Date Time | | `major` | string | No | — | The major value | | `presentStudent` | integer | No | — | Present Student | | `school` | string | No | — | The school value | | `schoolAddress` | string | No | — | School Address | | `schoolCity` | string | No | — | School City | | `schoolCountry` | string | No | — | School Country | | `schoolPhone` | string | No | — | School Phone | | `schoolState` | string | No | — | School State | | `schoolType` | string | No | — | School Type | | `schoolZip` | string | No | — | School Zip | | `startDate` | string | No | — | Start date for filtering | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "bgOrderPos": { "type": "string", "description": "Bg Order Pos" }, "candidate": { "type": "object", "description": "The candidate value", "properties": { "address": { "type": "string", "description": "The address value" }, "address2": { "type": "string", "description": "The address2 value" }, "agreeToPrivacyStatement": { "type": "string", "description": "Agree To Privacy Statement" }, "anonymized": { "type": "string", "description": "The anonymized value" }, "anonymizedDateTime": { "type": "string", "description": "Anonymized Date Time" }, "candidateId": { "type": "string", "description": "Candidate Id" }, "candidateLocale": { "type": "string", "description": "Candidate Locale" }, "cellPhone": { "type": "string", "description": "Cell Phone" }, "city": { "type": "string", "description": "The city value" }, "contactEmail": { "type": "string", "description": "Contact Email" }, "country": { "type": "string", "description": "The country value" }, "creationDateTime": { "type": "string", "description": "Creation Date Time" }, "currentTitle": { "type": "string", "description": "Current Title" }, "dataPrivacyId": { "type": "string", "description": "Data Privacy Id" }, "dateofAvailability": { "type": "string", "description": "Dateof Availability" }, "externalCandidate": { "type": "boolean", "description": "External Candidate" }, "firstName": { "type": "string", "description": "First Name" }, "homePhone": { "type": "string", "description": "Home Phone" }, "lastLoginDateTime": { "type": "string", "description": "Last Login Date Time" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "lastName": { "type": "string", "description": "Last Name" }, "middleName": { "type": "string", "description": "Middle Name" }, "partnerMemberId": { "type": "string", "description": "Partner Member Id" }, "partnerSource": { "type": "string", "description": "Partner Source" }, "password": { "type": "string", "description": "The password value" }, "primaryEmail": { "type": "string", "description": "Primary Email" }, "privacyAcceptDateTime": { "type": "string", "description": "Privacy Accept Date Time" }, "publicIntranet": { "type": "boolean", "description": "Public Intranet" }, "shareProfile": { "type": "string", "description": "Share Profile" }, "usersSysId": { "type": "string", "description": "Users Sys Id" }, "visibilityOption": { "type": "boolean", "description": "Visibility Option" }, "zip": { "type": "string", "description": "The zip value" }, "candidateProfileExtension": { "type": "object", "description": "Candidate Profile Extension" }, "certificates": { "type": "object", "description": "The certificates value" }, "education": { "type": "object", "description": "The education value" }, "insideWorkExperience": { "type": "object", "description": "Inside Work Experience" }, "languages": { "type": "object", "description": "The languages value" }, "outsideWorkExperience": { "type": "object", "description": "Outside Work Experience" }, "tags": { "type": "object", "description": "The tags value" }, "talentPool": { "type": "object", "description": "Talent Pool" }, "talentPoolcorp": { "type": "object", "description": "Talent Poolcorp" } } }, "candidateId": { "type": "string", "description": "Candidate Id" }, "degree": { "type": "string", "description": "The degree value" }, "degreeDate": { "type": "string", "description": "Degree Date" }, "endDate": { "type": "string", "description": "End date for filtering" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "major": { "type": "string", "description": "The major value" }, "presentStudent": { "type": "integer", "description": "Present Student" }, "school": { "type": "string", "description": "The school value" }, "schoolAddress": { "type": "string", "description": "School Address" }, "schoolCity": { "type": "string", "description": "School City" }, "schoolCountry": { "type": "string", "description": "School Country" }, "schoolPhone": { "type": "string", "description": "School Phone" }, "schoolState": { "type": "string", "description": "School State" }, "schoolType": { "type": "string", "description": "School Type" }, "schoolZip": { "type": "string", "description": "School Zip" }, "startDate": { "type": "string", "description": "Start date for filtering" } }, "required": [ "PCID", "backgroundElementId" ] } ``` *** ## sap\_successfactors\_recruiting\_replace\_candidate\_background\_inside\_work\_experience Update entity in CandidateBackground\_InsideWorkExperience **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ------------------------ | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `bgOrderPos` | string | No | — | Bg Order Pos | | `candidate` | object | No | — | The candidate value | | `candidateId` | string | No | — | Candidate Id | | `department` | string | No | — | The department value | | `endDate` | string | No | — | End date for filtering | | `lastModifiedDateTime` | string | No | — | Last Modified Date Time | | `startDate` | string | No | — | Start date for filtering | | `title` | string | No | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "bgOrderPos": { "type": "string", "description": "Bg Order Pos" }, "candidate": { "type": "object", "description": "The candidate value", "properties": { "address": { "type": "string", "description": "The address value" }, "address2": { "type": "string", "description": "The address2 value" }, "agreeToPrivacyStatement": { "type": "string", "description": "Agree To Privacy Statement" }, "anonymized": { "type": "string", "description": "The anonymized value" }, "anonymizedDateTime": { "type": "string", "description": "Anonymized Date Time" }, "candidateId": { "type": "string", "description": "Candidate Id" }, "candidateLocale": { "type": "string", "description": "Candidate Locale" }, "cellPhone": { "type": "string", "description": "Cell Phone" }, "city": { "type": "string", "description": "The city value" }, "contactEmail": { "type": "string", "description": "Contact Email" }, "country": { "type": "string", "description": "The country value" }, "creationDateTime": { "type": "string", "description": "Creation Date Time" }, "currentTitle": { "type": "string", "description": "Current Title" }, "dataPrivacyId": { "type": "string", "description": "Data Privacy Id" }, "dateofAvailability": { "type": "string", "description": "Dateof Availability" }, "externalCandidate": { "type": "boolean", "description": "External Candidate" }, "firstName": { "type": "string", "description": "First Name" }, "homePhone": { "type": "string", "description": "Home Phone" }, "lastLoginDateTime": { "type": "string", "description": "Last Login Date Time" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "lastName": { "type": "string", "description": "Last Name" }, "middleName": { "type": "string", "description": "Middle Name" }, "partnerMemberId": { "type": "string", "description": "Partner Member Id" }, "partnerSource": { "type": "string", "description": "Partner Source" }, "password": { "type": "string", "description": "The password value" }, "primaryEmail": { "type": "string", "description": "Primary Email" }, "privacyAcceptDateTime": { "type": "string", "description": "Privacy Accept Date Time" }, "publicIntranet": { "type": "boolean", "description": "Public Intranet" }, "shareProfile": { "type": "string", "description": "Share Profile" }, "usersSysId": { "type": "string", "description": "Users Sys Id" }, "visibilityOption": { "type": "boolean", "description": "Visibility Option" }, "zip": { "type": "string", "description": "The zip value" }, "candidateProfileExtension": { "type": "object", "description": "Candidate Profile Extension" }, "certificates": { "type": "object", "description": "The certificates value" }, "education": { "type": "object", "description": "The education value" }, "insideWorkExperience": { "type": "object", "description": "Inside Work Experience" }, "languages": { "type": "object", "description": "The languages value" }, "outsideWorkExperience": { "type": "object", "description": "Outside Work Experience" }, "tags": { "type": "object", "description": "The tags value" }, "talentPool": { "type": "object", "description": "Talent Pool" }, "talentPoolcorp": { "type": "object", "description": "Talent Poolcorp" } } }, "candidateId": { "type": "string", "description": "Candidate Id" }, "department": { "type": "string", "description": "The department value" }, "endDate": { "type": "string", "description": "End date for filtering" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "startDate": { "type": "string", "description": "Start date for filtering" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "backgroundElementId" ] } ``` *** ## sap\_successfactors\_recruiting\_replace\_candidate\_background\_outside\_work\_experience Update entity in CandidateBackground\_OutsideWorkExperience **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ------------------------ | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `bgOrderPos` | string | No | — | Bg Order Pos | | `businessType` | string | No | — | Business Type | | `candidate` | object | No | — | The candidate value | | `candidateId` | string | No | — | Candidate Id | | `employer` | string | No | — | The employer value | | `employerAddress` | string | No | — | Employer Address | | `employerCity` | string | No | — | Employer City | | `employerContact` | string | No | — | Employer Contact | | `employerCountry` | string | No | — | Employer Country | | `employerEmail` | string | No | — | Employer Email | | `employerPhone` | string | No | — | Employer Phone | | `employerState` | string | No | — | Employer State | | `employerZip` | string | No | — | Employer Zip | | `endDate` | string | No | — | End date for filtering | | `lastModifiedDateTime` | string | No | — | Last Modified Date Time | | `presentEmployer` | string | No | — | Present Employer | | `startDate` | string | No | — | Start date for filtering | | `startTitle` | string | No | — | Start Title | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "bgOrderPos": { "type": "string", "description": "Bg Order Pos" }, "businessType": { "type": "string", "description": "Business Type" }, "candidate": { "type": "object", "description": "The candidate value", "properties": { "address": { "type": "string", "description": "The address value" }, "address2": { "type": "string", "description": "The address2 value" }, "agreeToPrivacyStatement": { "type": "string", "description": "Agree To Privacy Statement" }, "anonymized": { "type": "string", "description": "The anonymized value" }, "anonymizedDateTime": { "type": "string", "description": "Anonymized Date Time" }, "candidateId": { "type": "string", "description": "Candidate Id" }, "candidateLocale": { "type": "string", "description": "Candidate Locale" }, "cellPhone": { "type": "string", "description": "Cell Phone" }, "city": { "type": "string", "description": "The city value" }, "contactEmail": { "type": "string", "description": "Contact Email" }, "country": { "type": "string", "description": "The country value" }, "creationDateTime": { "type": "string", "description": "Creation Date Time" }, "currentTitle": { "type": "string", "description": "Current Title" }, "dataPrivacyId": { "type": "string", "description": "Data Privacy Id" }, "dateofAvailability": { "type": "string", "description": "Dateof Availability" }, "externalCandidate": { "type": "boolean", "description": "External Candidate" }, "firstName": { "type": "string", "description": "First Name" }, "homePhone": { "type": "string", "description": "Home Phone" }, "lastLoginDateTime": { "type": "string", "description": "Last Login Date Time" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "lastName": { "type": "string", "description": "Last Name" }, "middleName": { "type": "string", "description": "Middle Name" }, "partnerMemberId": { "type": "string", "description": "Partner Member Id" }, "partnerSource": { "type": "string", "description": "Partner Source" }, "password": { "type": "string", "description": "The password value" }, "primaryEmail": { "type": "string", "description": "Primary Email" }, "privacyAcceptDateTime": { "type": "string", "description": "Privacy Accept Date Time" }, "publicIntranet": { "type": "boolean", "description": "Public Intranet" }, "shareProfile": { "type": "string", "description": "Share Profile" }, "usersSysId": { "type": "string", "description": "Users Sys Id" }, "visibilityOption": { "type": "boolean", "description": "Visibility Option" }, "zip": { "type": "string", "description": "The zip value" }, "candidateProfileExtension": { "type": "object", "description": "Candidate Profile Extension" }, "certificates": { "type": "object", "description": "The certificates value" }, "education": { "type": "object", "description": "The education value" }, "insideWorkExperience": { "type": "object", "description": "Inside Work Experience" }, "languages": { "type": "object", "description": "The languages value" }, "outsideWorkExperience": { "type": "object", "description": "Outside Work Experience" }, "tags": { "type": "object", "description": "The tags value" }, "talentPool": { "type": "object", "description": "Talent Pool" }, "talentPoolcorp": { "type": "object", "description": "Talent Poolcorp" } } }, "candidateId": { "type": "string", "description": "Candidate Id" }, "employer": { "type": "string", "description": "The employer value" }, "employerAddress": { "type": "string", "description": "Employer Address" }, "employerCity": { "type": "string", "description": "Employer City" }, "employerContact": { "type": "string", "description": "Employer Contact" }, "employerCountry": { "type": "string", "description": "Employer Country" }, "employerEmail": { "type": "string", "description": "Employer Email" }, "employerPhone": { "type": "string", "description": "Employer Phone" }, "employerState": { "type": "string", "description": "Employer State" }, "employerZip": { "type": "string", "description": "Employer Zip" }, "endDate": { "type": "string", "description": "End date for filtering" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "presentEmployer": { "type": "string", "description": "Present Employer" }, "startDate": { "type": "string", "description": "Start date for filtering" }, "startTitle": { "type": "string", "description": "Start Title" } }, "required": [ "PCID", "backgroundElementId" ] } ``` *** ## sap\_successfactors\_recruiting\_replace\_job\_application Update entity in JobApplication **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------------- | ------- | -------- | ------- | ----------------------------------------- | | `applicationId` | integer | Yes | — | key: applicationId | | `address` | string | No | — | The address value | | `address2` | string | No | — | The address2 value | | `agencyInfo` | string | No | — | Agency Info | | `anonymizedDate` | string | No | — | Anonymized Date | | `anonymizedFlag` | string | No | — | Anonymized Flag | | `applicationTemplateId` | string | No | — | Application Template Id | | `appLocale` | string | No | — | App Locale | | `appStatusSetItemId` | string | No | — | App Status Set Item Id | | `averageRating` | string | No | — | Average Rating | | `baseSalary` | string | No | — | Base Salary | | `candConversionProcessed` | string | No | — | Cand Conversion Processed | | `candidateId` | string | No | — | Candidate Id | | `candJust` | string | No | — | Cand Just | | `candTypeWhenHired` | string | No | — | Cand Type When Hired | | `cellPhone` | string | No | — | Cell Phone | | `city` | string | No | — | The city value | | `confnumber` | string | No | — | The confnumber value | | `contactEmail` | string | No | — | Contact Email | | `conviction_details` | string | No | — | Conviction Details | | `country` | string | No | — | The country value | | `countryCode` | string | No | — | Country Code | | `criminalconvictionlabel` | string | No | — | The criminalconvictionlabel value | | `crimincalconvictioninstructions` | string | No | — | The crimincalconvictioninstructions value | | `currentLocation` | string | No | — | Current Location | | `currentTitle` | string | No | — | Current Title | | `cust_refCheckFirstName` | string | No | — | Cust Ref Check First Name | | `cust_refCheckLastName` | string | No | — | Cust Ref Check Last Name | | `cust_refCheckOrg1` | string | No | — | Cust Ref Check Org1 | | `cust_refCheckPhone1` | string | No | — | Cust Ref Check Phone1 | | `cust_refCheckTitle1` | string | No | — | Cust Ref Check Title1 | | `dataSource` | string | No | — | Data Source | | `dateAvail` | string | No | — | Date Avail | | `dateOfBirth` | string | No | — | Date Of Birth | | `duplicateProfile` | string | No | — | Duplicate Profile | | `exportedOn` | string | No | — | Exported On | | `extTitle` | string | No | — | Ext Title | | `firstName` | string | No | — | First Name | | `formerEmployee` | boolean | No | — | Former Employee | | `gender` | string | No | — | The gender value | | `haveyoubeenconvicted` | string | No | — | The haveyoubeenconvicted value | | `hireDate` | string | No | — | Hire Date | | `hiredOn` | string | No | — | Hired On | | `homePhone` | string | No | — | Home Phone | | `inductionAdd` | string | No | — | Induction Add | | `inductionDate` | string | No | — | Induction Date | | `initials` | string | No | — | The initials value | | `instr_AdditionalDocuments` | string | No | — | Instr Additional Documents | | `instr_AppAdditionalInfo` | string | No | — | Instr App Additional Info | | `instr_AppAdvice` | string | No | — | Instr App Advice | | `instr_CandAppDetails` | string | No | — | Instr Cand App Details | | `instr_CandPersInfo` | string | No | — | Instr Cand Pers Info | | `instr_EEOinstructions` | string | No | — | Instr EE Oinstructions | | `instr_EEOlable` | string | No | — | Instr EE Olable | | `instrAppReturn` | string | No | — | Instr App Return | | `instrCandApproval` | string | No | — | Instr Cand Approval | | `instrCandAssess` | string | No | — | Instr Cand Assess | | `instrCandFields` | string | No | — | Instr Cand Fields | | `instrCandScreen` | string | No | — | Instr Cand Screen | | `instrubkgrndChkAttachment` | string | No | — | Instrubkgrnd Chk Attachment | | `instrWotc` | string | No | — | Instr Wotc | | `jobAppGuid` | string | No | — | Job App Guid | | `jobApplicationAssessmentOrder` | object | No | — | Job Application Assessment Order | | `jobApplicationAssessmentOrder_1` | object | No | — | Job Application Assessment Order 1 | | `jobApplicationComments` | object | No | — | Job Application Comments | | `jobApplicationOnboardingData` | object | No | — | Job Application Onboarding Data | | `jobApplicationQuestionResponse` | object | No | — | Job Application Question Response | | `jobApplicationStatusAuditTrail` | object | No | — | Job Application Status Audit Trail | | `jobAppStatus` | object | No | — | Job App Status | | `jobCode` | string | No | — | Job Code | | `jobofferdate` | string | No | — | The jobofferdate value | | `jobRateOfPay` | string | No | — | Job Rate Of Pay | | `jobReqId` | string | No | — | Job Req Id | | `jobStartDate` | string | No | — | Job Start Date | | `knownAs` | string | No | — | Known As | | `lastModifiedBy` | string | No | — | Last Modified By | | `lastModifiedByProxy` | string | No | — | Last Modified By Proxy | | `lastModifiedDateTime` | string | No | — | Last Modified Date Time | | `lastName` | string | No | — | Last Name | | `medDate` | string | No | — | Med Date | | `medLoc` | string | No | — | Med Loc | | `medTime` | string | No | — | Med Time | | `middleName` | string | No | — | Middle Name | | `nonApplicantStatus` | string | No | — | Non Applicant Status | | `owner` | string | No | — | The owner value | | `ownershpDate` | string | No | — | Ownershp Date | | `phoneScreenDate` | string | No | — | Phone Screen Date | | `phoneScreenDetails` | string | No | — | Phone Screen Details | | `pleaseselect` | string | No | — | The pleaseselect value | | `posTitle` | string | No | — | Pos Title | | `profileUpdated` | string | No | — | Profile Updated | | `psychTestDte` | string | No | — | Psych Test Dte | | `psychTestTme` | string | No | — | Psych Test Tme | | `rating` | string | No | — | The rating value | | `reasonableaccomodation` | string | No | — | The reasonableaccomodation value | | `reference` | string | No | — | The reference value | | `referenceComments` | string | No | — | Reference Comments | | `referredBy` | string | No | — | Referred By | | `resumeUploadDate` | string | No | — | Resume Upload Date | | `screendate` | string | No | — | The screendate value | | `snapShotDate` | string | No | — | Snap Shot Date | | `source` | string | No | — | The source value | | `sourceLabel` | string | No | — | Source Label | | `ssn` | string | No | — | The ssn value | | `startDate` | string | No | — | Start date for filtering | | `stateOther` | string | No | — | State Other | | `status` | string | No | — | The status value | | `statusComments` | string | No | — | Status Comments | | `timeToHire` | number | No | — | Time To Hire | | `title` | string | No | — | The title value | | `usersSysId` | string | No | — | Users Sys Id | | `visaNum` | string | No | — | Visa Num | | `voluntaryselfID` | string | No | — | Voluntaryself ID | | `whyask` | string | No | — | The whyask value | | `wotcFormsURL` | string | No | — | Wotc Forms URL | | `wotcId` | string | No | — | Wotc Id | | `wotcScreeningURL` | string | No | — | Wotc Screening URL | | `wotcStatus` | string | No | — | Wotc Status | | `yesanswer` | string | No | — | The yesanswer value | | `zip` | string | No | — | The zip value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "applicationId": { "type": "integer", "description": "key: applicationId" }, "address": { "type": "string", "description": "The address value" }, "address2": { "type": "string", "description": "The address2 value" }, "agencyInfo": { "type": "string", "description": "Agency Info" }, "anonymizedDate": { "type": "string", "description": "Anonymized Date" }, "anonymizedFlag": { "type": "string", "description": "Anonymized Flag" }, "applicationTemplateId": { "type": "string", "description": "Application Template Id" }, "appLocale": { "type": "string", "description": "App Locale" }, "appStatusSetItemId": { "type": "string", "description": "App Status Set Item Id" }, "averageRating": { "type": "string", "description": "Average Rating" }, "baseSalary": { "type": "string", "description": "Base Salary" }, "candConversionProcessed": { "type": "string", "description": "Cand Conversion Processed" }, "candidateId": { "type": "string", "description": "Candidate Id" }, "candJust": { "type": "string", "description": "Cand Just" }, "candTypeWhenHired": { "type": "string", "description": "Cand Type When Hired" }, "cellPhone": { "type": "string", "description": "Cell Phone" }, "city": { "type": "string", "description": "The city value" }, "confnumber": { "type": "string", "description": "The confnumber value" }, "contactEmail": { "type": "string", "description": "Contact Email" }, "conviction_details": { "type": "string", "description": "Conviction Details" }, "country": { "type": "string", "description": "The country value" }, "countryCode": { "type": "string", "description": "Country Code" }, "criminalconvictionlabel": { "type": "string", "description": "The criminalconvictionlabel value" }, "crimincalconvictioninstructions": { "type": "string", "description": "The crimincalconvictioninstructions value" }, "currentLocation": { "type": "string", "description": "Current Location" }, "currentTitle": { "type": "string", "description": "Current Title" }, "cust_refCheckFirstName": { "type": "string", "description": "Cust Ref Check First Name" }, "cust_refCheckLastName": { "type": "string", "description": "Cust Ref Check Last Name" }, "cust_refCheckOrg1": { "type": "string", "description": "Cust Ref Check Org1" }, "cust_refCheckPhone1": { "type": "string", "description": "Cust Ref Check Phone1" }, "cust_refCheckTitle1": { "type": "string", "description": "Cust Ref Check Title1" }, "dataSource": { "type": "string", "description": "Data Source" }, "dateAvail": { "type": "string", "description": "Date Avail" }, "dateOfBirth": { "type": "string", "description": "Date Of Birth" }, "duplicateProfile": { "type": "string", "description": "Duplicate Profile" }, "exportedOn": { "type": "string", "description": "Exported On" }, "extTitle": { "type": "string", "description": "Ext Title" }, "firstName": { "type": "string", "description": "First Name" }, "formerEmployee": { "type": "boolean", "description": "Former Employee" }, "gender": { "type": "string", "description": "The gender value" }, "haveyoubeenconvicted": { "type": "string", "description": "The haveyoubeenconvicted value" }, "hireDate": { "type": "string", "description": "Hire Date" }, "hiredOn": { "type": "string", "description": "Hired On" }, "homePhone": { "type": "string", "description": "Home Phone" }, "inductionAdd": { "type": "string", "description": "Induction Add" }, "inductionDate": { "type": "string", "description": "Induction Date" }, "initials": { "type": "string", "description": "The initials value" }, "instr_AdditionalDocuments": { "type": "string", "description": "Instr Additional Documents" }, "instr_AppAdditionalInfo": { "type": "string", "description": "Instr App Additional Info" }, "instr_AppAdvice": { "type": "string", "description": "Instr App Advice" }, "instr_CandAppDetails": { "type": "string", "description": "Instr Cand App Details" }, "instr_CandPersInfo": { "type": "string", "description": "Instr Cand Pers Info" }, "instr_EEOinstructions": { "type": "string", "description": "Instr EE Oinstructions" }, "instr_EEOlable": { "type": "string", "description": "Instr EE Olable" }, "instrAppReturn": { "type": "string", "description": "Instr App Return" }, "instrCandApproval": { "type": "string", "description": "Instr Cand Approval" }, "instrCandAssess": { "type": "string", "description": "Instr Cand Assess" }, "instrCandFields": { "type": "string", "description": "Instr Cand Fields" }, "instrCandScreen": { "type": "string", "description": "Instr Cand Screen" }, "instrubkgrndChkAttachment": { "type": "string", "description": "Instrubkgrnd Chk Attachment" }, "instrWotc": { "type": "string", "description": "Instr Wotc" }, "jobAppGuid": { "type": "string", "description": "Job App Guid" }, "jobApplicationAssessmentOrder": { "type": "object", "description": "Job Application Assessment Order", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobApplicationAssessmentOrder_1": { "type": "object", "description": "Job Application Assessment Order 1", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobApplicationComments": { "type": "object", "description": "Job Application Comments", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobApplicationOnboardingData": { "type": "object", "description": "Job Application Onboarding Data", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobApplicationQuestionResponse": { "type": "object", "description": "Job Application Question Response", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobApplicationStatusAuditTrail": { "type": "object", "description": "Job Application Status Audit Trail", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobAppStatus": { "type": "object", "description": "Job App Status", "properties": { "appStatusId": { "type": "string", "description": "App Status Id" }, "appStatusName": { "type": "string", "description": "App Status Name" }, "appStatusSetId": { "type": "string", "description": "App Status Set Id" }, "jobAppStatusLabel": { "type": "object", "description": "Job App Status Label" }, "jobApplications": { "type": "object", "description": "Job Applications" } } }, "jobCode": { "type": "string", "description": "Job Code" }, "jobofferdate": { "type": "string", "description": "The jobofferdate value" }, "jobRateOfPay": { "type": "string", "description": "Job Rate Of Pay" }, "jobReqId": { "type": "string", "description": "Job Req Id" }, "jobStartDate": { "type": "string", "description": "Job Start Date" }, "knownAs": { "type": "string", "description": "Known As" }, "lastModifiedBy": { "type": "string", "description": "Last Modified By" }, "lastModifiedByProxy": { "type": "string", "description": "Last Modified By Proxy" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "lastName": { "type": "string", "description": "Last Name" }, "medDate": { "type": "string", "description": "Med Date" }, "medLoc": { "type": "string", "description": "Med Loc" }, "medTime": { "type": "string", "description": "Med Time" }, "middleName": { "type": "string", "description": "Middle Name" }, "nonApplicantStatus": { "type": "string", "description": "Non Applicant Status" }, "owner": { "type": "string", "description": "The owner value" }, "ownershpDate": { "type": "string", "description": "Ownershp Date" }, "phoneScreenDate": { "type": "string", "description": "Phone Screen Date" }, "phoneScreenDetails": { "type": "string", "description": "Phone Screen Details" }, "pleaseselect": { "type": "string", "description": "The pleaseselect value" }, "posTitle": { "type": "string", "description": "Pos Title" }, "profileUpdated": { "type": "string", "description": "Profile Updated" }, "psychTestDte": { "type": "string", "description": "Psych Test Dte" }, "psychTestTme": { "type": "string", "description": "Psych Test Tme" }, "rating": { "type": "string", "description": "The rating value" }, "reasonableaccomodation": { "type": "string", "description": "The reasonableaccomodation value" }, "reference": { "type": "string", "description": "The reference value" }, "referenceComments": { "type": "string", "description": "Reference Comments" }, "referredBy": { "type": "string", "description": "Referred By" }, "resumeUploadDate": { "type": "string", "description": "Resume Upload Date" }, "screendate": { "type": "string", "description": "The screendate value" }, "snapShotDate": { "type": "string", "description": "Snap Shot Date" }, "source": { "type": "string", "description": "The source value" }, "sourceLabel": { "type": "string", "description": "Source Label" }, "ssn": { "type": "string", "description": "The ssn value" }, "startDate": { "type": "string", "description": "Start date for filtering" }, "stateOther": { "type": "string", "description": "State Other" }, "status": { "type": "string", "description": "The status value" }, "statusComments": { "type": "string", "description": "Status Comments" }, "timeToHire": { "type": "number", "description": "Time To Hire" }, "title": { "type": "string", "description": "The title value" }, "usersSysId": { "type": "string", "description": "Users Sys Id" }, "visaNum": { "type": "string", "description": "Visa Num" }, "voluntaryselfID": { "type": "string", "description": "Voluntaryself ID" }, "whyask": { "type": "string", "description": "The whyask value" }, "wotcFormsURL": { "type": "string", "description": "Wotc Forms URL" }, "wotcId": { "type": "string", "description": "Wotc Id" }, "wotcScreeningURL": { "type": "string", "description": "Wotc Screening URL" }, "wotcStatus": { "type": "string", "description": "Wotc Status" }, "yesanswer": { "type": "string", "description": "The yesanswer value" }, "zip": { "type": "string", "description": "The zip value" } }, "required": [ "PCID", "applicationId" ] } ``` *** ## sap\_successfactors\_recruiting\_replace\_job\_application\_interview Update entity in JobApplicationInterview **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------------- | ------- | -------- | ------- | ---------------------------- | | `applicationInterviewId` | integer | Yes | — | key: applicationInterviewId | | `applicationId` | string | No | — | Application Id | | `candSlotMapId` | string | No | — | Cand Slot Map Id | | `endDate` | string | No | — | End date for filtering | | `interviewOverallAssessment` | object | No | — | Interview Overall Assessment | | `isTimeSet` | integer | No | — | Is Time Set | | `notes` | string | No | — | The notes value | | `recruitEventStaffId` | string | No | — | Recruit Event Staff Id | | `source` | string | No | — | The source value | | `startDate` | string | No | — | Start date for filtering | | `status` | string | No | — | The status value | | `templateType` | string | No | — | Template Type | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "applicationInterviewId": { "type": "integer", "description": "key: applicationInterviewId" }, "applicationId": { "type": "string", "description": "Application Id" }, "candSlotMapId": { "type": "string", "description": "Cand Slot Map Id" }, "endDate": { "type": "string", "description": "End date for filtering" }, "interviewOverallAssessment": { "type": "object", "description": "Interview Overall Assessment", "properties": { "averageRating": { "type": "number", "description": "Average Rating" }, "comments": { "type": "string", "description": "The comments value" }, "interviewOverallAssessmentId": { "type": "string", "description": "Interview Overall Assessment Id" }, "interviewRefId": { "type": "string", "description": "Interview Ref Id" }, "overallRating": { "type": "string", "description": "Overall Rating" }, "type": { "type": "string", "description": "The type value" }, "interviewIndividualAssessment": { "type": "object", "description": "Interview Individual Assessment" } } }, "isTimeSet": { "type": "integer", "description": "Is Time Set" }, "notes": { "type": "string", "description": "The notes value" }, "recruitEventStaffId": { "type": "string", "description": "Recruit Event Staff Id" }, "source": { "type": "string", "description": "The source value" }, "startDate": { "type": "string", "description": "Start date for filtering" }, "status": { "type": "string", "description": "The status value" }, "templateType": { "type": "string", "description": "Template Type" } }, "required": [ "PCID", "applicationInterviewId" ] } ``` *** ## sap\_successfactors\_recruiting\_replace\_job\_offer Update entity in JobOffer **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------- | ------- | -------- | ------- | --------------------------- | | `offerApprovalId` | integer | Yes | — | key: offerApprovalId | | `annual_cashPay` | string | No | — | Annual Cash Pay | | `annual_FB` | string | No | — | Annual FB | | `annual_gratuity` | string | No | — | Annual Gratuity | | `annual_PF` | string | No | — | Annual PF | | `annual_retirals` | string | No | — | Annual Retirals | | `annual_SA` | string | No | — | Annual SA | | `anonymizedDate` | string | No | — | Anonymized Date | | `anonymizedFlag` | string | No | — | Anonymized Flag | | `applicationId` | string | No | — | Application Id | | `approvers` | object | No | — | The approvers value | | `candidateName` | string | No | — | Candidate Name | | `candJust` | string | No | — | Cand Just | | `commission` | string | No | — | The commission value | | `createdBy` | string | No | — | Created By | | `createdDate` | string | No | — | Created Date | | `currency` | string | No | — | The currency value | | `currentLocation` | string | No | — | Current Location | | `formDataId` | string | No | — | Form Data Id | | `formTemplateId` | string | No | — | Form Template Id | | `initialComment` | string | No | — | Initial Comment | | `internalStatus` | string | No | — | Internal Status | | `jobRateOfPay` | string | No | — | Job Rate Of Pay | | `lastModifiedBy` | string | No | — | Last Modified By | | `lastModifiedDate` | string | No | — | Last Modified Date | | `location` | string | No | — | The location value | | `monthly_cashPay` | string | No | — | Monthly Cash Pay | | `monthly_FB` | string | No | — | Monthly FB | | `monthly_gratuity` | string | No | — | Monthly Gratuity | | `monthly_PF` | string | No | — | Monthly PF | | `monthly_retirals` | string | No | — | Monthly Retirals | | `monthly_SA` | string | No | — | Monthly SA | | `monthly_salary` | string | No | — | Monthly Salary | | `redefineTemplateApprovers` | string | No | — | Redefine Template Approvers | | `salaryBase` | string | No | — | Salary Base | | `stockPackage` | string | No | — | Stock Package | | `targetBonusAmount` | string | No | — | Target Bonus Amount | | `tempDate` | string | No | — | Temp Date | | `templateId` | string | No | — | Template Id | | `total_earnings` | string | No | — | Total Earnings | | `total_fixed_pay` | string | No | — | Total Fixed Pay | | `version` | string | No | — | The version value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offerApprovalId": { "type": "integer", "description": "key: offerApprovalId" }, "annual_cashPay": { "type": "string", "description": "Annual Cash Pay" }, "annual_FB": { "type": "string", "description": "Annual FB" }, "annual_gratuity": { "type": "string", "description": "Annual Gratuity" }, "annual_PF": { "type": "string", "description": "Annual PF" }, "annual_retirals": { "type": "string", "description": "Annual Retirals" }, "annual_SA": { "type": "string", "description": "Annual SA" }, "anonymizedDate": { "type": "string", "description": "Anonymized Date" }, "anonymizedFlag": { "type": "string", "description": "Anonymized Flag" }, "applicationId": { "type": "string", "description": "Application Id" }, "approvers": { "type": "object", "description": "The approvers value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "candidateName": { "type": "string", "description": "Candidate Name" }, "candJust": { "type": "string", "description": "Cand Just" }, "commission": { "type": "string", "description": "The commission value" }, "createdBy": { "type": "string", "description": "Created By" }, "createdDate": { "type": "string", "description": "Created Date" }, "currency": { "type": "string", "description": "The currency value" }, "currentLocation": { "type": "string", "description": "Current Location" }, "formDataId": { "type": "string", "description": "Form Data Id" }, "formTemplateId": { "type": "string", "description": "Form Template Id" }, "initialComment": { "type": "string", "description": "Initial Comment" }, "internalStatus": { "type": "string", "description": "Internal Status" }, "jobRateOfPay": { "type": "string", "description": "Job Rate Of Pay" }, "lastModifiedBy": { "type": "string", "description": "Last Modified By" }, "lastModifiedDate": { "type": "string", "description": "Last Modified Date" }, "location": { "type": "string", "description": "The location value" }, "monthly_cashPay": { "type": "string", "description": "Monthly Cash Pay" }, "monthly_FB": { "type": "string", "description": "Monthly FB" }, "monthly_gratuity": { "type": "string", "description": "Monthly Gratuity" }, "monthly_PF": { "type": "string", "description": "Monthly PF" }, "monthly_retirals": { "type": "string", "description": "Monthly Retirals" }, "monthly_SA": { "type": "string", "description": "Monthly SA" }, "monthly_salary": { "type": "string", "description": "Monthly Salary" }, "redefineTemplateApprovers": { "type": "string", "description": "Redefine Template Approvers" }, "salaryBase": { "type": "string", "description": "Salary Base" }, "stockPackage": { "type": "string", "description": "Stock Package" }, "targetBonusAmount": { "type": "string", "description": "Target Bonus Amount" }, "tempDate": { "type": "string", "description": "Temp Date" }, "templateId": { "type": "string", "description": "Template Id" }, "total_earnings": { "type": "string", "description": "Total Earnings" }, "total_fixed_pay": { "type": "string", "description": "Total Fixed Pay" }, "version": { "type": "string", "description": "The version value" } }, "required": [ "PCID", "offerApprovalId" ] } ``` *** ## sap\_successfactors\_recruiting\_replace\_job\_requisition Update entity in JobRequisition **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------------------- | ------- | -------- | ------- | ----------------------------------------- | | `jobReqId` | integer | Yes | — | key: jobReqId | | `accommodation_cost` | string | No | — | Accommodation Cost | | `age` | string | No | — | The age value | | `agency_fee` | string | No | — | Agency Fee | | `annual_cashPay` | string | No | — | Annual Cash Pay | | `annual_FB` | string | No | — | Annual FB | | `annual_gratuity` | string | No | — | Annual Gratuity | | `annual_PF` | string | No | — | Annual PF | | `annual_retirals` | string | No | — | Annual Retirals | | `annual_SA` | string | No | — | Annual SA | | `approver` | object | No | — | The approver value | | `appTemplateId` | string | No | — | App Template Id | | `assessRatingScaleName` | string | No | — | Assess Rating Scale Name | | `candidateProgress` | string | No | — | Candidate Progress | | `city` | string | No | — | The city value | | `classificationTime` | string | No | — | Classification Time | | `classificationType` | string | No | — | Classification Type | | `closedDateTime` | string | No | — | Closed Date Time | | `comment` | string | No | — | The comment value | | `commentEquip` | string | No | — | Comment Equip | | `commission` | string | No | — | The commission value | | `coordinator` | object | No | — | The coordinator value | | `corporatePosting` | boolean | No | — | Corporate Posting | | `costCenterId` | string | No | — | Cost Center Id | | `costOfHire` | string | No | — | Cost Of Hire | | `country` | string | No | — | The country value | | `createdDateTime` | string | No | — | Created Date Time | | `currency` | string | No | — | The currency value | | `currentOwner` | object | No | — | Current Owner | | `customString10` | string | No | — | Custom String10 | | `customString3` | string | No | — | Custom String3 | | `customString4` | string | No | — | Custom String4 | | `customString8` | string | No | — | Custom String8 | | `defaultLanguage` | string | No | — | Default Language | | `deleted` | string | No | — | The deleted value | | `department` | string | No | — | The department value | | `division` | string | No | — | The division value | | `erpAmount` | string | No | — | Erp Amount | | `facility` | string | No | — | The facility value | | `formDataId` | string | No | — | Form Data Id | | `formDueDate` | string | No | — | Form Due Date | | `function` | string | No | — | The function value | | `hiringManager` | object | No | — | Hiring Manager | | `hiringManagerNote` | string | No | — | Hiring Manager Note | | `hiringManagerTeam` | object | No | — | Hiring Manager Team | | `hiringManagerTeamGroup` | object | No | — | Hiring Manager Team Group | | `industry` | string | No | — | The industry value | | `instr_rec_cost` | string | No | — | Instr Rec Cost | | `instrCostHire` | string | No | — | Instr Cost Hire | | `instrEquest` | string | No | — | Instr Equest | | `instrEquipment` | string | No | — | Instr Equipment | | `instrERS` | string | No | — | Instr ERS | | `instrInterview` | string | No | — | Instr Interview | | `instrInvolvedParties` | string | No | — | Instr Involved Parties | | `instrManagernote` | string | No | — | Instr Managernote | | `instrOverallComments` | string | No | — | Instr Overall Comments | | `instrPD` | string | No | — | Instr PD | | `instrReq` | string | No | — | Instr Req | | `instrReqDates` | string | No | — | Instr Req Dates | | `instrReqDetails` | string | No | — | Instr Req Details | | `instrReqJustify` | string | No | — | Instr Req Justify | | `instrReqRequire` | string | No | — | Instr Req Require | | `instrSalary` | string | No | — | Instr Salary | | `internalStatus` | string | No | — | Internal Status | | `intranetPosting` | boolean | No | — | Intranet Posting | | `isDraft` | boolean | No | — | Is Draft | | `jobCode` | string | No | — | Job Code | | `jobReqGUId` | string | No | — | Job Req GU Id | | `jobReqLocale` | object | No | — | Job Req Locale | | `jobReqPostings` | object | No | — | Job Req Postings | | `jobReqScreeningQuestions` | object | No | — | Job Req Screening Questions | | `jobRole` | string | No | — | Job Role | | `jobStartDate` | string | No | — | Job Start Date | | `lastModifiedBy` | string | No | — | Last Modified By | | `lastModifiedDateTime` | string | No | — | Last Modified Date Time | | `lastModifiedProxyUserId` | string | No | — | Last Modified Proxy User Id | | `legentity` | string | No | — | The legentity value | | `location` | string | No | — | The location value | | `misc_cost` | string | No | — | Misc Cost | | `monthly_cashPay` | string | No | — | Monthly Cash Pay | | `monthly_FB` | string | No | — | Monthly FB | | `monthly_gratuity` | string | No | — | Monthly Gratuity | | `monthly_PF` | string | No | — | Monthly PF | | `monthly_retirals` | string | No | — | Monthly Retirals | | `monthly_SA` | string | No | — | Monthly SA | | `monthly_salary` | string | No | — | Monthly Salary | | `numberOpenings` | string | No | — | Number Openings | | `openingsFilled` | string | No | — | Openings Filled | | `originator` | object | No | — | The originator value | | `otherBonus` | string | No | — | Other Bonus | | `otherCompensation` | string | No | — | Other Compensation | | `otherEquip` | string | No | — | Other Equip | | `othrComms` | string | No | — | Othr Comms | | `overallScaleName` | string | No | — | Overall Scale Name | | `positionNumber` | string | No | — | Position Number | | `postalcode` | string | No | — | The postalcode value | | `questions` | object | No | — | The questions value | | `ratedApplicantCount` | string | No | — | Rated Applicant Count | | `recruiter` | object | No | — | The recruiter value | | `recruiterTeam` | object | No | — | Recruiter Team | | `recruiterTeamGroup` | object | No | — | Recruiter Team Group | | `recruitJust` | string | No | — | Recruit Just | | `replforwhom` | string | No | — | The replforwhom value | | `restorehiringManagerTeamAdminDefaults` | boolean | No | — | Restorehiring Manager Team Admin Defaults | | `restorerecruiterTeamAdminDefaults` | boolean | No | — | Restorerecruiter Team Admin Defaults | | `restoresourcerTeamAdminDefaults` | boolean | No | — | Restoresourcer Team Admin Defaults | | `restorevpOfStaffingTeamAdminDefaults` | boolean | No | — | Restorevp Of Staffing Team Admin Defaults | | `reverseScale` | string | No | — | Reverse Scale | | `salaryBase` | string | No | — | Salary Base | | `salaryComment` | string | No | — | Salary Comment | | `salaryMax` | string | No | — | Salary Max | | `salaryMin` | string | No | — | Salary Min | | `salRateType` | string | No | — | Sal Rate Type | | `secondRecruiter` | object | No | — | Second Recruiter | | `sourcer` | object | No | — | The sourcer value | | `sourcerTeam` | object | No | — | Sourcer Team | | `sourcerTeamGroup` | object | No | — | Sourcer Team Group | | `stateProvince` | string | No | — | State Province | | `statusSetId` | string | No | — | Status Set Id | | `std_position_objlist` | any\[] | No | — | Std Position Objlist | | `stockPackage` | string | No | — | Stock Package | | `targetBonusAmount` | string | No | — | Target Bonus Amount | | `tempDate` | string | No | — | Temp Date | | `templateId` | string | No | — | Template Id | | `templateType` | string | No | — | Template Type | | `timeToFill` | string | No | — | Time To Fill | | `total_earnings` | string | No | — | Total Earnings | | `total_fixed_pay` | string | No | — | Total Fixed Pay | | `total_hire_cost` | string | No | — | Total Hire Cost | | `travel_cost` | string | No | — | Travel Cost | | `vpOfStaffing` | object | No | — | Vp Of Staffing | | `vpOfStaffingTeam` | object | No | — | Vp Of Staffing Team | | `vpOfStaffingTeamGroup` | object | No | — | Vp Of Staffing Team Group | | `workHours` | string | No | — | Work Hours | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobReqId": { "type": "integer", "description": "key: jobReqId" }, "accommodation_cost": { "type": "string", "description": "Accommodation Cost" }, "age": { "type": "string", "description": "The age value" }, "agency_fee": { "type": "string", "description": "Agency Fee" }, "annual_cashPay": { "type": "string", "description": "Annual Cash Pay" }, "annual_FB": { "type": "string", "description": "Annual FB" }, "annual_gratuity": { "type": "string", "description": "Annual Gratuity" }, "annual_PF": { "type": "string", "description": "Annual PF" }, "annual_retirals": { "type": "string", "description": "Annual Retirals" }, "annual_SA": { "type": "string", "description": "Annual SA" }, "approver": { "type": "object", "description": "The approver value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "appTemplateId": { "type": "string", "description": "App Template Id" }, "assessRatingScaleName": { "type": "string", "description": "Assess Rating Scale Name" }, "candidateProgress": { "type": "string", "description": "Candidate Progress" }, "city": { "type": "string", "description": "The city value" }, "classificationTime": { "type": "string", "description": "Classification Time" }, "classificationType": { "type": "string", "description": "Classification Type" }, "closedDateTime": { "type": "string", "description": "Closed Date Time" }, "comment": { "type": "string", "description": "The comment value" }, "commentEquip": { "type": "string", "description": "Comment Equip" }, "commission": { "type": "string", "description": "The commission value" }, "coordinator": { "type": "object", "description": "The coordinator value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "corporatePosting": { "type": "boolean", "description": "Corporate Posting" }, "costCenterId": { "type": "string", "description": "Cost Center Id" }, "costOfHire": { "type": "string", "description": "Cost Of Hire" }, "country": { "type": "string", "description": "The country value" }, "createdDateTime": { "type": "string", "description": "Created Date Time" }, "currency": { "type": "string", "description": "The currency value" }, "currentOwner": { "type": "object", "description": "Current Owner", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "customString10": { "type": "string", "description": "Custom String10" }, "customString3": { "type": "string", "description": "Custom String3" }, "customString4": { "type": "string", "description": "Custom String4" }, "customString8": { "type": "string", "description": "Custom String8" }, "defaultLanguage": { "type": "string", "description": "Default Language" }, "deleted": { "type": "string", "description": "The deleted value" }, "department": { "type": "string", "description": "The department value" }, "division": { "type": "string", "description": "The division value" }, "erpAmount": { "type": "string", "description": "Erp Amount" }, "facility": { "type": "string", "description": "The facility value" }, "formDataId": { "type": "string", "description": "Form Data Id" }, "formDueDate": { "type": "string", "description": "Form Due Date" }, "function": { "type": "string", "description": "The function value" }, "hiringManager": { "type": "object", "description": "Hiring Manager", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "hiringManagerNote": { "type": "string", "description": "Hiring Manager Note" }, "hiringManagerTeam": { "type": "object", "description": "Hiring Manager Team", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "hiringManagerTeamGroup": { "type": "object", "description": "Hiring Manager Team Group", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "industry": { "type": "string", "description": "The industry value" }, "instr_rec_cost": { "type": "string", "description": "Instr Rec Cost" }, "instrCostHire": { "type": "string", "description": "Instr Cost Hire" }, "instrEquest": { "type": "string", "description": "Instr Equest" }, "instrEquipment": { "type": "string", "description": "Instr Equipment" }, "instrERS": { "type": "string", "description": "Instr ERS" }, "instrInterview": { "type": "string", "description": "Instr Interview" }, "instrInvolvedParties": { "type": "string", "description": "Instr Involved Parties" }, "instrManagernote": { "type": "string", "description": "Instr Managernote" }, "instrOverallComments": { "type": "string", "description": "Instr Overall Comments" }, "instrPD": { "type": "string", "description": "Instr PD" }, "instrReq": { "type": "string", "description": "Instr Req" }, "instrReqDates": { "type": "string", "description": "Instr Req Dates" }, "instrReqDetails": { "type": "string", "description": "Instr Req Details" }, "instrReqJustify": { "type": "string", "description": "Instr Req Justify" }, "instrReqRequire": { "type": "string", "description": "Instr Req Require" }, "instrSalary": { "type": "string", "description": "Instr Salary" }, "internalStatus": { "type": "string", "description": "Internal Status" }, "intranetPosting": { "type": "boolean", "description": "Intranet Posting" }, "isDraft": { "type": "boolean", "description": "Is Draft" }, "jobCode": { "type": "string", "description": "Job Code" }, "jobReqGUId": { "type": "string", "description": "Job Req GU Id" }, "jobReqLocale": { "type": "object", "description": "Job Req Locale", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobReqPostings": { "type": "object", "description": "Job Req Postings", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobReqScreeningQuestions": { "type": "object", "description": "Job Req Screening Questions", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "jobRole": { "type": "string", "description": "Job Role" }, "jobStartDate": { "type": "string", "description": "Job Start Date" }, "lastModifiedBy": { "type": "string", "description": "Last Modified By" }, "lastModifiedDateTime": { "type": "string", "description": "Last Modified Date Time" }, "lastModifiedProxyUserId": { "type": "string", "description": "Last Modified Proxy User Id" }, "legentity": { "type": "string", "description": "The legentity value" }, "location": { "type": "string", "description": "The location value" }, "misc_cost": { "type": "string", "description": "Misc Cost" }, "monthly_cashPay": { "type": "string", "description": "Monthly Cash Pay" }, "monthly_FB": { "type": "string", "description": "Monthly FB" }, "monthly_gratuity": { "type": "string", "description": "Monthly Gratuity" }, "monthly_PF": { "type": "string", "description": "Monthly PF" }, "monthly_retirals": { "type": "string", "description": "Monthly Retirals" }, "monthly_SA": { "type": "string", "description": "Monthly SA" }, "monthly_salary": { "type": "string", "description": "Monthly Salary" }, "numberOpenings": { "type": "string", "description": "Number Openings" }, "openingsFilled": { "type": "string", "description": "Openings Filled" }, "originator": { "type": "object", "description": "The originator value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "otherBonus": { "type": "string", "description": "Other Bonus" }, "otherCompensation": { "type": "string", "description": "Other Compensation" }, "otherEquip": { "type": "string", "description": "Other Equip" }, "othrComms": { "type": "string", "description": "Othr Comms" }, "overallScaleName": { "type": "string", "description": "Overall Scale Name" }, "positionNumber": { "type": "string", "description": "Position Number" }, "postalcode": { "type": "string", "description": "The postalcode value" }, "questions": { "type": "object", "description": "The questions value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "ratedApplicantCount": { "type": "string", "description": "Rated Applicant Count" }, "recruiter": { "type": "object", "description": "The recruiter value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "recruiterTeam": { "type": "object", "description": "Recruiter Team", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "recruiterTeamGroup": { "type": "object", "description": "Recruiter Team Group", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "recruitJust": { "type": "string", "description": "Recruit Just" }, "replforwhom": { "type": "string", "description": "The replforwhom value" }, "restorehiringManagerTeamAdminDefaults": { "type": "boolean", "description": "Restorehiring Manager Team Admin Defaults" }, "restorerecruiterTeamAdminDefaults": { "type": "boolean", "description": "Restorerecruiter Team Admin Defaults" }, "restoresourcerTeamAdminDefaults": { "type": "boolean", "description": "Restoresourcer Team Admin Defaults" }, "restorevpOfStaffingTeamAdminDefaults": { "type": "boolean", "description": "Restorevp Of Staffing Team Admin Defaults" }, "reverseScale": { "type": "string", "description": "Reverse Scale" }, "salaryBase": { "type": "string", "description": "Salary Base" }, "salaryComment": { "type": "string", "description": "Salary Comment" }, "salaryMax": { "type": "string", "description": "Salary Max" }, "salaryMin": { "type": "string", "description": "Salary Min" }, "salRateType": { "type": "string", "description": "Sal Rate Type" }, "secondRecruiter": { "type": "object", "description": "Second Recruiter", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "sourcer": { "type": "object", "description": "The sourcer value", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "sourcerTeam": { "type": "object", "description": "Sourcer Team", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "sourcerTeamGroup": { "type": "object", "description": "Sourcer Team Group", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "stateProvince": { "type": "string", "description": "State Province" }, "statusSetId": { "type": "string", "description": "Status Set Id" }, "std_position_objlist": { "type": "array", "description": "Std Position Objlist" }, "stockPackage": { "type": "string", "description": "Stock Package" }, "targetBonusAmount": { "type": "string", "description": "Target Bonus Amount" }, "tempDate": { "type": "string", "description": "Temp Date" }, "templateId": { "type": "string", "description": "Template Id" }, "templateType": { "type": "string", "description": "Template Type" }, "timeToFill": { "type": "string", "description": "Time To Fill" }, "total_earnings": { "type": "string", "description": "Total Earnings" }, "total_fixed_pay": { "type": "string", "description": "Total Fixed Pay" }, "total_hire_cost": { "type": "string", "description": "Total Hire Cost" }, "travel_cost": { "type": "string", "description": "Travel Cost" }, "vpOfStaffing": { "type": "object", "description": "Vp Of Staffing", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "vpOfStaffingTeam": { "type": "object", "description": "Vp Of Staffing Team", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "vpOfStaffingTeamGroup": { "type": "object", "description": "Vp Of Staffing Team Group", "properties": { "results": { "type": "array", "items": { "type": "object" }, "description": "The results value" } } }, "workHours": { "type": "string", "description": "Work Hours" } }, "required": [ "PCID", "jobReqId" ] } ``` *** ## sap\_successfactors\_recruiting\_replace\_offer\_letter Update entity in OfferLetter **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ----------------------- | | `offerLetterId` | integer | Yes | — | key: offerLetterId | | `applicationId` | string | No | — | Application Id | | `body` | string | No | — | The body value | | `bodyLocale` | string | No | — | Body Locale | | `bodyTemplateId` | string | No | — | Body Template Id | | `bonusPayoutFreq` | string | No | — | Bonus Payout Freq | | `candResponseComments` | string | No | — | Cand Response Comments | | `candResponseDate` | string | No | — | Cand Response Date | | `comments` | string | No | — | The comments value | | `countryCode` | string | No | — | Country Code | | `countryName` | string | No | — | Country Name | | `createDate` | string | No | — | Create Date | | `createdBy` | string | No | — | Created By | | `currencyCode` | string | No | — | Currency Code | | `jobStartDate` | string | No | — | Job Start Date | | `jobTitle` | string | No | — | Job Title | | `lastModifiedBy` | string | No | — | Last Modified By | | `lastModifiedDate` | string | No | — | Last Modified Date | | `locale` | string | No | — | Locale or language code | | `localeCode` | string | No | — | Locale Code | | `mailboxes` | string | No | — | The mailboxes value | | `offerExpirationDate` | string | No | — | Offer Expiration Date | | `offerLetter` | string | No | — | Offer Letter | | `offerSentDate` | string | No | — | Offer Sent Date | | `overtimeRate` | string | No | — | Overtime Rate | | `salaryRate` | string | No | — | Salary Rate | | `salaryRateType` | string | No | — | Salary Rate Type | | `sendMode` | string | No | — | Send Mode | | `status` | string | No | — | The status value | | `stockGrant` | string | No | — | Stock Grant | | `stockOption` | string | No | — | Stock Option | | `subject` | string | No | — | The subject value | | `targetBonusAmount` | string | No | — | Target Bonus Amount | | `targetBonusPercent` | string | No | — | Target Bonus Percent | | `templateId` | string | No | — | Template Id | | `templateName` | string | No | — | Template Name | | `tokens` | string | No | — | The tokens value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offerLetterId": { "type": "integer", "description": "key: offerLetterId" }, "applicationId": { "type": "string", "description": "Application Id" }, "body": { "type": "string", "description": "The body value" }, "bodyLocale": { "type": "string", "description": "Body Locale" }, "bodyTemplateId": { "type": "string", "description": "Body Template Id" }, "bonusPayoutFreq": { "type": "string", "description": "Bonus Payout Freq" }, "candResponseComments": { "type": "string", "description": "Cand Response Comments" }, "candResponseDate": { "type": "string", "description": "Cand Response Date" }, "comments": { "type": "string", "description": "The comments value" }, "countryCode": { "type": "string", "description": "Country Code" }, "countryName": { "type": "string", "description": "Country Name" }, "createDate": { "type": "string", "description": "Create Date" }, "createdBy": { "type": "string", "description": "Created By" }, "currencyCode": { "type": "string", "description": "Currency Code" }, "jobStartDate": { "type": "string", "description": "Job Start Date" }, "jobTitle": { "type": "string", "description": "Job Title" }, "lastModifiedBy": { "type": "string", "description": "Last Modified By" }, "lastModifiedDate": { "type": "string", "description": "Last Modified Date" }, "locale": { "type": "string", "description": "Locale or language code" }, "localeCode": { "type": "string", "description": "Locale Code" }, "mailboxes": { "type": "string", "description": "The mailboxes value" }, "offerExpirationDate": { "type": "string", "description": "Offer Expiration Date" }, "offerLetter": { "type": "string", "description": "Offer Letter" }, "offerSentDate": { "type": "string", "description": "Offer Sent Date" }, "overtimeRate": { "type": "string", "description": "Overtime Rate" }, "salaryRate": { "type": "string", "description": "Salary Rate" }, "salaryRateType": { "type": "string", "description": "Salary Rate Type" }, "sendMode": { "type": "string", "description": "Send Mode" }, "status": { "type": "string", "description": "The status value" }, "stockGrant": { "type": "string", "description": "Stock Grant" }, "stockOption": { "type": "string", "description": "Stock Option" }, "subject": { "type": "string", "description": "The subject value" }, "targetBonusAmount": { "type": "string", "description": "Target Bonus Amount" }, "targetBonusPercent": { "type": "string", "description": "Target Bonus Percent" }, "templateId": { "type": "string", "description": "Template Id" }, "templateName": { "type": "string", "description": "Template Name" }, "tokens": { "type": "string", "description": "The tokens value" } }, "required": [ "PCID", "offerLetterId" ] } ```