Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.8 KB

GeneralExportReq.md

File metadata and controls

36 lines (27 loc) · 1.8 KB

GeneralExportReq

General purpose export request, produce a zip in a job with many options.

Properties

Name Type Description Notes
project_id int The project to export.
split_by ExportSplitOptionsEnum If not none, separate (in ZIP sub-directories) output per given field. [optional]
with_images ExportImagesOptionsEnum Add in ZIP first (i.e. visible) image, all images, or no image.⚠️ 'all' means maybe several lines per object in TSVs. [optional]
with_internal_ids bool Export internal database IDs. [optional] [default to False]
with_types_row bool Add an EcoTaxa-compatible second line with types. [optional] [default to False]
only_annotations bool Only save objects' last annotation data. [optional] [default to False]
out_to_ftp bool Copy result file to FTP area. Original file is still available. [optional] [default to False]

Example

from ecotaxa_py_client.models.general_export_req import GeneralExportReq

# TODO update the JSON string below
json = "{}"
# create an instance of GeneralExportReq from a JSON string
general_export_req_instance = GeneralExportReq.from_json(json)
# print the JSON string representation of the object
print(GeneralExportReq.to_json())

# convert the object into a dict
general_export_req_dict = general_export_req_instance.to_dict()
# create an instance of GeneralExportReq from a dict
general_export_req_form_dict = general_export_req.from_dict(general_export_req_dict)

[Back to Model list] [Back to API list] [Back to README]