DroneDeploy
Search…
Introduction
Exporter
Exporter.send
Exporter.list
Exporter.getSelectedAutoExportParams
Exporter.createAutoExport
Exporter.closePopup
Exporter.send
Orthomosaic Export
Example Call
1
dronedeployApi.Exporter.send({
2
layer: 'Orthomosaic',
3
email: ['[email protected]']
4
}).then(function(exportId){ console.log(exportId) });
Copied!
Parameters
1
const exportOptions = {
2
// required
3
layer: 'Orthomosaic',
4
email: [String, String],
5
​
6
//optional
7
file_format: ['geotiff', 'jpg'], // default to geotiff
8
merge: Boolean, // defaults to true
9
projection: Number, // defaults to 3857
10
resolution: ['native', Number], // defaults to 5 (cm/px)
11
planId: [String], // defaults to currently visible map
12
webhook: {
13
url: 'http://www.url-to-ping-on-complete.com/any-params-here' // recieve the export document when its complete
14
}
15
};
16
dronedeployApi.Exporter.send(exportOptions)
17
.then(function(exportId){ console.log(exportId) });
Copied!
NDVI Toolbox Export
Example Call
1
dronedeployApi.Exporter.send({
2
layer: 'NDVI Toolbox',
3
email: ['[email protected]']
4
}).then(function(exportId){ console.log(exportId) });
Copied!
Parameters
1
const exportOptions = {
2
// required
3
layer: 'NDVI Toolbox',
4
email: [String, String],
5
​
6
//optional
7
file_format: ['geotiff', 'jpg', 'shapefile'], // default to geotiff
8
merge: Boolean, // defaults to true
9
projection: Number, // defaults to 3857
10
resolution: ['native', Number], // defaults to 5 (cm/px)
11
planId: [String], // defaults to currently visible map
12
webhook: {
13
url: 'http://www.url-to-ping-on-complete.com/any-params-here' // recieve the export document when its complete
14
}
15
};
16
dronedeployApi.Exporter.send(exportOptions)
17
.then(function(exportId){ console.log(exportId) });
Copied!
Elevation Export
Example Call
1
dronedeployApi.Exporter.send({
2
layer: 'Elevation Toolbox',
3
email: ['[email protected]']
4
}).then(function(exportId){ console.log(exportId) });
Copied!
Parameters
1
const exportOptions = {
2
// required
3
layer: 'Elevation Toolbox',
4
email: [String, String],
5
​
6
//optional
7
file_format: ['geotiff', 'jpg', 'demtiff', 'contourshp', 'contourdxf'], // default to geotiff
8
merge: Boolean, // defaults to true
9
projection: Number, // defaults to 3857
10
resolution: ['native', Number], // defaults to 5 (cm/px)
11
contour_interval: [Number], // default to 1 (meter)
12
planId: [String], // defaults to currently visible map
13
webhook: {
14
url: 'http://www.url-to-ping-on-complete.com/any-params-here' // recieve the export document when its complete
15
}
16
};
17
dronedeployApi.Exporter.send(exportOptions)
18
.then(function(exportId){ console.log(exportId) });
Copied!
3D Export
Example Call
1
dronedeployApi.Exporter.send({
2
layer: '3D Model',
3
email: ['[email protected]']
4
}).then(function(exportId){ console.log(exportId) });
Copied!
Parameters
1
const exportOptions = {
2
// required
3
layer: '3D Model',
4
email: [String, String],
5
​
6
// optional
7
planId: [String], // defaults to currently visible map
8
webhook: {
9
url: 'http://www.url-to-ping-on-complete.com/any-params-here' // recieve the export document when its complete
10
}
11
};
12
dronedeployApi.Exporter.send(exportOptions)
13
.then(function(exportId){ console.log(exportId) });
Copied!
Point Cloud Export
Example Call
1
dronedeployApi.Exporter.send({
2
layer: 'Point Cloud',
3
email: ['[email protected]']
4
}).then(function(exportId){ console.log(exportId) });
Copied!
Parameters
1
const exportOptions = {
2
// required
3
layer: 'Point Cloud',
4
email: [String, String],
5
​
6
// optional
7
file_format: ['las', 'xyz'], // defaults to 'las'
8
max_points: ['MAX', Number], // defaults to 'MAX'
9
planId: [String], // defaults to currently visible map
10
webhook: {
11
url: 'http://www.url-to-ping-on-complete.com/any-params-here' // recieve the export document when its complete
12
}
13
};
14
dronedeployApi.Exporter.send(exportOptions)
15
.then(function(exportId){ console.log(exportId) });
Copied!
Exporter.list
Overview
List all the exports on the users account or for a specific plan.
Example Call
1
// get all exports
2
dronedeployApi.Exporter.list()
3
.then(function(exports){ console.log(exports) });
4
​
5
// get exports for planId
6
dronedeployApi.Exporter.list({planId: '5803c075d0ec0a44f0a75a86'})
7
.then(function(exports){ console.log(exports) });
Copied!
Example Response
1
[
2
{
3
"username": "[email protected]",
4
"status": "complete",
5
"plan_id": "57ffb7cf96fef40c53c89168",
6
"log": "1476376527_DANIELOPENPIPELINE",
7
"parameters": {
8
"layer": "Orthomosaic",
9
"map_id": "57ffb803cb5fda187d43a90c",
10
"projection": "3857",
11
"file_format": "geotiff",
12
"url": "https://tiles_test.dronedeploy.com/unsafe/smart/filters:crop('{setting_crop_polygon}')/https%3A%2F%2Fs3.amazonaws.com/drone.deploy.tiles/{url}/{z}/{x}/{y}.png",
13
"merge": true,
14
"env": "test",
15
"resolution": "5",
16
"email": [
17
18
],
19
"view": "58094649929d247d64aea82a"
20
},
21
"download_path": "https://s3.amazonaws.com/drone-deploy-exports/1476376527_DANIELOPENPIPELINE/UntitledMapsddfsdf_Orthomosaic_ThuOct20223610.zip?AWSAccessKeyId=AKIAISEWUBLV6Q6M3S3A&Expires=1479595007&Signature=AWSSLZIqt%2F71R540GBI2e3mif9c%3D",
22
"failure_info": 0,
23
"parameter_hash": null,
24
"id": "580946b2929d247d64aea82b",
25
"date_complete": 1477003302413,
26
"date_started": 1477002982786,
27
"date_creation": 1477002930264
28
},
29
]
Copied!
Exporter.getSelectedAutoExportParams
Overview
Gets selected parameters from Auto Exports form. Right now it returns only fileFormat.
Example Call
1
dronedeployApi.Exporter.getSelectedAutoExportParams()
2
.then((autoExportParams) => console.log(autoExportParams));
Copied!
Example Response
1
{
2
fileFormat: "geotiff"
3
}
Copied!
Exporter.createAutoExport
Overview
Creates new auto export setting.
Example Call
1
const folderConfig = { folderId: 'folderId' }; // folderConfig may contain other properties
2
dronedeployApi.Exporter.createAutoExport(folderEndpoint = 'https://fake-folder-endpoint', folderConfig)
3
.then((autoExportSetting) => console.log(autoExportSetting));
Copied!
Example Response
1
{
2
application: {
3
id: "Application:sdjncksnckd"
4
__typename: "Application"
5
}
6
dateCreation: "2019-06-03T06:35:10.974000+00:00"
7
exportParameters: {
8
emails: []
9
fileFormat: "GEO_TIFF"
10
layer: "ORTHOMOSAIC"
11
merge: true
12
projection: 3857
13
resolution: 0
14
__typename: "ExportParameters"
15
}
16
folderConfig: "{\"folder_id\": \"o9xcfDvir_dRpEwidj8LbPk\"}"
17
folderEndpoint: "https://dronedeployfunctions.com/fn-5cb9adc213a75800015a/folder-to-upload"
18
id: "AutoExportSetting:5cf4bf9e5c9f8500017b86d0"
19
project: {
20
id: "Project:123ABC456XYZ"
21
__typename: "Project"
22
}
23
__typename: "AutoExportSetting"
24
}
Copied!
Exporter.closePopup
Overview
Closes popup window with Auto Exports explorer and effectivelly stops the app that invoke this method.
Example Call
1
dronedeployApi.Exporter.closePopup();
Copied!
Last modified 2yr ago