ツールを取得

ワークスペース内の利用可能なすべてのツールを取得します。

ヘッダー

xi-api-keystringオプション

クエリパラメータ

searchstring or nullオプション

指定すると、エンドポイントは名前がこの文字列で始まるツールのみを返します。

page_sizeinteger or nullオプション1-100

返すドキュメントの最大数です。100を超えることはできず、デフォルトは30です。

show_only_owned_documentsbooleanオプションデフォルト値 falseDeprecated

trueに設定すると、エンドポイントは自分が所有するツールのみを返します(他者から共有されたものは含みません)。非推奨:代わりにcreated_by_user_idを使用してください。

created_by_user_idstring or nullオプション

作成者ユーザーIDでツールをフィルタリングします。設定すると、このユーザーが作成したツールのみを返します。show_only_owned_documentsより優先されます。認証済みユーザーを指定するには’@me’を使用してください。

typeslist of enums or nullオプション

指定した場合、エンドポイントは指定された種類のツールのみを返します。

許可された値:
sort_directionenumオプション

結果の並べ替え方向

許可された値:
sort_byenum or nullオプション

結果の並べ替えに使用するフィールド

許可された値:
cursorstring or nullオプション

次のページを取得するために使用します。カーソルはレスポンスで返されます。

レスポンス

成功レスポンス。

toolslist of objects
has_moreboolean
next_cursorstring or nullオプション

エラー

422
Unprocessable Entity Error