Search/Sort/Order for jobs, services, files, process_graphs

[m-mohr]

I'm wondering whether it could be useful to introduce searching (adopt OpenSearch parameters?) and pagination to the collections, i.e. for the list of jobs, services, files, process_graphs? File and job lists may get very long, I assume.

[m-mohr]

Idea for pagination: Pagination should not be used by default. If a client wants to use pagination it needs to send a parameter such as "count" (number of elements) or "page" (page number) with the request. In this case the endpoint returns the requested subset of elements and adds a link with next (and prev) rel types to the links array. The clients can follow these links to the other datasets. If a server does not support pagination, it should return an error such as "PaginationNotSupported" and the client can decide whether it tries again without pagination or not. Returning the full list of elements instead of an error is critical as some applications may have problems with big datasets, which may lead to a slow down/crash/... in the worst case.

As client-side searching/sorting/ordering only works with all elements (i.e. it doesn't work with pagination) this needs to be enabled server-side and therefore needs to be part of the API.