ListInfo

attributes

Name	Type	Read	Write	Hidden	Optional
limit	Integer	True	True	False	False
offset	Integer	True	True	False	False
order	Ordering	True	True	False	True
search_parameters	Dict<Unicode>	True	True	False	True

Attributes Comments

limit

the number of elements that should be returned in the ResultSet Object if -1 is passed, then all the elements will be returned

offset

the element to start from and to return in the ResultSet

Json example


{
  "__type__": "ListInfo",
  "__properties__": {
    "limit": -1,
    "offset": 0,
    "order": {
            "__type__": "Ordering",
            "__properties__": {
            "asc": true,
            "order_by": "something"
        }
    },
    "search_parameters":     {
            "__sub_type__": "Boolean",
            "__elements__": {
              "key2": "value1",
              "key1": "value2"
            },
            "__type__": "Dict"
    }
  }
}

Search Criteria

The search criteria are made in order to explicitely define parameters that can be passed inside the search_parameters of the ListInfo structure.
The ListInfo search_parameters attribute is a dictionnary of string, this is why the behavior of search_criteria is a little different from usual behavior.
On the server side, the type of the attribute will be checked, even though it is a string. If a search_parameters key is not in the search criterias, then it will fail.

Order by Criteria

The order by criteria is made in order to explicitely define parameters that can be passed inside the order_by parameter of the ListInfo structure
On the server side, the type of the attribute will be checked, even though it is a string. If a search_parameters key is not in the order by criterias, then the will fail