/sap-successfactors-onboarding | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
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 |
sap_successfactors_onboarding_get_assigned_compliance_form | Get entity from AssignedComplianceForm by key |
sap_successfactors_onboarding_get_compliance_document_flow | Get entity from ComplianceDocumentFlow by key |
sap_successfactors_onboarding_get_compliance_form_data | Get entity from ComplianceFormData by key |
sap_successfactors_onboarding_get_compliance_form_signature | Get entity from ComplianceFormSignature by key |
sap_successfactors_onboarding_get_compliance_process | Get entity from ComplianceProcess by key |
sap_successfactors_onboarding_get_compliance_process_task | Get entity from ComplianceProcessTask by key |
sap_successfactors_onboarding_list_assigned_compliance_form | This entity contains the compliance forms assigned to new hires. |
sap_successfactors_onboarding_list_compliance_document_flow | This entity stores the Compliance document flow assigned to the new hire. |
sap_successfactors_onboarding_list_compliance_form_data | This entity stores the compliance form data for the new hire. |
sap_successfactors_onboarding_list_compliance_form_signature | This entity stores the Compliance form signature assigned to the new hire. |
sap_successfactors_onboarding_list_compliance_process | This entity represents the compliance workflow assigned to a new hire. |
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. |
sap_successfactors_onboarding_list_onboarding_newhire_v1_journeys_journey_id | Get the Onboarding journey |
sap_successfactors_onboarding_list_rest_onboarding_customtasks_v2_custom_tasks_task_data_id | Gets custom task information by task ID. |
sap_successfactors_onboarding_update_onboarding_newhire_v1_journeys | Resource to mass cancel onboarding journeys |
sap_successfactors_onboarding_update_rest_onboarding_customtasks_v2_custom_tasks_task_data_id | API 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
newHireCreateJourneyRequests | any[] | No | — | Array of Onboarding Journey |
sap_successfactors_onboarding_get_assigned_compliance_form
Get entity from AssignedComplianceForm by key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | key: id |
$select | any[] | No | — | Select properties to be returned, see OData Select |
$expand | any[] | No | — | Expand related entities, see OData Expand |
sap_successfactors_onboarding_get_compliance_document_flow
Get entity from ComplianceDocumentFlow by key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentFlowCode | string | Yes | — | key: documentFlowCode |
$select | any[] | No | — | Select properties to be returned, see OData Select |
$expand | any[] | No | — | Expand related entities, see OData Expand |
sap_successfactors_onboarding_get_compliance_form_data
Get entity from ComplianceFormData by key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalCode | string | Yes | — | key: externalCode |
$select | any[] | No | — | Select properties to be returned, see OData Select |
$expand | any[] | No | — | Expand related entities, see OData Expand |
sap_successfactors_onboarding_get_compliance_form_signature
Get entity from ComplianceFormSignature by key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ComplianceFormData_externalCode | string | Yes | — | key: ComplianceFormData_externalCode |
externalCode | string | Yes | — | key: externalCode |
$select | any[] | No | — | Select properties to be returned, see OData Select |
sap_successfactors_onboarding_get_compliance_process
Get entity from ComplianceProcess by key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
processId | string | Yes | — | key: processId |
$select | any[] | No | — | Select properties to be returned, see OData Select |
$expand | any[] | No | — | Expand related entities, see OData Expand |
sap_successfactors_onboarding_get_compliance_process_task
Get entity from ComplianceProcessTask by key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | key: taskId |
$select | any[] | No | — | Select properties to be returned, see OData Select |
$expand | any[] | No | — | Expand related entities, see OData Expand |
sap_successfactors_onboarding_list_assigned_compliance_form
This entity contains the compliance forms assigned to new hires. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
$top | integer | No | — | Show only the first n items, see OData Paging - Top |
$skip | integer | No | — | Skip the first n items, see OData Paging - Skip |
$search | string | No | — | Search items by search phrases, see OData Searching |
$filter | string | No | — | Filter items by property values, see OData Filtering |
$count | boolean | No | — | Include count of items, see OData Count |
$orderby | any[] | No | — | Order items by property values, see OData Sorting |
$select | any[] | No | — | Select properties to be returned, see OData Select |
$expand | any[] | No | — | Expand 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
$top | integer | No | — | Show only the first n items, see OData Paging - Top |
$skip | integer | No | — | Skip the first n items, see OData Paging - Skip |
$search | string | No | — | Search items by search phrases, see OData Searching |
$filter | string | No | — | Filter items by property values, see OData Filtering |
$count | boolean | No | — | Include count of items, see OData Count |
$orderby | any[] | No | — | Order items by property values, see OData Sorting |
$select | any[] | No | — | Select properties to be returned, see OData Select |
$expand | any[] | No | — | Expand related entities, see OData Expand |
sap_successfactors_onboarding_list_compliance_form_data
This entity stores the compliance form data for the new hire. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
$top | integer | No | — | Show only the first n items, see OData Paging - Top |
$skip | integer | No | — | Skip the first n items, see OData Paging - Skip |
$search | string | No | — | Search items by search phrases, see OData Searching |
$filter | string | No | — | Filter items by property values, see OData Filtering |
$count | boolean | No | — | Include count of items, see OData Count |
$orderby | any[] | No | — | Order items by property values, see OData Sorting |
$select | any[] | No | — | Select properties to be returned, see OData Select |
$expand | any[] | No | — | Expand 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
$top | integer | No | — | Show only the first n items, see OData Paging - Top |
$skip | integer | No | — | Skip the first n items, see OData Paging - Skip |
$search | string | No | — | Search items by search phrases, see OData Searching |
$filter | string | No | — | Filter items by property values, see OData Filtering |
$count | boolean | No | — | Include count of items, see OData Count |
$orderby | any[] | No | — | Order items by property values, see OData Sorting |
$select | any[] | No | — | Select 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
$top | integer | No | — | Show only the first n items, see OData Paging - Top |
$skip | integer | No | — | Skip the first n items, see OData Paging - Skip |
$search | string | No | — | Search items by search phrases, see OData Searching |
$filter | string | No | — | Filter items by property values, see OData Filtering |
$count | boolean | No | — | Include count of items, see OData Count |
$orderby | any[] | No | — | Order items by property values, see OData Sorting |
$select | any[] | No | — | Select properties to be returned, see OData Select |
$expand | any[] | No | — | Expand 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
$top | integer | No | — | Show only the first n items, see OData Paging - Top |
$skip | integer | No | — | Skip the first n items, see OData Paging - Skip |
$search | string | No | — | Search items by search phrases, see OData Searching |
$filter | string | No | — | Filter items by property values, see OData Filtering |
$count | boolean | No | — | Include count of items, see OData Count |
$orderby | any[] | No | — | Order items by property values, see OData Sorting |
$select | any[] | No | — | Select properties to be returned, see OData Select |
$expand | any[] | No | — | Expand related entities, see OData Expand |
sap_successfactors_onboarding_list_onboarding_newhire_v1_journeys_journey_id
Get the Onboarding journey Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
journeyId | string | Yes | — | Journey Id |
sap_successfactors_onboarding_list_rest_onboarding_customtasks_v2_custom_tasks_task_data_id
Gets custom task information by task ID. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskDataId | string | Yes | — | id of Custom Task |
sap_successfactors_onboarding_update_onboarding_newhire_v1_journeys
Resource to mass cancel onboarding journeys Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
newHireUpdateJourneyRequests | any[] | No | — | New Hire Update Journey Requests |
sap_successfactors_onboarding_update_rest_onboarding_customtasks_v2_custom_tasks_task_data_id
API to update custom task status. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskDataId | string | Yes | — | id of Custom Task |
status | string | No | — | Status of task. Valid Values OPEN, COMPLETED |

