Skip to main content
Server path: /sap-successfactors-onboarding | Type: Application | PCID required: Yes

Tools

ToolDescription
sap_successfactors_onboarding_create_create_onboardeeThis function import enables you to create an onboarding external user record in the system with information collected from your external Applicant Tracking System (ATS). It also enables you to perform preliminary checks to understand if the onboardee is a new hire or a rehire and take actions as necessary.
sap_successfactors_onboarding_create_initiate_onboarding_for_userAfter an external user record is created and Employee Central data is added to the record, you can use this funtion import to initiate onboarding process from an external Application Tracking System. It modifies the ONB2Process and ONB2ProcessTrigger MDF objects. All Employee Central entities (PerPerson, EmpJob, EmpEmployment) should be upserted prior to this call.
sap_successfactors_onboarding_create_onboarding_newhire_v1_journeysMass Initiate Onboarding Journeys
sap_successfactors_onboarding_get_assigned_compliance_formGet entity from AssignedComplianceForm by key
sap_successfactors_onboarding_get_compliance_document_flowGet entity from ComplianceDocumentFlow by key
sap_successfactors_onboarding_get_compliance_form_dataGet entity from ComplianceFormData by key
sap_successfactors_onboarding_get_compliance_form_signatureGet entity from ComplianceFormSignature by key
sap_successfactors_onboarding_get_compliance_processGet entity from ComplianceProcess by key
sap_successfactors_onboarding_get_compliance_process_taskGet entity from ComplianceProcessTask by key
sap_successfactors_onboarding_list_assigned_compliance_formThis entity contains the compliance forms assigned to new hires.
sap_successfactors_onboarding_list_compliance_document_flowThis entity stores the Compliance document flow assigned to the new hire.
sap_successfactors_onboarding_list_compliance_form_dataThis entity stores the compliance form data for the new hire.
sap_successfactors_onboarding_list_compliance_form_signatureThis entity stores the Compliance form signature assigned to the new hire.
sap_successfactors_onboarding_list_compliance_processThis entity represents the compliance workflow assigned to a new hire.
sap_successfactors_onboarding_list_compliance_process_taskThis entity allows you to store the start time, end time, and the status of a particular compliance task.
sap_successfactors_onboarding_list_onboarding_newhire_v1_journeys_journey_idGet the Onboarding journey
sap_successfactors_onboarding_list_rest_onboarding_customtasks_v2_custom_tasks_task_data_idGets custom task information by task ID.
sap_successfactors_onboarding_update_onboarding_newhire_v1_journeysResource to mass cancel onboarding journeys
sap_successfactors_onboarding_update_rest_onboarding_customtasks_v2_custom_tasks_task_data_idAPI to update custom task status.

sap_successfactors_onboarding_create_create_onboardee

This function import enables you to create an onboarding external user record in the system with information collected from your external Applicant Tracking System (ATS). It also enables you to perform preliminary checks to understand if the onboardee is a new hire or a rehire and take actions as necessary.

sap_successfactors_onboarding_create_initiate_onboarding_for_user

After an external user record is created and Employee Central data is added to the record, you can use this funtion import to initiate onboarding process from an external Application Tracking System. It modifies the ONB2Process and ONB2ProcessTrigger MDF objects. All Employee Central entities (PerPerson, EmpJob, EmpEmployment) should be upserted prior to this call.

sap_successfactors_onboarding_create_onboarding_newhire_v1_journeys

Mass Initiate Onboarding Journeys Parameters:
ParameterTypeRequiredDefaultDescription
newHireCreateJourneyRequestsany[]NoArray of Onboarding Journey

sap_successfactors_onboarding_get_assigned_compliance_form

Get entity from AssignedComplianceForm by key Parameters:
ParameterTypeRequiredDefaultDescription
idstringYeskey: id
$selectany[]NoSelect properties to be returned, see OData Select
$expandany[]NoExpand related entities, see OData Expand

sap_successfactors_onboarding_get_compliance_document_flow

Get entity from ComplianceDocumentFlow by key Parameters:
ParameterTypeRequiredDefaultDescription
documentFlowCodestringYeskey: documentFlowCode
$selectany[]NoSelect properties to be returned, see OData Select
$expandany[]NoExpand related entities, see OData Expand

sap_successfactors_onboarding_get_compliance_form_data

Get entity from ComplianceFormData by key Parameters:
ParameterTypeRequiredDefaultDescription
externalCodestringYeskey: externalCode
$selectany[]NoSelect properties to be returned, see OData Select
$expandany[]NoExpand related entities, see OData Expand

sap_successfactors_onboarding_get_compliance_form_signature

Get entity from ComplianceFormSignature by key Parameters:
ParameterTypeRequiredDefaultDescription
ComplianceFormData_externalCodestringYeskey: ComplianceFormData_externalCode
externalCodestringYeskey: externalCode
$selectany[]NoSelect properties to be returned, see OData Select

sap_successfactors_onboarding_get_compliance_process

Get entity from ComplianceProcess by key Parameters:
ParameterTypeRequiredDefaultDescription
processIdstringYeskey: processId
$selectany[]NoSelect properties to be returned, see OData Select
$expandany[]NoExpand related entities, see OData Expand

sap_successfactors_onboarding_get_compliance_process_task

Get entity from ComplianceProcessTask by key Parameters:
ParameterTypeRequiredDefaultDescription
taskIdstringYeskey: taskId
$selectany[]NoSelect properties to be returned, see OData Select
$expandany[]NoExpand related entities, see OData Expand

sap_successfactors_onboarding_list_assigned_compliance_form

This entity contains the compliance forms assigned to new hires. Parameters:
ParameterTypeRequiredDefaultDescription
$topintegerNoShow only the first n items, see OData Paging - Top
$skipintegerNoSkip the first n items, see OData Paging - Skip
$searchstringNoSearch items by search phrases, see OData Searching
$filterstringNoFilter items by property values, see OData Filtering
$countbooleanNoInclude count of items, see OData Count
$orderbyany[]NoOrder items by property values, see OData Sorting
$selectany[]NoSelect properties to be returned, see OData Select
$expandany[]NoExpand related entities, see OData Expand

sap_successfactors_onboarding_list_compliance_document_flow

This entity stores the Compliance document flow assigned to the new hire. Parameters:
ParameterTypeRequiredDefaultDescription
$topintegerNoShow only the first n items, see OData Paging - Top
$skipintegerNoSkip the first n items, see OData Paging - Skip
$searchstringNoSearch items by search phrases, see OData Searching
$filterstringNoFilter items by property values, see OData Filtering
$countbooleanNoInclude count of items, see OData Count
$orderbyany[]NoOrder items by property values, see OData Sorting
$selectany[]NoSelect properties to be returned, see OData Select
$expandany[]NoExpand related entities, see OData Expand

sap_successfactors_onboarding_list_compliance_form_data

This entity stores the compliance form data for the new hire. Parameters:
ParameterTypeRequiredDefaultDescription
$topintegerNoShow only the first n items, see OData Paging - Top
$skipintegerNoSkip the first n items, see OData Paging - Skip
$searchstringNoSearch items by search phrases, see OData Searching
$filterstringNoFilter items by property values, see OData Filtering
$countbooleanNoInclude count of items, see OData Count
$orderbyany[]NoOrder items by property values, see OData Sorting
$selectany[]NoSelect properties to be returned, see OData Select
$expandany[]NoExpand related entities, see OData Expand

sap_successfactors_onboarding_list_compliance_form_signature

This entity stores the Compliance form signature assigned to the new hire. Parameters:
ParameterTypeRequiredDefaultDescription
$topintegerNoShow only the first n items, see OData Paging - Top
$skipintegerNoSkip the first n items, see OData Paging - Skip
$searchstringNoSearch items by search phrases, see OData Searching
$filterstringNoFilter items by property values, see OData Filtering
$countbooleanNoInclude count of items, see OData Count
$orderbyany[]NoOrder items by property values, see OData Sorting
$selectany[]NoSelect properties to be returned, see OData Select

sap_successfactors_onboarding_list_compliance_process

This entity represents the compliance workflow assigned to a new hire. Parameters:
ParameterTypeRequiredDefaultDescription
$topintegerNoShow only the first n items, see OData Paging - Top
$skipintegerNoSkip the first n items, see OData Paging - Skip
$searchstringNoSearch items by search phrases, see OData Searching
$filterstringNoFilter items by property values, see OData Filtering
$countbooleanNoInclude count of items, see OData Count
$orderbyany[]NoOrder items by property values, see OData Sorting
$selectany[]NoSelect properties to be returned, see OData Select
$expandany[]NoExpand related entities, see OData Expand

sap_successfactors_onboarding_list_compliance_process_task

This entity allows you to store the start time, end time, and the status of a particular compliance task. Parameters:
ParameterTypeRequiredDefaultDescription
$topintegerNoShow only the first n items, see OData Paging - Top
$skipintegerNoSkip the first n items, see OData Paging - Skip
$searchstringNoSearch items by search phrases, see OData Searching
$filterstringNoFilter items by property values, see OData Filtering
$countbooleanNoInclude count of items, see OData Count
$orderbyany[]NoOrder items by property values, see OData Sorting
$selectany[]NoSelect properties to be returned, see OData Select
$expandany[]NoExpand related entities, see OData Expand

sap_successfactors_onboarding_list_onboarding_newhire_v1_journeys_journey_id

Get the Onboarding journey Parameters:
ParameterTypeRequiredDefaultDescription
journeyIdstringYesJourney Id

sap_successfactors_onboarding_list_rest_onboarding_customtasks_v2_custom_tasks_task_data_id

Gets custom task information by task ID. Parameters:
ParameterTypeRequiredDefaultDescription
taskDataIdstringYesid of Custom Task

sap_successfactors_onboarding_update_onboarding_newhire_v1_journeys

Resource to mass cancel onboarding journeys Parameters:
ParameterTypeRequiredDefaultDescription
newHireUpdateJourneyRequestsany[]NoNew Hire Update Journey Requests

sap_successfactors_onboarding_update_rest_onboarding_customtasks_v2_custom_tasks_task_data_id

API to update custom task status. Parameters:
ParameterTypeRequiredDefaultDescription
taskDataIdstringYesid of Custom Task
statusstringNoStatus of task. Valid Values OPEN, COMPLETED