Paged List Entity (2017/01)
1 min
The paged list entity is structured as follows:
entity:
- Items List<T>: The subset of items contained only within this one page of the complete list of entities
- TotalItemCount int: The number of requested entities contained within the whole network
- MatchingItemCount int: The number of requested entities contained within the whole network which match the filter criteria specified in the request
- PageSize int: The maximum number of objects that can be contained in the response body. 100 is the default and also the maximum.
- NextMarker string: The marker of the last item in the paged subset. This value is useful if the IsTruncated entry in the response body indicates that the number of device webpage instances exceeds the PageSize.
- IsTruncated bool: Whether or not there are additional pages in the subset. If this value is True, add NextMarker in your URL "marker" parameter to get the next paged subset (you can also include the "PageSize" option if the "marker" parameter is present).
- SortExpression string: An expression that has been previously applied to the list of returned items. Note that:
- If the customer does not supply an expression, the default expression will be calculated.
- The sort expression specifies the entry used for sorting, and the ascending/descending (ASC/DESC) sorting order. For example, "[Device].[Serial] ASC" is the default setting for devices (by serial number in ascending order), but the default setting will change depending on what entity type is being returned by the paged list call.
- The server will parse, validate, and clarify the expression, so the returned expression might be slightly different than the expression provided by the customer.