Download API Function

This function is used to download files containing all of the detailed information in captures via the Capture API.

/capture/download

This may be a GET or POST request.

For example, the full URL on the server mycompanyname in site default would be….

https://mycompanyname/s/default/capture/download?name=mycapturetype

format: Currently, csv, html and txt are supported
name: The code of the capture type.
inline: Include this parameter to return the content as inline text instead of a file download.

Filter Parameters

You can filter the list by adding parameters named after the attributes you are capturing.

These parameter names are in lowercase and ignore all space, minus and underscore characters - an attribute called “Max Power Use” will be 'maxpoweruse'.

Note: The download function does not download any captures that have been set to 'invisible'.

The response is a CSV or TXT stream.

If we wanted to filter the list, we could use…

https://mycompanyname/s/default/capture/list?name=mycapturetype&PaintingPercentage=91.963

This will search for only those captures where the Painting Percentage was equal or close to 91.963.