アジャイル

このリソースでは、REST API を使用して YouTrack のアジャイルボードを操作できます。

Resource	/api/agiles
Returned entity	アジャイル。エンティティ属性の説明については、サポートされているフィールドセクションを参照してください。
Supported methods	`GET` : アジャイルのリストを読む。 `POST` : 新しいアジャイルを追加します。
Supported sub-resources	/api/agiles/{agileID}: 特定のアジャイルを使った操作 /api/agiles/{agileID}/sprints: スプリント

アジャイル属性

アジャイルボード構成を表します。

Related Resources

以下に、このエンティティを操作できるリソースのリストを示します。

アジャイルボード

Attributes

このテーブルは、Agile エンティティの属性について説明しています。

サーバーからの応答で属性を受け取るには、fields 要求パラメーターでその属性を明示的に指定してください。
属性を更新するには、POST リクエストの本文にそれを指定します。

フィールド	タイプ	説明
id	文字列	アジャイルボードの ID。`Read-only`
name	文字列	アジャイルボードの名前。`Can be null`
owner	ユーザー	アジャイルボードの所有者。`Can be null`
visibleFor	UserGroup	非推奨。代わりに `readSharingSettings` 属性を使用してください。このボードを表示できるユーザーのグループ。 `Can be null` .
visibleForProjectBased	Boolean	使用すべきではありません。 `true` の場合、ボードは、ボードに関連付けられているすべてのプロジェクトを表示できるすべてのユーザーに表示されます。
updateableBy	UserGroup	非推奨。代わりに `updateSharingSettings` 属性を使用してください。このボードの設定を更新できるユーザーのグループです。 `Can be null` .
updateableByProjectBased	Boolean	使用すべきではありません。 `true` の場合、関連するプロジェクトを更新できる人は誰でもボードを更新できます。
readSharingSettings	AgileSharingSettings	このボードを表示できるユーザーとグループ。ボードが所有者のみに表示される場合、このプロパティには空の配列が含まれます。`Read-only`
updateSharingSettings	AgileSharingSettings	このウォッチフォルダーを更新できるユーザーとグループ。フォルダーの所有者のみがフォルダーを更新できる場合、このプロパティには空の配列が含まれます。`Read-only`
orphansAtTheTop	Boolean	`true` の場合、孤立したスイムレーンはボードの上部に配置されます。それ以外の場合、孤立したスイムレーンは他のすべてのスイムレーンにあります。
hideOrphansSwimlane	Boolean	`true` の場合、孤立したスイムレーンはボードに表示されません。
estimationField	CustomField	ボードの推定フィールドとして使用されるカスタムフィールド。`Can be null`
originalEstimationField	CustomField	ボードの元の推定フィールドとして使用されるカスタムフィールド。`Can be null`
projects	プロジェクトの配列	ボードに関連付けられたプロジェクトのコレクション。
sprints	スプリントの配列	ボードに関連付けられているスプリントのセット。
currentSprint	スプリント	このアジャイルボードの現在のスプリントとして指定されているスプリント。`Read-only` `Can be null`
columnSettings	ColumnSettings	ボードの列設定。`Read-only`
swimlaneSettings	SwimlaneSettings	ボードスイムレーンの設定。`Can be null`
sprintsSettings	SprintsSettings	ボードスプリントの設定。`Read-only`
colorCoding	ColorCoding	ボードの色分け設定。`Can be null`
status	AgileStatus	ボードのステータス。`Read-only`

アジャイルのリストを読む

システムで利用可能なすべてのアジャイルボードのリストを取得します。

リクエスト構文

GET /api/agiles?{fields}&{$top}&{$skip}

リクエストパラメーター

パラメーター

タイプ

説明

fields

文字列

応答で返される必要があるアジャイル属性のリスト。フィールドが指定されていない場合、entityID のみが返されます。

$skip

Int

オプション。最初のエンティティを返す前にスキップする、返されるエンティティの数を設定できます。

$top

Int

オプション。応答で返されるエントリの最大数を指定できます。$top 値を設定しない場合、サーバーは返されるエントリの最大数を制限します。

サーバーは、コレクションを返すほとんどのリソースに対して最大 42 のエントリを返します。詳細については、「ページ付け」を参照してください。

Sample

サンプルリクエスト

                https://example.youtrack.cloud/api/agiles?fields=id,name,owner(id,name),projects(id,name),sprints(id,name)&$top=3
            

応答本文のサンプル

                [
                  {
                    "owner": {
                      "name": "John Smith",
                      "id": "1-1",
                      "$type": "User"
                    },
                    "projects": [
                      {
                        "name": "Sandbox",
                        "id": "0-3",
                        "$type": "Project"
                      }
                    ],
                    "sprints": [
                      {
                        "name": "First sprint",
                        "id": "109-0",
                        "$type": "Sprint"
                      }
                    ],
                    "name": "Sandbox Scrum Board",
                    "id": "108-0",
                    "$type": "Agile"
                  },
                  {
                    "owner": {
                      "name": "John Doe",
                      "id": "1-2",
                      "$type": "User"
                    },
                    "projects": [
                      {
                        "name": "GRA Project",
                        "id": "0-7",
                        "$type": "Project"
                      }
                    ],
                    "sprints": [
                      {
                        "name": "First sprint",
                        "id": "109-1",
                        "$type": "Sprint"
                      }
                    ],
                    "name": "GRA Project",
                    "id": "108-1",
                    "$type": "Agile"
                  },
                  {
                    "owner": {
                      "name": "John Doe",
                      "id": "1-2",
                      "$type": "User"
                    },
                    "projects": [
                      {
                        "name": "Sample Project",
                        "id": "0-0",
                        "$type": "Project"
                      },
                      {
                        "name": "Rest Api Project",
                        "id": "0-2",
                        "$type": "Project"
                      }
                    ],
                    "sprints": [
                      {
                        "name": "First sprint",
                        "id": "109-3",
                        "$type": "Sprint"
                      }
                    ],
                    "name": "Kanban board",
                    "id": "108-3",
                    "$type": "Agile"
                  }
                ]
            

新しいアジャイルを追加する

新しいアジャイルボードを作成します。

必須フィールド: name、projects (id - ボードに関連付ける必要があるプロジェクトのデータベース ID)。

リクエスト構文

POST /api/agiles?{fields}&{template}

リクエストパラメーター

パラメーター	タイプ	説明
fields	文字列	応答で返される必要があるアジャイル属性のリスト。フィールドが指定されていない場合、`entityID` のみが返されます。
template	文字列	使用するボードテンプレートの名前。可能な値: `kanban`、`scrum`、`version`、`custom`、`personal`

Sample

サンプルリクエスト

                https://example.youtrack.cloud/api/agiles?template=kanban&fields=id,name,owner(id,name),projects(id,name),sprints(id,name)
            

サンプルリクエストボディ

                {
                  "name":"Kanban board",
                  "projects":[{"id":"0-0"},{"id":"0-2"}],
                  "updateableByProjectBased":true,
                  "visibleForProjectBased":true
                }
            

応答本文のサンプル

                {
                  "owner": {
                    "name": "John Doe",
                    "id": "1-2",
                    "$type": "User"
                  },
                  "projects": [
                    {
                      "name": "Sample Project",
                      "id": "0-0",
                      "$type": "Project"
                    },
                    {
                      "name": "Rest Api Project",
                      "id": "0-2",
                      "$type": "Project"
                    }
                  ],
                  "sprints": [
                    {
                      "name": "First sprint",
                      "id": "109-30",
                      "$type": "Sprint"
                    }
                  ],
                  "name": "Kanban board",
                  "id": "108-23",
                  "$type": "Agile"
                }
            

最終更新日: 2024 年 6 月 19 日

YouTrack および Hub ヘルプの開発者ポータル

アジャイル

アジャイル属性

Related Resources

Attributes

アジャイルのリストを読む

リクエスト構文

リクエストパラメーター

Sample

サンプルリクエスト

応答本文のサンプル

新しいアジャイルを追加する

リクエスト構文

リクエストパラメーター

Sample

サンプルリクエスト

サンプルリクエストボディ

応答本文のサンプル

関連ページ：