Parametry, które można przekazywać do żądania

  • fields - lista pól, oddzielona przecinkiem, np fields=id,first_name
  • order - sortowanie wyników, np, order=id|desc,user_id|asc
  • search - wartość szukana
  • search_in - lista pól, w których ma być szukana wartość z pola search
  • limit - ilość zwracanych wyników
  • page - strona, od której wyświetlać wyniki

Przykłady zapytań:

GET /rest/issue?fields=id,subject&order=id|desc&limit=5&page=1&search=Problem&search_in=subject

Zwraca 5 pierwszy spraw (wyświetla id i temat sprawy), które w temacie zawierają słowo "Problem" posortowanych rosnąco po id sprawy

Parametry dotyczące konkretnego zasobu

Do zapytania można również dodawać parametry, które charakteryzują konkretny zasób:

GET /rest/issue_sentence?issue_id=5&status=draft,unaccepted

Zwróci wszystkie posty do sprawy o id 5, których status jest draft lub unaccepted

Parametry używane przy złączeniach

W przypadku złączonych zasobów, parametry należy prefiksować nazwą zasobu w formacie PascalCase, np.:

GET /rest/issue/issue_initiator?IssueInitiator_first_name=Jan,Adam&Issue_status=new

Zwróci listę spraw złączoną z klientami, w których imię klienta to Jan lub Adam a status sprawy to new