Destinations

Export

Export dataslice metadata and/or nodes to a configured destination.

This endpoint supports exporting data from a dataslice or data connector to a destination system. For small datasets (fewer than 100 files), the export runs synchronously. For larger datasets, the export is processed in the background and returns a tracker ID for monitoring progress.

Request Body

Field	Type	Required	Description
`dataslice_id`	`str`	No	The ID of the dataslice to export. Required if `datasource_id` is not provided.
`datasource_id`	`UUID`	No	The id of the data connector to export from. Required if `dataslice_id` is not provided.
`destination_id`	`UUID`	Yes	The id of the configured destination to export to.
`export_tag_ids`	`List[str]`	No	Ids of the tags to export. If empty, all tags are exported.
`export_level`	`ExportLevel`	No	Level of export: `"file"`, `"chunk"`, or `"both"` (default: `"both"`).
`export_nodes`	`bool`	No	Whether to export node data (default: `true`).
`export_metadata`	`bool`	No	Whether to export metadata (default: `true`).
`copy_originals`	`bool`	No	Databricks only: copy original file bytes into the UC Volume (default: `false`).
`metadata_format`	`MetadataStorageFormat`	No	Format for metadata storage: `"column_store"` or `"json_store"`.

Response

200: Export completed or initiated successfully
- Returns: ExportDatasliceDestinationResponse with:
  - message: Status message
  - success: Number of successfully exported items
  - failed: Number of failed exports
  - failed_items: List of items that failed to export
  - failed_tags: List of tags that failed to export (if applicable)
  - tracker_id: Progress tracker ID for background exports (only for large datasets)
400: Bad Request (e.g., missing required parameters)
500: Internal Server Error

Example Request

{
  "dataslice_id": "550e8400-e29b-41d4-a716-446655440000",
  "destination_id": "9a1e3c5b-7d2f-4b6a-8e0c-3f5d7b9a1c2e",
  "export_tag_ids": ["2d9b1f4e-8c3a-4e7b-a1d6-5f0c9e2b7a48"],
  "export_level": "both",
  "export_nodes": true,
  "export_metadata": true,
  "metadata_format": "column_store"
}

Example Response (Synchronous)

{
  "message": "Export completed successfully",
  "success": 45,
  "failed": 0,
  "failed_items": [],
  "failed_tags": null,
  "tracker_id": null
}

Example Response (Background Processing)

{
  "message": "Export started in background. Use tracker_id to monitor progress.",
  "success": 0,
  "failed": 0,
  "failed_items": [],
  "failed_tags": null,
  "tracker_id": "export-12345678-90ab-cdef-1234-567890abcdef"
}

POST

dataslice

export

metadata

destination

Python

# pip install deasy-sdk
import os
from deasy import DeasyClient

client = DeasyClient(
    base_url=os.environ["UNSTRUCTURED_CLIENT_BASE_URL"],
    username=os.environ["UNSTRUCTURED_USERNAME"],
    password=os.environ["UNSTRUCTURED_PASSWORD"],
)

response = client.destination.export(
    destination_name="example_destination_name",
)
print(response.message)

{
  "message": "<string>",
  "success": 123,
  "failed": 123,
  "failed_items": [
    "<string>"
  ],
  "failed_tags": [
    "<string>"
  ],
  "tracker_id": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

destination_id

string<uuid>

required

dataslice_id

string | null

datasource_id

string<uuid> | null

job_id

string | null

export_tag_ids

string[]

export_level

enum<string>

default:both

Available options:

file,

chunk,

both

export_nodes

boolean

default:true

export_metadata

boolean

default:true

copy_originals

boolean

default:false

metadata_format

enum<string> | null

Available options:

column_store,

json_store

apply_purview_labels

boolean

default:false

Response

Successful Response

message

string

required

success

integer

required

failed

integer

required

failed_items

string[]

required

failed_tags

string[] | null

tracker_id

string | null

⌘I

Python

# pip install deasy-sdk
import os
from deasy import DeasyClient

client = DeasyClient(
    base_url=os.environ["UNSTRUCTURED_CLIENT_BASE_URL"],
    username=os.environ["UNSTRUCTURED_USERNAME"],
    password=os.environ["UNSTRUCTURED_PASSWORD"],
)

response = client.destination.export(
    destination_name="example_destination_name",
)
print(response.message)

{
  "message": "<string>",
  "success": 123,
  "failed": 123,
  "failed_items": [
    "<string>"
  ],
  "failed_tags": [
    "<string>"
  ],
  "tracker_id": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Overview

Data Connectors

Tags

Taxonomies

Metadata

Data Slices

Deduplication

Destinations

Workflows

Task Tracking

Export

Request Body

Response

Example Request

Example Response (Synchronous)

Example Response (Background Processing)

Authorizations

Body

Response