List API Function

This function is used to request lists of captures taken in the Capture API.

Endpoint

/capture/list

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/list?name=mycapturetype

Parameters

format: json or xml.
name: The code of the capture type.

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'.

Optional Parameters

count: The number of items to display. offset: The starting offset, used in pagination. IE. a count of '50' and offset of '100' would get items 100-150. key: A full or partial capture name to search for. more: A comma-delimited list of strings - each one being the name of an attribute to add to the response data.

Response

The response is a JSON object.

It contains start, end and count properties to help with pagination. If 'end' is ever less than 'count', there is more data to be retrieved.

{
  "start":0,
  "end":38,
  "count":38,
   "lines":[
      {"filename":"2025-08-07","key":"91.963_8.037","stamp":"2025-08-07 20:00:00","PaintingPercentage":91.963,"NotPaintingPercentage":8.037},
      {"filename":"2025-08-06","key":"91.963_8.037","stamp":"2025-08-06 20:00:00","PaintingPercentage":91.963,"NotPaintingPercentage":8.037},
      {"filename":"2025-08-05","key":"91.9595_8.0405","stamp":"2025-08-05 20:00:00","PaintingPercentage":91.9595,"NotPaintingPercentage":8.0405},
      {"filename":"2025-08-04","key":"91.9479_8.0521","stamp":"2025-08-04 20:00:00","PaintingPercentage":91.9479,"NotPaintingPercentage":8.0521},
      {"filename":"2025-08-03","key":"91.963_8.037","stamp":"2025-08-03 20:00:00","PaintingPercentage":91.963,"NotPaintingPercentage":8.037},
    ...
}

Filtering

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.

List API Function