Obter ferramentas

Obtenha todas as ferramentas disponíveis no espaço de trabalho.

Cabeçalhos

xi-api-keystringOpcional

Parâmetros de consulta

searchstring or nullOpcional

Se especificado, o endpoint retorna somente ferramentas cujos nomes começam com esta string.

page_sizeinteger or nullOpcional1-100

Quantidade máxima de documentos a retornar. Não pode exceder 100; o padrão é 30.

show_only_owned_documentsbooleanOpcionalPadrão é falseDeprecated

Se definido como true, o endpoint retornará apenas ferramentas que pertencem a você, e não compartilhadas por outras pessoas. Obsoleto: use created_by_user_id.

created_by_user_idstring or nullOpcional

Filtre ferramentas pelo ID do usuário criador. Quando definido, retorna apenas ferramentas criadas por esse usuário. Tem precedência sobre show_only_owned_documents. Use ‘@me’ para se referir ao usuário autenticado.

typeslist of enums or nullOpcional

Se presente, o endpoint retornará apenas ferramentas dos tipos informados.

Valores permitidos:
sort_directionenumOpcional

A direção para ordenar os resultados

Valores permitidos:
sort_byenum or nullOpcional
O campo pelo qual ordenar os resultados
Valores permitidos:
cursorstring or nullOpcional

Usado para buscar a próxima página. O cursor é retornado na resposta.

Resposta

Resposta bem-sucedida

toolslist of objects
has_moreboolean
next_cursorstring or nullOpcional

Erros

422
Unprocessable Entity Error