Export tasks

Configure export targets, create export tasks, and obtain exported files. This page covers export-task creation, status, and reruns; it does not cover imports or connector-file management.

Prerequisites

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

Before creating a task, confirm available files or data objects to export and configure an export target as needed.

Call sequence

  1. List exportable files to identify the object to export.

  2. Configure the export target and create an export task. Retain the task ID.

  3. Query task status and details to confirm its current state. When it completes, list export files and obtain the required file.

  4. Rerun the task when it needs to run again. Delete the task only after confirming it is no longer needed.

API operations

Prepare and create an export task

What you need to do

API operation

Use it when

Query exportable files

List exportable files

Confirm available export objects before creating a task.

Configure an export target

Configure an export target

Prepare or confirm an export target before creating a task.

Create a task

Create an export task

You identified the object and target and need to create an export task.

Track tasks and obtain files

What you need to do

API operation

Use it when

Query tasks

List export tasks

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

Query task details

Get export task details

View configuration and current information for one task.

Query task status

Get export task status

Track task status.

Query export files

List export task files

Confirm and obtain files produced by a task.

Rerun a task

Rerun an export task

Run an existing task again.

Delete a task

What you need to do

API operation

Use it when

Delete a task

Delete an export task

You confirmed that the task is no longer needed.

Confirm the result

After creating or rerunning, use Get export task status and Get export task details to inspect the task. After the task produces available files, use List export task files to confirm output.

Limitations and notes

  • Creating or rerunning a task does not mean an export file is available. Use task status and export-file query results to confirm.

  • Before deletion, confirm that you no longer need to query or obtain export files through the task.

Next steps

Last updated on