Connector Task APIs
Use these APIs to start, retrieve, cancel, pause, or resume a task, and retrieve the tasks list through the Salesforce Integration Service.
Tasks are long-running operations, which process large amounts of data. For example,
synchronizing an entire tenant to Salesforce. A task can process millions of
objects.
Note: A user must have the ROLE_SFDC_CONNECTOR role in order to use
them.
The task lifecycle consists of two phases:
- Collecting the data for processing: In this phase, all objects IDs that are eligible for processing are gathered and stored in an internal database.
- Processing the data: In this phase, the objects are synchronized and validated using task processors, which run in parallel.
- awaiting: The task has been created, but there are no processors available. The task starts after one of the processors is available.
- loading data: The task is collecting the list of objects to process.
- running: The task is processing the objects.
- paused: The task is paused, and resumes after the
Resume TaskAPI is run. You can only pause a task that has the status as - running. - cancelled: The task has been cancelled. After you cancel a task, it cannot be restarted.
- completed: The task has finished processing.
- failed: Some critical errors occurred that prevented the task from running. For example, lack of available space to store the list of the objects.