Request filtering
Every request to the API supports a certain number of parameters sent in the URL
I.e. the request api/2.0/people can be appended with several parameters,
for example api/2.0/people?startIndex=10&count=25
Parameter |
Description |
count |
Number of the elements returned. |
startIndex |
The number of elements to be skipped in the beginning. Used for response data pagination. |
sortBy |
Sort by field name. |
sortOrder |
Sorting direction. Can be "descending" or "ascending". For example, used together with sortBy:
api/2.0/people?sortBy=userName&sortOrder=descending
|
filterBy |
Filter results by field name. |
filterOp |
Filtering operation. Can be one of the following: "contains","equals","startsWith","present" |
filterValue |
Filter value. For example, used together with filterBy and filterOp:
api/2.0/people?filterBy=userName&filterOp=startsWith&filterValue=Alex
|
updatedSince |
Returns the values updated or created since a certain period of time. |