Versions Compared

Old Version 28

changes.mady.by.user Riny Heijdendael

Saved on

compared with

New Version 29

changes.mady.by.user Riny Heijdendael

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Purpose

Data upload (and download) can be done using various mechanisms : 

...

Panel
titleColorwhite
titleBGColorred
titleImportant note on security

The examples below are for educational purposes:

Please do read https://ec.haxx.se/usingcurl-netrc.html on the use of passwords and usernames if you plan to automate these procedures.


Code Block
# example use:
curl --netrc-file mycredentialsfile https://xyz.com

# the mycredentialsfile contains :
machine <xyz.com> login <johndoe@xyz.com> password <uf9873o^9ufwa>



Using the REST API

To test the API you may use a tool like Restlet, a plugin for Chrome browsers to test API calls before you deploy. The server responds with a HTTP code 200 in when succesful, but the response body may contain detailed error messages.

...

  • Look carefully at the path : here we use ion0999, that should be replaced by your ION.
  • You may notice that we add the filename to the path: depending on the library you may need to add that



Upload

Now we know the path is correct and we can do an upload using cURL: 

...

In case you need a testfile you may generate one (in windows) issueing "FSUtil File CreateNew temp.pgp 0x2500000"



FAQ


Question : My report states : File could not be processed due to a file decryption error, when using the API

Answer :

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:

  • Known internal gpg messages for corrupted files during API uploads: "invalid packet", "invalid encoding" and "failed". 
  • Report message that uploader users would receive in case of corrupted gpg file upload:   File could not be processed due to a file decryption error. Please make sure file is properly encrypted. 

For more information please contact WMDA support team.



Download

You may use the API also to fetch your reports : Use the following endpoint to fetch an array with filedescriptors:

...


                       

Click on Code to get raw CURL syntax:


Response should be 200:


Download full dataset

For those registries that are permitted to use the full dataset the statement below will fetch that. Please change the ION workspace to match your ION.

...