...
In case the upload succeeded, an XML response with meta information of the upload is generated. You may use this for own logging purposes. For more info you can read the full API specification.
| URL | |
|---|---|
| SERVER URL | Staging system: https://staging-dataupload.wmda.info Production system: https://dataupload.wmda.info |
| URI | /api/v2/io/ION1234/ Explanations:
|
| METHOD | PUT |
| Full URL path example | For donor for organization with ION-1234, the full path is as below: https://staging-dataupload.wmda.info/api/v2/io/ION1234/ION-1234-D.gpg |
| HEADER | Authorization and Content-Type are required, the other ones are optional |
| Authorization | basic |
| Content-Type | application/octet-stream (when your file < 128K) multipart/form-data (when your file >128K) From , Content-Type is required. |
| cX-Rename-If-Exists | true |
...
For all the files, script as below is suggested for file larger than 128K.
| Code Block | ||
|---|---|---|
| ||
curl -i -X PUT -H "Authorization:Basic d21.....uZT==" -H "Content-Type: multipart/form-data" --data-binary "@/path/to/file/ION-0999-D.gpg" "https://staging-dataupload.wmda.info/api/v2/io/ION0999/" -H "X-File-Name:ION-0999-D.gpg" |
...
| Expand |
|---|
The Dataupload's API endpoint /io streams file(s) directly to the workspace. We have detected that premature file pickups may occur and attempt to move/delete files while content is still being appended or processed. We have taken actions to reduce this behaviour by decreasing the frequency for file pickup which in turn does lower the chance for premature pick. We have also implemented gpg error validation to check integrity based on its messages. Note: Files are picked from the workspaces for processing every 10 minutes. Some key messages:
For more information please contact WMDA support team. |
Download
Download reports
You may use the API also to fetch your reports . Unfortunately, it is not one line cmd, and need 2 steps.
...
Use the following curl and endpoint to fetch an array with filedescriptors: url should use double quote or no quote in windows env:
| Code Block |
|---|
curl -H "Authorization:Basic d21.....uZT==" 'https://staging-dataupload.wmda.info/api/v2/fs/reports-ion0999/?children=f' |
You will get the result in xml format, and you can get json format, use the cmd below:
| Code Block |
|---|
curl -H "Authorization:Basic d21.....uZT==" 'https://staging-dataupload.wmda.info/api/v2/fs/reports-ion0999/?children=f&format=json' |
2. Fetch all the reports or the one you need.
...
| Code Block |
|---|
curl -O GET -H "Authorization:Basic d21.....uZT==" 'https://staging-dataupload.wmda.info/api/v2/io/reports-ion0999/$filename' -o '$filename.txt' |
In windows cmd, the -o dose not work, and the cmd is as below:
| Code Block |
|---|
curl -H "Authorization:Basic d21.....uZT==" https://staging-dataupload.wmda.info/api/v2/io/reports-ion0999/$filename > $filename.txt |
Download archived files
Download archived files will be the same as download reports. And 2 steps as above are needed.
The example URL for archive folder is as below:
| Code Block |
|---|
https://staging-dataupload.wmda.info/api/v2/fs/archive-ion0999/?children=f |
In RESTLET :
Click on Code to get raw CURL syntax:
...
| Code Block |
|---|
curl -O GET -H "Authorization:Basic .............." 'https://dataupload.wmda.info/api/v2/io/downloads/ION1804/bmdw4data.zip.gpg' -o 'wmda_data_v22.zip.gpg' |
In windows cmd, the -o dose not work, and the cmd is as below:
| Code Block |
|---|
curl -H "Authorization:Basic .............." "https://dataupload.wmda.info/api/v2/io/downloads/ION1804/bmdw4data.zip.gpg" > wmda_data_v22.zip.gpg |
We noticed sometimes the download maybe terminated because of some temp network limitation, and the "-C -" option can be used to continue the download.
-v is for more details of the track info
| Code Block |
|---|
curl -v -H "Authorization:Basic .............." -o 'wmda_data_v22.zip.gpg' -C - 'https://dataupload.wmda.info/api/v2/io/downloads/ION1804/wmda_data_v22.zip.gpg' |