Import tasks

Import local files, connector files, or external database tables into target data tables, and track tasks, files, and run records. This page covers import tasks only. To select an external database source and column mappings, first see Browse connector data sources.

Prerequisites

Prepare credentials that can access the target workspace and existing resources required by the target data table. For service endpoints, authentication, and general request formats, see Prepare to call an API.

To import through a connector, you need an existing connector ID. To import local files, use the action that uploads a local file and creates a task. Before structured loading, confirm the source table, target table, and column mapping.

Call sequence

  1. Choose a create method by source: create a task for an existing file, upload a local file and create a task, or create a structured-load task for a database table.

  2. Retain the task ID and query task details, task files, and run records. They distinguish task configuration, file processing, and individual runs.

  3. To adjust a task, update it. Pause it to stop processing temporarily, then resume it to continue.

  4. When a file fails, query its run record and file information before retrying it. Delete a task only after confirming it is no longer needed.

API operations

Create and configure tasks

What you need to do

API operation

Use it when

Create a task

Create a connector-file import task

Create an import task from an existing source file.

Upload locally and create an import task

Upload locally and create an import task

Start an import from a local file.

Create a structured database-load task

Create a structured database import task

Load data from a connector database table.

Import-task object fields

Import task response fields

Understand common fields in an import-task object.

Update a task

Update an import task

Adjust an existing task.

Track and handle tasks

What you need to do

API operation

Use it when

Query tasks

List import tasks

Find a task or confirm that it remains in the list.

Query task details

Get import task details

View current configuration and status for one task.

Query task files

List import task files

Check files associated with a task and their processing status.

Query run records

List import task runs

Check records for each run.

Pause a task

Pause an import task

Stop a task temporarily.

Resume a task

Resume an import task

Continue a paused task.

Retry failed files

Retry failed import files

You confirmed that files failed and need to process them again.

Delete a task

What you need to do

API operation

Use it when

Delete a task

Delete an import task

You confirmed that the task is no longer needed.

Confirm the result

After creating, updating, pausing, or resuming, use Get import task details to confirm current task status. Use List import task files and List import task runs to inspect processing results and failure information.

Limitations and notes

  • Creating a task means the request was submitted. Task files and run records are where you confirm actual processing.

  • Before retrying failed files, inspect failure information in the corresponding task files and run records.

  • Before deletion, confirm that you no longer need to query or process its associated files.

Next steps

Last updated on