Listing Loads

<< Click to Display Table of Contents >>

Navigation:  Database API >

Listing Loads

 

Obtain a compact list of all Loads stored in the current database. The response comprises of a list of Load Ids and summary data for each one.

 

HTTP Request

 

 GET db/v1/loads 

 

 GET db/v1/loads?since=YYYY-MM-DDTHH:NN:SS.ZZZ 

 

 GET db/v1/loads?range=start:count 

 

 GET db/v1/loads?name=<filter> 

 

Parameters

 

Name

Location

Type

Description

since

URL

string

Date and time in UTC format

range

URL

integer:integer

Start row and number of rows to return

name

URL

string

Partial name match

 

Query parameters can be combined, for example:

 

GET db/v1/loads?name=001&range=1:20

 

This will return the first 20 loads whose name matches 001*

 

Required access rights

 

ADMIN, CREATE, EDIT, VIEW