このリソースに GET リクエストを実行して、チームリストを取得します。
GET /api/v2/teams/
HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept
X-API-Node: localhost
X-API-Time: 0.080s
返されるデータ構造には以下のものが含まれます。
{
"count": 0,
"next": null,
"previous": null,
"results": [
...
]
}
count フィールドはクエリーで見つかったチームの合計数を示します。next および previous フィールドは、単一ページに収まらない結果がある場合に、それらの結果へのリンクを提供します。results にはチームのレコードが一覧表示されますが、ゼロの場合もあります。
各チームのデータ構造には以下のフィールドが含まれます。
id: チームのデータベース ID (整数)type: チームのデータタイプ (選択)url: チームの URL (文字列)related: 関連リソースの URL のあるデータ構造 (オブジェクト)summary_fields: 関連リソースの名前/説明のあるデータ構造 (オブジェクト)created: チーム作成時のタイムスタンプ (日時)modified: チームの最終更新時のタイムスタンプ (日時)name: (文字列)description: (文字列)organization: (フィールド)特定の順番でチームが返されることを指定するには、order_by クエリー文字列のパラメーターを GET リクエストで使用します。
?order_by=name
逆の順序に並び替えるには、フィールド名の前にダッシュ - を加えます。
?order_by=-name
フィールド名をコンマ , 区切りにすると、複数のフィールドの並び替えを指定できます。
?order_by=name,some_other_field
各リクエストで返される結果数を変更するには、page_size クエリー文字列パラメーターを使用します。特定のページの結果を取得するには、page クエリー文字列パラメーターを使用します。
?page_size=100&page=2
結果で返される previous および next のリンクは、これらのクエリー文字列パラメーターを自動的に設定します。
モデルの指定された全テキストフィールド内で大文字小文字の区別のない検索を実行するには、search クエリー文字列のパラメーターを使用します。
?search=findme
関連フィールドを検索します (AWX 1.4 / Ansible Tower 3.1 で追加)。
?related__search=findme
特定の値に一致する結果一覧に対して、追加のクエリー文字列パラメーターを使ってフィルタリングすることもできます。このフィルタリングに使用できるのは、データベースに存在するフィールドと関係のみです。指定された値の特殊文字は、エンコードされた URL にする必要があります。例を示します。
?field=value%20xyz
フィールドは関係にまで及ぶ可能性がありますが、その場合はデータベースで定義されたフィールドと関係に限定されます。
?other__field=value
特定の基準に一致する結果を除外するには、フィールドパラメーターの前に not__ を追加します。
?not__field=value
デフォルトでは、クエリー文字列フィルターはすべて AND 条件になっているので、すべての フィルターに一致する結果のみが返されます (AWX 1.4 で追加)。複数基準の いずれか に一致する結果にまとめるには、各クエリー文字列パラメーターの前に or__ を追加します。
?or__field=value&or__field=othervalue
?or__not__field=value&or__field=othervalue
デフォルトの AND 条件のフィルタリングでは、データベース関係全体でフィルタリングされている関連オブジェクトそれぞれに同時に全フィルターが適用されます (Ansible Tower 1.4.5 で追加) 。チェーンフィルター (chain) では、フィルターを個別に関連オブジェクトごとに適用します。これを使用するには、chain__ をクエリー文字列パラメーターの前に追加します。
?chain__related__field=value&chain__related__field2=othervalue
?chain__not__related__field=value&chain__related__field2=othervalue
上記で最初のクエリーが ?related__field=value&related__field2=othervalue となっていれば、同一の関連オブジェクトが両方の条件を満たしているプライマリーオブジェクトのみが返されますが、上記通りのチェーンフィルターを使用すると、各条件に一致するプライマリーオブジェクトの共通集合が返されます。
フィールド名に lookup を追加すると、より詳細なクエリーによるフィールドルックアップが可能になります。
?field__lookup=value
以下のフィールドのルックアップがサポートされています。
exact: 完全一致 (指定されない場合のデフォルトのルックアップ)iexact: 大文字小文字の区別のない exactcontains: フィールドに値を含むicontains: 大文字小文字の区別のない containsstartswith: 値で始まるフィールドistartswith: 大文字小文字の区別のない startswithendswith: 値で終わるフィールドiendswith: 大文字小文字の区別のない endswithregex: 特定の正規表現に一致するフィールドiregex: 大文字小文字の区別のない regexgt: Greater than の比較条件gte: Greater than or equal to の比較条件lt: Less than の比較条件lte: Less than or equal to の比較条件isnull: 特定フィールドもしくは関連オブジェクトが null かどうかをチェック。ブール値を想定in: 特定フィールドの値が提供されたリストに存在するかどうかをチェック。アイテムのリストを想定ブール値は true の場合 True または 1 を、false の場合は False または 0 を指定します (どちらも大文字小文字の区別なし)。
Null 値は None または Null (どちらも大文字小文字の区別なし) を指定できますが、isnull ルックアップを使用して明示的に null 値をチェックすることが推奨されます。
in ルックアップのリストは、値をコンマ区切りのリストとして指定することができます。
クエリー文字列のパラメーターによるユーザーのアクセスレベルのリクエストをベースにしたフィルタリング (Ansible Tower 3.1 で追加)。
role_level: フィルターをかけるロールのレベル。例、admin_role新規チームを作成するには、以下のチームフィールドを使ってリソースに POST リクエストを実行します。
name: (文字列。必須)description: チームのオプションでの説明 (文字列。デフォルトは "")organization: (フィールド。必須)オプションエンドポイント テーブルでは、このエンドポイントのオプションを確認できます。ブラウザー表示が可能な API でエンドポイントを表示している場合は、「オプション」ボタンをクリックすると以下の raw JSON が表示されます。
| name | Team List | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| description | # List Teams: Make a GET request to this resource to retrieve the list of teams. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| renders |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| parses |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| added_in_version | 1.2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| actions |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| types |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| search_fields |
|