SAP SuccessFactors Component

SAP SuccessFactors is a human resources platform that provides cloud-based solutions to manage various HR functions such as business alignment, people performance, recruitment, and learning activities.

Component key: sap-successfactors

Description

SAP SuccessFactors is a human resources platform providing solutions to manage various business functions.

Use the SAP SuccessFactors component to manage Job Applications, Candidates, Onboarding information, and more.

API Documentation:

The component was built using the SAP SuccessFactors ODATA V2 API

Connections

API Key Authentication

• Log into your instance as an administrator.
• Go to Admin Center API Center OAuth Configuration for OData and choose Register Client Application. You can also access the tool by searching Manage OAuth2 Client Applications in Action Search.

Input	Notes	Example
Input API Key string / Required apiKey	Notes Your OAuth2 Success Factors API Key	Example YzVjNzI4MTIsdryNmJkOTVkYWJmODBiZjdkYg
Input API Server string apiServer	Notes Your SAP SuccessFactors api server, if you are not sure, please contact your SAP SuccessFactors administrator. If empty the sandbox environment will be used (sandbox.api.sap.com)	Example testing.successfactors.com
Input Audiences string / Required audiences	Notes Audiences of the SAML assertion	Example www.successfactors.com
Input Certificate text / Required cert	Notes Your Public Certificate for Success Factors OAuth2	Example
Input Company ID string / Required companyId	Notes SAP SuccessFactors Company ID	Example
Input Issuer string / Required issuer	Notes Issuer information of the SAML assertion	Example wwww.successfactors.com
Input Certificate Private Key text / Required privateKey	Notes Your Private Certificate Key for Success Factors OAuth2	Example
Input Protocol string / Required protocol	Notes The SAP SuccessFactors protocol to use	Example
Input User string / Required user	Notes Enter the SAP SuccessFactors user ID that you use to access the APIs	Example sfadmin

Basic Authentication

Input	Notes	Example
Input API Server string apiServer	Notes Your SAP SuccessFactors api server, if you are not sure, please contact your SAP SuccessFactors administrator. If empty the sandbox environment will be used (sandbox.api.sap.com)	Example testing.successfactors.com
Input Company ID string / Required companyId	Notes SAP SuccessFactors Company ID	Example
Input Password password / Required password	Notes SAP SuccessFactors Password	Example
Input Protocol string / Required protocol	Notes The SAP SuccessFactors protocol to use	Example
Input Username string / Required username	Notes SAP SuccessFactors Username	Example

Data Sources

Select Candidate

Select a Candidate from the dropdown list | key: selectCandidate | type: picklist

Input	Notes
Input Connection connection / Required connection	Notes

{
  "result": [
    {
      "label": "John Doe",
      "key": "1234"
    }
  ]
}

---

Select Job Application

Select a Job Application from the dropdown list | key: selectJobApplication | type: picklist

Input	Notes
Input Connection connection / Required connection	Notes

{
  "result": [
    {
      "label": "John Doe - Job Requisition #1234",
      "key": "1234"
    }
  ]
}

---

Select Job Requisition

Select a Job Requisition from the dropdown list | key: selectJobRequisition | type: picklist

Input	Notes
Input Connection connection / Required connection	Notes

{
  "result": [
    {
      "label": "1234 - 50070999",
      "key": "1234"
    }
  ]
}

---

Actions

Create a Record

Create a new record in component | key: createRecord

Input	Notes	Example
Input Additional Inputs code additionalInputs	Notes Additional inputs to be passed to the action	Example
Input Connection connection / Required connection	Notes	Example
Input Record Type string / Required recordType	Notes The type of record to create	Example Candidate

---

Create Candidate

Add a new entity to Candidate | key: createCandidate

Input	Notes	Example
Input Additional Inputs code additionalInputs	Notes Additional inputs to be passed to the action	Example
Input Connection connection / Required connection	Notes	Example
Input Country string / Required country	Notes The country where the candidate is located	Example United States
Input First Name string / Required firstName	Notes The first name of the candidate	Example John
Input Last Name string / Required lastName	Notes The last name of the candidate	Example Doe
Input Primary Email string / Required primaryEmail	Notes The primary email address of the candidate	Example test@test.com

{
  "data": {
    "__metadata": {
      "uri": "https://api68sales.successfactors.com/odata/v2/Candidate(4181L)",
      "type": "SFOData.Candidate"
    },
    "candidateId": "4181",
    "lastName": "Langworthy",
    "firstName": "Nancy"
  }
}

---

Create Job Application

Add a new entity to JobApplication | key: createJobApplication

Input	Notes	Example
Input Additional Inputs code additionalInputs	Notes Additional inputs to be passed to the action	Example
Input Candidate ID string / Required candidateId	Notes The ID of the candidate to create the job application for	Example 1234-5678
Input Connection connection / Required connection	Notes	Example
Input Job Requisition ID string / Required jobReqId	Notes The ID of the job requisition to create the job application for	Example 1234-5678

{
  "data": {
    "__metadata": {
      "uri": "https://api68sales.successfactors.com/odata/v2/JobApplication(388L)",
      "type": "SFOData.JobApplication"
    },
    "applicationId": "388",
    "lastName": "Test",
    "firstName": "Test",
    "status": "Open"
  }
}

---

Create Job Requisition

Add a new entity to JobRequisition | key: createJobRequisition

Input	Notes	Example
Input Additional Inputs code additionalInputs	Notes The required fields for the selected template	Example
Input Connection connection / Required connection	Notes	Example
Input Template ID string / Required templateId	Notes The ID of the job requisition template to use	Example 1234-5678

---

Create Onboarding Candidate Info

Add a new entity to OnboardingCandidateInfo | key: createOnboardingCandidateInfo

Input	Notes	Example
Input Additional Inputs code additionalInputs	Notes Additional inputs to be passed to the action	Example
Input Connection connection / Required connection	Notes	Example

---

Delete Job Requisition

Delete an entity from JobRequisition | key: deleteJobRequisition

Input	Notes	Example
Input Connection connection / Required connection	Notes	Example
Input Job Requisition ID string / Required jobReqId	Notes The ID of the job requisition to delete	Example 1234-5678

---

Delete Onboarding Candidate Info

Delete an entity from OnboardingCandidateInfo | key: deleteOnboardingCandidateInfo

Input	Notes	Example
Input Applicant ID string / Required applicantId	Notes The ID of the applicant to retrieve	Example 1234-5678
Input Connection connection / Required connection	Notes	Example

---

Delete Record

Delete an existing record in component | key: deleteRecord

Input	Notes	Example
Input Connection connection / Required connection	Notes	Example
Input Record Type string / Required recordType	Notes The type of record to delete	Example Candidate
Input Record Type ID string / Required recordTypeId	Notes The ID of the record to delete	Example 1234-5678

---

Get Candidate

Get entity from Candidate by key | key: getCandidate

Input	Notes	Example
Input Select string $select	Notes Select properties to be returned	Example Rating,ReleaseDate
Input Candidate ID string / Required candidateId	Notes The ID of the candidate to retrieve	Example 1234-5678
Input Connection connection / Required connection	Notes	Example

{
  "data": {
    "__metadata": {
      "uri": "https://api68sales.successfactors.com/odata/v2/Candidate(4181L)",
      "type": "SFOData.Candidate"
    },
    "candidateId": "4181",
    "lastName": "Langworthy",
    "firstName": "Nancy"
  }
}

---

Get Job Application

Get entity from JobApplication by key | key: getJobApplication

Input	Notes	Example
Input Select string $select	Notes Select properties to be returned	Example Rating,ReleaseDate
Input Connection connection / Required connection	Notes	Example
Input Job Application ID string / Required jobApplicationId	Notes The ID of the job application to retrieve	Example 1234-5678

{
  "data": {
    "__metadata": {
      "uri": "https://api68sales.successfactors.com/odata/v2/JobApplication(388L)",
      "type": "SFOData.JobApplication"
    },
    "applicationId": "388",
    "lastName": "Test",
    "firstName": "Test",
    "status": "Open"
  }
}

---

Get Job Requisition

Get entity from JobRequisition by key | key: getJobRequisition

Input	Notes	Example
Input Select string $select	Notes Select properties to be returned	Example Rating,ReleaseDate
Input Connection connection / Required connection	Notes	Example
Input Job Requisition ID string / Required jobReqId	Notes The ID of the job requisition to retrieve	Example 1234-5678

---

Get Onboarding Candidate Info

Get entity from OnboardingCandidateInfo by key | key: getOnboardingCandidateInfo

Input	Notes	Example
Input Select string $select	Notes Select properties to be returned	Example Rating,ReleaseDate
Input Applicant ID string / Required applicantId	Notes The ID of the applicant to retrieve	Example 1234-5678
Input Connection connection / Required connection	Notes	Example

---

Get Record

Retrieve a single record from component | key: getRecord

Input	Notes	Example
Input Select string $select	Notes Select properties to be returned	Example Rating,ReleaseDate
Input Connection connection / Required connection	Notes	Example
Input Record Type string / Required recordType	Notes The type of record to create	Example Candidate
Input Record Type ID string / Required recordTypeId	Notes The ID of the record type to retrieve	Example 1234-5678

---

List Candidates

Get entities from Candidate | key: listCandidates

Input	Default	Notes	Example
Input Count boolean $count	Default false	Notes Include count of items	Example
Input Expand string $expand	Default	Notes Expand related entities	Example Orders($filter=Amount gt 100)
Input Filter string $filter	Default	Notes Filter items by property values	Example Price lt 10.00
Input Order By string $orderby	Default	Notes Order items by property values	Example userId desc
Input Search string $search	Default	Notes Search items by search phrases	Example NOT clothing
Input Select string $select	Default	Notes Select properties to be returned	Example Rating,ReleaseDate
Input Skip string $skip	Default	Notes The number of records to skip	Example 20
Input Top string $top	Default	Notes The number of records to return	Example 20
Input Connection connection / Required connection	Default	Notes	Example
Input Custom Query Params string Key Value List customQueryParams	Default	Notes Custom fields filter	Example key1=value1
Input Fetch All boolean fetchAll	Default false	Notes If true will fetch all records, otherwise will use the other inputs to fetch the records	Example

{
  "data": [
    {
      "__metadata": {
        "uri": "https://api68sales.successfactors.com/odata/v2/Candidate(4181L)",
        "type": "SFOData.Candidate"
      },
      "candidateId": "4181",
      "lastName": "Langworthy",
      "firstName": "Nancy"
    }
  ]
}

---

List Job Applications

Get entities from JobApplication | key: listJobApplications

Input	Default	Notes	Example
Input Count boolean $count	Default false	Notes Include count of items	Example
Input Expand string $expand	Default	Notes Expand related entities	Example Orders($filter=Amount gt 100)
Input Filter string $filter	Default	Notes Filter items by property values	Example Price lt 10.00
Input Order By string $orderby	Default	Notes Order items by property values	Example userId desc
Input Search string $search	Default	Notes Search items by search phrases	Example NOT clothing
Input Select string $select	Default	Notes Select properties to be returned	Example Rating,ReleaseDate
Input Skip string $skip	Default	Notes The number of records to skip	Example 20
Input Top string $top	Default	Notes The number of records to return	Example 20
Input Connection connection / Required connection	Default	Notes	Example
Input Custom Query Params string Key Value List customQueryParams	Default	Notes Custom fields filter	Example key1=value1
Input Fetch All boolean fetchAll	Default false	Notes If true will fetch all records, otherwise will use the other inputs to fetch the records	Example

{
  "data": [
    {
      "__metadata": {
        "uri": "https://api68sales.successfactors.com/odata/v2/JobApplication(388L)",
        "type": "SFOData.JobApplication"
      },
      "applicationId": "388",
      "lastName": "Test",
      "firstName": "Test",
      "status": "Open"
    }
  ]
}

---

List Job Requisitions

Get entities from JobRequisition | key: listJobRequisitions

Input	Default	Notes	Example
Input Count boolean $count	Default false	Notes Include count of items	Example
Input Expand string $expand	Default	Notes Expand related entities	Example Orders($filter=Amount gt 100)
Input Filter string $filter	Default	Notes Filter items by property values	Example Price lt 10.00
Input Order By string $orderby	Default	Notes Order items by property values	Example userId desc
Input Search string $search	Default	Notes Search items by search phrases	Example NOT clothing
Input Select string $select	Default	Notes Select properties to be returned	Example Rating,ReleaseDate
Input Skip string $skip	Default	Notes The number of records to skip	Example 20
Input Top string $top	Default	Notes The number of records to return	Example 20
Input Connection connection / Required connection	Default	Notes	Example
Input Custom Query Params string Key Value List customQueryParams	Default	Notes Custom fields filter	Example key1=value1
Input Fetch All boolean fetchAll	Default false	Notes If true will fetch all records, otherwise will use the other inputs to fetch the records	Example

{
  "data": [
    {
      "__metadata": {
        "uri": "https://api68sales.successfactors.com/odata/v2/JobRequisition(3040L)",
        "type": "SFOData.JobRequisition"
      },
      "jobReqId": "3040",
      "createdDateTime": "/Date(1673880833000+0000)/"
    }
  ]
}

---

List Onboarding Candidate Info

Get entities from OnboardingCandidateInfo | key: listOnboardingCandidateInfo

Input	Default	Notes	Example
Input Count boolean $count	Default false	Notes Include count of items	Example
Input Expand string $expand	Default	Notes Expand related entities	Example Orders($filter=Amount gt 100)
Input Filter string $filter	Default	Notes Filter items by property values	Example Price lt 10.00
Input Order By string $orderby	Default	Notes Order items by property values	Example userId desc
Input Search string $search	Default	Notes Search items by search phrases	Example NOT clothing
Input Select string $select	Default	Notes Select properties to be returned	Example Rating,ReleaseDate
Input Skip string $skip	Default	Notes The number of records to skip	Example 20
Input Top string $top	Default	Notes The number of records to return	Example 20
Input Connection connection / Required connection	Default	Notes	Example
Input Custom Query Params string Key Value List customQueryParams	Default	Notes Custom fields filter	Example key1=value1
Input Fetch All boolean fetchAll	Default false	Notes If true will fetch all records, otherwise will use the other inputs to fetch the records	Example

---

List Records

Retrieve a list of records from component | key: listRecords

Input	Default	Notes	Example
Input Count boolean $count	Default false	Notes Include count of items	Example
Input Expand string $expand	Default	Notes Expand related entities	Example Orders($filter=Amount gt 100)
Input Filter string $filter	Default	Notes Filter items by property values	Example Price lt 10.00
Input Order By string $orderby	Default	Notes Order items by property values	Example userId desc
Input Search string $search	Default	Notes Search items by search phrases	Example NOT clothing
Input Select string $select	Default	Notes Select properties to be returned	Example Rating,ReleaseDate
Input Skip string $skip	Default	Notes The number of records to skip	Example 20
Input Top string $top	Default	Notes The number of records to return	Example 20
Input Connection connection / Required connection	Default	Notes	Example
Input Custom Query Params string Key Value List customQueryParams	Default	Notes Custom fields filter	Example key1=value1
Input Fetch All boolean fetchAll	Default false	Notes If true will fetch all records, otherwise will use the other inputs to fetch the records	Example
Input Record Type string / Required recordType	Default	Notes The type of record to create	Example Candidate

---

Raw Request

Send raw HTTP request to the SAP SuccessFactors API | key: rawRequest

Input	Default	Notes	Example
Input Connection connection / Required connection	Default	Notes	Example
Input Data string data	Default	Notes The HTTP body payload to send to the URL.	Example {"exampleKey": "Example Data"}
Input Debug Request boolean debugRequest	Default false	Notes Enabling this flag will log out the current request.	Example
Input File Data string Key Value List fileData	Default	Notes File Data to be sent as a multipart form upload.	Example [{key: "example.txt", value: "My File Contents"}]
Input File Data File Names string Key Value List fileDataFileNames	Default	Notes File names to apply to the file data inputs. Keys must match the file data keys above.	Example
Input Form Data string Key Value List formData	Default	Notes The Form Data to be sent as a multipart form upload.	Example [{"key": "Example Key", "value": new Buffer("Hello World")}]
Input Header string Key Value List headers	Default	Notes A list of headers to send with the request.	Example User-Agent: curl/7.64.1
Input Max Retry Count string maxRetries	Default 0	Notes The maximum number of retries to attempt. Specify 0 for no retries.	Example
Input Method string / Required method	Default	Notes The HTTP method to use.	Example
Input Query Parameter string Key Value List queryParams	Default	Notes A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.	Example
Input Response Type string / Required responseType	Default json	Notes The type of data you expect in the response. You can request json, text, or binary data.	Example
Input Retry On All Errors boolean retryAllErrors	Default false	Notes If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	Example
Input Retry Delay (ms) string retryDelayMS	Default 0	Notes The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	Example
Input Timeout string timeout	Default	Notes The maximum time that a client will await a response to its request	Example 2000
Input URL string / Required url	Default	Notes Input the path only (/Candidate), The base URL is already included ({{ YOUR_API_SERVER_URL }}). For example, to connect to {{ YOUR_API_SERVER_URL }}/Candidate, only /Candidate is entered in this field	Example /Candidate
Input Use Exponential Backoff boolean useExponentialBackoff	Default false	Notes Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	Example

---

Update Candidate

Update an entity in Candidate | key: updateCandidate

Input	Notes	Example
Input Additional Inputs code additionalInputs	Notes Additional inputs to be passed to the action	Example
Input Candidate ID string / Required candidateId	Notes The ID of the candidate to retrieve	Example 1234-5678
Input Connection connection / Required connection	Notes	Example
Input Country string country	Notes The country where the candidate is located	Example United States
Input First Name string firstName	Notes The first name of the candidate	Example John
Input Last Name string lastName	Notes The last name of the candidate	Example Doe
Input Primary Email string primaryEmail	Notes The primary email address of the candidate	Example test@test.com

{
  "data": "Action completed successfully"
}

---

Update Job Application

Update an entity in JobApplication | key: updateJobApplication

Input	Notes	Example
Input Additional Inputs code additionalInputs	Notes Additional inputs to be passed to the action	Example
Input Candidate ID string candidateId	Notes The ID of the candidate to update	Example 1234-5678
Input Connection connection / Required connection	Notes	Example
Input Job Application ID string / Required jobApplicationId	Notes The ID of the job application to retrieve	Example 1234-5678
Input Job Requisition ID string jobReqId	Notes The ID of the job requisition to update	Example 1234-5678

{
  "data": "Action completed successfully"
}

---

Update Job Requisition

Update an entity in JobRequisition | key: updateJobRequisition

Input	Notes	Example
Input Additional Inputs code additionalInputs	Notes The template fields to update	Example
Input Connection connection / Required connection	Notes	Example
Input Job Requisition ID string / Required jobReqId	Notes The ID of the job requisition to retrieve	Example 1234-5678

{
  "data": "Action completed successfully"
}

---

Update Onboarding Candidate Info

Update an entity in OnboardingCandidateInfo | key: updateOnboardingCandidateInfo

Input	Notes	Example
Input Applicant ID string / Required applicantId	Notes The ID of the applicant to retrieve	Example 1234-5678
Input Connection connection / Required connection	Notes	Example

---

Update Record

Update an existing record in component | key: updateRecord

Input	Notes	Example
Input Additional Inputs code additionalInputs	Notes Additional inputs to be passed to the action	Example
Input Connection connection / Required connection	Notes	Example
Input Record Type string / Required recordType	Notes The type of record to create	Example Candidate
Input Record Type ID string / Required recordTypeId	Notes The ID of the record type to retrieve	Example 1234-5678

{
  "data": "Action completed successfully"
}

---