Page History

A dictionary of filters used to configure the data product request, to be provided to the request method from the API data product delivery service.

The data source is specified by including one of the following sets of filters:

Additionally, the following filters are mandatory:

• dataProductCode
• extension
• dateFrom
• dateTo

Depending on the data product requested, you must also include its required data product options in the filters. Otherwise, the API will return an error with instructions on what filters to add.

{
'locationCode':'BACAX',
'deviceCategoryCode':'ADCP2MHZ',
'dataProductCode':'TSSD',
'extension':'csv',
'dateFrom':'2016-07-27T00:00:00.000Z',
'dateTo':'2016-08-01T00:00:00.000Z',
'dpo_qualityControl':1,
'dpo_resample':'none',
'dpo_dataGaps':0
}

The number of times to poll the service asking if the product is ready for download, before the method aborts.

Default: 0 (no limit).

Whether the files will be downloaded or if only the download URL for each file will be returned.

• True: Files will not be downloaded. The file download URLs will be included in the method results
• False: Files are downloaded to the output path

Default: False

Indicates if the metadata file associated with the data product request will be downloaded.

• True: Metadata file will be downloaded
• False: Metadata file will not be downloaded

Default: False

True

Whether new files downloaded will overwrite previous files with the same filename found in the output directory.

• True: Overwrite files with the same filename
• False: Do not overwrite files (downloaded files with the same filename will be skipped)

Default: False