Description
The API dataProductDelivery service provides the ability to request, run and download Data Products for the following:
- Locations & Device Categories
- Locations, Device Categories & Properties
- Locations & Properties
- Devices
- Devices & Properties
Downloading a data product is done with a three step process:
1. Request a data product creation task to be defined using the request method
Validates request parameters, creates a new request definition and provides performance estimates
- Use filters to supply the Who, What, Where, When and How of the data product request
- Who: Token
- What: Device Category and/or Property
- Where: Location or Device
- When: Begin and End date/time
- How: Data Product, extension and Data Product Options
- Use filters to supply the Who, What, Where, When and How of the data product request
2. Run the data product request using the run method
Starts the data product generation process by adding the request to the Task Queue
3. Download the data product using the download method
Attempts to download a file at an index. If the file at that index has not been available for download at the time of the download request, the service will return information about the status of the process. The client application will need to continue to request the download until the file is ready to be downloaded, or an error is encountered.
URL
http://dmas.uvic.ca/api/dataProductDelivery
Method | Description | Example |
---|---|---|
request | Retrieve raw data available at given station. |
|
run | Run the search generated by request |
|
download | Download one result file for a data product. |
|
request
The request method creates a search and returns information regarding the number of files, file size, compressed file size, and estimated download times as well as a request id that can be used to run the data product using the run method.
Parameters
Parameter | Type | Description | Example |
---|---|---|---|
Required | |||
token | string | All Web Services require a token. This can be generated at http://dmas.uvic.ca/Profile. Click on the "Web Services" tab and click "Generate Token" | token=5ba514e8-1203-428c-8835-879c8173e387 |
dataProductCode | string | Request a Data Product for a specific Data Product Code
| dataProductCode=TSSD |
extension | string | Request a Data Product for a specific File Format Extension
| extension=csv |
begin | datetime | Request a Data Product for data starting at a specific date/time Date Time format: yyyy-MM-dd'T'HH:mm:ss'.'SSS'Z'
| begin=2016-07-25T00:00:00.000Z |
end | datetime | Request a Data Product for data ending at a specific date/time Date Time format: yyyy-MM-dd'T'HH:mm:ss'.'SSS'Z'
| end=2016-07-29T00:00:00.000Z |
Conditionally Required | |||
locationCode | string | Request a Data Product for data from a specific Location
| locationCode=BACAX |
deviceCategoryCode | string | Request a Data Product for data from devices belonging to a specific Device Category
| deviceCategoryCode=ADCP2MHZ |
deviceCode | string | Request a Data Product for data from a specific Device
| deviceCode=AandOpt0581 |
propertyCode | string | Request a Data Product for data for a specific Property
| property=pressure |
Data Product Options | string | Each Data Product Extension may have required data product options that determine how to process or package the data.
| dpo_qualityControl=1 dpo_resample=average dpo_average=600 |
Determining Search Type (Valid combinations)
Search Type Equivalent | Parameters Given |
---|---|
Instrument by location (Device Level) | locationCode, deviceCategoryCode |
Instrument by location (Sensor Level) | locationCode, deviceCategoryCode, propertyCode |
Instrument by Category (Device Level) | deviceCode |
Instrument by Category (Sensor Level) | deviceCode, propertyCode |
Variable by Location | locationCode, propertyCode |
Response
Detailed information will be returned if the files are in archive. If the data product needs to be generated, only a dpRequestId will be returned.
Success for files from Archive (HTTP 200)
{ "compressedFileSize" :12563408, "downloadTimes" :{ "10Mbps" :7.076623, "50Mbps" :1.4153247, "150Mbps" :0.47177488}, "dpRequestId" :1852695, "fileSize" :70766230, "numFiles" :4} |
Property | Type | Description | Example |
---|---|---|---|
dpRequestId | integer | Returns a numerical request id to be passed into the "run" method (SearchHdrId) | "dpRequestId":1852695 |
numFiles | integer | Returns the number of files that meet the criteria of the search | "numFiles":4 |
fileSize | Long | The file size (in bytes) | "fileSize":70766230 |
compressedFileSize | Long | The file size (in bytes) after compression | "compressedFileSize":12563408 |
downloadTimes | String':'Float | A set of three common download speeds and the time (in seconds) it would take to download the files for each speed | "downloadTimes":{"10Mbps":7.076623,"50Mbps":1.4153247,"150Mbps":0.47177488} |
Success for generated data products (HTTP 200)
{ "dpRequestId" :1908432, "estimatedFileSize" : "11940760" , "estimatedProcessingTime" : "21" } |
Property | Type | Description | Example |
---|---|---|---|
dpRequestId | integer | Returns a numerical request id to be passed into the "run" method (SearchHdrId) | "dpRequestId":1908432 |
estimatedFileSize | string | The estimated file size (in bytes) | "estimatedFileSize":"11940760" or "estimatedFileSize":"no estimated file size avalible." |
estimatedProcessingTime | string | The estimated time it will take to process the data proeuct | "estimatedProcessingTime":"21" or "estimatedProcessingTime":"No processing time estimates found for this type of data." |
Bad Request (HTTP 400)
errorCode | errorMessage | Description |
---|---|---|
25 | Invalid Time Range, Start Time is in the future. | Occurs when the end is before the begin date/time.
|
127 | Invalid parameter value | Occurs when an invalid code is used in the filter. Most filters require an exact match, otherwise this error will occur.
|
128 | Missing parameter | Occurs when multiple parameters are needed, but not all are present. Occurs when begin is used without end
|
128 | Requested type can not be determined | Occurs when the one of the 5 possible parameter combinations is not used.
"possible parameter combinations are: locationCode, deviceCategoryCode; locationCode, deviceCategoryCode, propertyCode; locationCode, propertyCode; deviceCode; deviceCode, propertyCode" |
129 | Invalid parameter name | Occurs when a filter parameter is used, but is not supported. |
Examples
- Request a 'Log File' data product in 'txt' format, using a Data Product Code of LF and Extension of 'txt' for Device Category Code of 'ADCP2MHZ' at the Location Code of 'BACAX', Between July 25th and 28th, 2016
- Request a 'Time Series Scalar Data' data product in 'csv' format, using a Data Product Code of 'TSSD' and Extension of 'csv' for the Property Code of 'salinity' at the 'Barkley Canyon Axis (Pod 1) location using the Location Code of 'BACAX', Between July 1st and 12th, 2017
run
The run method runs the data product created by a call to the request method.
Parameters
Parameter | Type | Description | Example |
---|---|---|---|
Required | |||
dpRequestId | integer | A dpRequestId returned from the request method. (SearchHdrId) | dpRequestId=1852695 |
Response
Success (HTTP 200)
{ "dpRunIds" :[4132289]} |
Property | Type | Description | Example |
---|---|---|---|
dpRunIds | integer | A list of Ids that can be used to download the data product when processing is complete. (SearchId) | "dpRunIds":[4132289] |
Bad Request (HTTP 400)
errorCode | errorMessage | Description |
---|---|---|
127 | Invalid search header ID. | Occurs when an invalid Request ID is used in the dpRequestId paramters. |
127 | Search header has already run. | Occurs when the same run request is made. |
128 | Missing parameter | Occurs when multiple parameters are needed, but not all are present. Occurs when begin is used without end
|
129 | Invalid parameter name | Occurs when a filter parameter is used, but is not supported. |
Example
download
The download method downloads a file for the specified data product search. The file to download is specified by index with the first valid index being 1 and the last being the total number of files generated by the search.
Parameters
Parameter | Type | Description | Example |
---|---|---|---|
Required | |||
dpRunId | integer | The dpRunId returned from the run method. (SearchId) | |
index | integer | The index of the file to be downloaded, valid values are 1 to the number of result files. If the index is greater than the number of result files a response code of 204, indicating no file at that index is returned. | |
Optional | |||
None |
Response
Success
HTTP status code 200 will be returned in HTTP header and the requested file will be downloaded.
Response Codes
Response Code | Description |
---|---|
200 - Ok | The file is included in the payload. |
202 - Accepted | The data product and index are valid but the data product is still being processed. This status can be used to poll waiting for data product completion. The payload includes the comment as displayed in the GUI. |
204 - No Content | There is no result file for the data product at the index specified. This can be used to stop looping through result files when the actual number of result files isn't known. |
400 - Bad Request | Missing required parameters |
dpRunId is not a number | |
index is not a positive number or not meta | |
dpRunId is not a valid data product run Id | |
The data product selected by dpRunId was run by a different user | |
Index is meta but the data product does not include metadata | |
404 - Not Found | Index number is greater than the number of files |
410 - Gone | The result file selected by dpRunId and index is not in expected location and may have been removed during FTP clean up. This can also occur if there is a lag between the time that the data product generation is complete and when the file appears on the FTP server. |
500 - Internal Server Error | This is an unhandled exception and should not occur. All 500 errors should be immediately reported and a JIRA ticket created. |
Examples
The following is an example of the return of data product that is still being processed, note that the response code in this case is 202.
{ "message" : "Running... writing data products, time range 1 of 1." } |