DatasetExport

dataset_export_client.download_dataset_export(export_id)

Downloads the dataset export.

Table:Input parameters summary:

Field	Input	Type	Description
export_id	body	str	The ID of the export to be downloaded

Sample Request Body

from pprint import pprint
from tensoract.client import Tensoract


# Initialize Tensoract client
dataset_export_client = Tensoract(api_url="YOUR_API_URL",api_key="YOUR_API_KEY")

response = dataset_export_client.download_dataset_export(export_id="2023-02-06T09:07:14.8943466")
pprint(response)

Field	Type	Description
status	str	The status of the export (e.g. “COMPLETED”).
progress	str	The progress of the export (e.g. “100%”).
message	str	A message about the export status.
export_url	str	The URL to download the exported dataset file.

Sample Response

{
     "status": "COMPLETED",
     "progress": "100%",
     "message": "Use the export_url to download the project export file",
     "export_url": "https://devdocuments.objectways.com/export_2023-02-06T09:04:17.1804171_scanneddocumentdataset.manifest"
}

dataset_export_client.export_dataset(dataset_id, export_note, project_id)

Export a dataset.

Table:Input parameters summary:

Field	Input	Type	Description
dataset_id	body	str	The Id of the dataset to export
export_note	body	str	A note about the export.
project_id	body	str	The Id of the project associated with the dataset

Sample Request Body

{
     from pprint import pprint
     from tensoract.client import Tensoract


     # Initialize Tensoract client
     dataset_export_client = Tensoract(api_url="YOUR_API_URL",api_key="YOUR_API_KEY")

     response = dataset_export_client.export_dataset(dataset_id="3aa168a963f1d4dbe0b1f549",export_note="This is test export via API",project_id="449354de1168469a8229f606")
     pprint(response)

}

Table:Response summary:

Field	Type	Description
progress	str	The progress of the export.
exportId	str	The Id of the export.

Sample Response

{
      "progress": "100%",
      "exportId": "2023-03-11T07:32:44.2329426"
}

dataset_export_client.list_dataset_exports(dataset_id)

List all exports for a dataset.

Table:Input parameters summary:

Field	Input	Type	Description
dataset_id	body	str	The Id of the dataset to list exports for

Sample Request Body

{
      from pprint import pprint
      from tensoract.client import Tensoract


      # Initialize Tensoract client
      dataset_export_client = Tensoract(api_url="YOUR_API_URL",api_key="YOUR_API_KEY")

      response = dataset_export_client.list_dataset_exports(dataset_id="449354de1168469a8229f605")

      pprint(response)

}

Table:Response summary:

Field	Type	Description
exportId	str	The Id of the export.
datasetId	str	The Id of the dataset associated with the export.
created	int	The timestamp (in seconds) of when the export was created.
createdBy	str	The email address of the user who created the export.
note	str	A note about the export.
project	str	The name of the project associated with the export.
selection	bool	Whether the items are selected
items	int	The number of items included in the export.
filter	str	The filter applied to the export.
projects	lstr	The projects associated with the export.

Sample Response

[
        {
                "exportId": "2023-02-06T09:04:17.1804171",
                "datasetId": "f82570db65aa7464d1aa5a00",
                "created": 1675674257,
                "createdBy": "abc@example.com",
                "note": "export",
                "project": "",
                "selection": false,
                "items": 16,
                "filter": "",
                "projects": []
        },
        {
                "exportId": "2023-02-06T09:07:14.8943466",
                "datasetId": "f82570db65aa7464d1aa5a00",
                "created": 1675674435,
                "createdBy": "abc@example.com",
                "note": "export",
                "project": "",
                "selection": false,
                "items": 16,
                "filter": "",
                "projects": []
        }
 ]