Pobierz narzędzia

Pobierz wszystkie dostępne narzędzia w obszarze roboczym.

Nagłówki

xi-api-keystringOpcjonalny

Parametry zapytania

searchstring or nullOpcjonalny

Jeśli podano, endpoint zwraca tylko narzędzia, których nazwy zaczynają się od tego ciągu.

page_sizeinteger or nullOpcjonalny1-100

Maksymalna liczba dokumentów do zwrócenia. Nie może przekraczać 100, domyślnie 30.

show_only_owned_documentsbooleanOpcjonalnyDomyślnie falseDeprecated

Jeśli ustawiono true, endpoint zwróci tylko narzędzia należące do ciebie, a nie udostępnione przez inne osoby. Przestarzałe: użyj zamiast tego created_by_user_id.

created_by_user_idstring or nullOpcjonalny

Filtruj narzędzia według ID użytkownika, który je utworzył. Po ustawieniu zwracane są tylko narzędzia utworzone przez tego użytkownika. Ma pierwszeństwo przed show_only_owned_documents. Użyj „@me”, aby wskazać uwierzytelnionego użytkownika.

typeslist of enums or nullOpcjonalny

Jeśli podano, endpoint zwróci tylko narzędzia danych typów.

Dozwolone wartości:
sort_directionenumOpcjonalny

Kierunek sortowania wyników

Dozwolone wartości:
sort_byenum or nullOpcjonalny

Pole, według którego sortować wyniki

Dozwolone wartości:
cursorstring or nullOpcjonalny

Służy do pobrania następnej strony. Kursor jest zwracany w odpowiedzi.

Odpowiedź

Pomyślna odpowiedź

toolslist of objects
has_moreboolean
next_cursorstring or nullOpcjonalny

Błędy

422
Unprocessable Entity Error