Export Dataset As Zip

Request

path Parameters

required

string

Request Body schema: application/json

	object (DQLResourceQuery)
	object (DQLResourceQuery)
	object annotations export options
exportVersion	string `V2` - exported items will have original extension in filename, `V1` - no original extension in filenames Enum: "V1" "V2"
property name* additional property	any

Responses

200

post/datasets/{id}/export

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"itemsQuery": {"filter": {"property1": null,
"property2": null
},
"limit": 0,
"join": {"on": {"forigen": "string",
"local": "string",
"resource": "items"
}
},
"references": {"operation": "create",
"refs": [{"id": "string",
"type": "string"
}
],
"index": 0
},
"sort": {"property1": "ascending",
"property2": "ascending"
},
"select": {"property1": 0,
"property2": 0
},
"update": {"property1": null,
"property2": null
},
"delete": true,
"user": "string",
"systemSpace": true,
"queryEngine": "mongo",
"resource": "items",
"skip": 0,
"datasets": ["string"
],
"projects": ["string"
],
"page": 0,
"pageSize": 0,
"collectMetrics": true,
"countTotal": true,
"sign": {"exp": "1 hour from now"
}
},
"annotationsQuery": {"filter": {"property1": null,
"property2": null
},
"limit": 0,
"join": {"on": {"forigen": "string",
"local": "string",
"resource": "items"
}
},
"references": {"operation": "create",
"refs": [{"id": "string",
"type": "string"
}
],
"index": 0
},
"sort": {"property1": "ascending",
"property2": "ascending"
},
"select": {"property1": 0,
"property2": 0
},
"update": {"property1": null,
"property2": null
},
"delete": true,
"user": "string",
"systemSpace": true,
"queryEngine": "mongo",
"resource": "items",
"skip": 0,
"datasets": ["string"
],
"projects": ["string"
],
"page": 0,
"pageSize": 0,
"collectMetrics": true,
"countTotal": true,
"sign": {"exp": "1 hour from now"
}
},
"annotations": {"filter": "false (export will filter out items, but not annotations)",
"convertSemantic": "false",
"include": "true"
},
"exportVersion": "V1"
}

Response samples

application/json

{"id": "string",
"url": "string",
"status": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"type": "string",
"error": "string",
"progress": 0,
"spec": {"property1": null,
"property2": null
},
"report": {"property1": null,
"property2": null
}
}