このリソースに GET リクエストを実行して、チームリストを取得します。
GET /api/v1/teams/
HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, POST, HEAD, OPTIONS
X-API-Time: 0.046s
返されるデータ構造には以下のものが含まれます。
{
"count": 0,
"next": null,
"previous": null,
"results": []
}
count
フィールドはクエリーで見つかったチームの合計数を示します。next
および previous
フィールドは、単一ページに収まらない結果がある場合に、それらの結果へのリンクを提供します。results
にはチームのレコードが一覧表示されますが、ゼロの場合もあります。
各チームのデータ構造には以下のフィールドが含まれます。
id
: チームのデータベース ID (整数)type
: チームのデータタイプ (複数選択)team
: チームurl
: チームの URL (文字列)related
: 関連リソースの URL のあるデータ構造 (オブジェクト)summary_fields
: 関連リソースの名前/説明のあるデータ構造 (オブジェクト)created
: チーム作成時のタイムスタンプ (日時)modified
: チームの最終更新時のタイムスタンプ (日時)name
: (文字列)description
: (文字列)organization
: (フィールド)新規チームを作成するには、以下のチームフィールドを使ってリソースに POST リクエストを実行します。
name
: (文字列。必須)description
: (文字列。デフォルトは ""
)organization
: (フィールド。デフォルトは None)オプションエンドポイント テーブルでは、このエンドポイントのオプションを確認できます。ブラウザー表示が可能な 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 |
|