Backlogs - Get Backlog

リファレンス

サービス:: Work

API バージョン:: 7.1

バックログレベルを取得する

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/backlogs/{id}?api-version=7.1

URI パラメーター

名前	/	必須	型	説明
id	path	True	string	バックログレベルの ID
organization	path	True	string	Azure DevOps 組織の名前。
project	path	True	string	プロジェクト ID またはプロジェクト名
team	path	True	string	チーム ID またはチーム名
api-version	query	True	string	使用する API のバージョン。このバージョンの API を使用するには、これを '7.1' に設定する必要があります。

応答

名前	型	説明
200 OK	BacklogLevelConfiguration	成功した操作

セキュリティ

oauth2

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン URL): https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

スコープ

名前	説明
vso.work	作業項目、クエリ、ボード、領域とイテレーションのパス、およびその他の作業項目追跡関連のメタデータを読み取る機能を付与します。また、クエリを実行したり、作業項目を検索したり、サービスフックを介して作業項目イベントに関する通知を受信したりすることもできます。

例

Get backlog

要求のサンプル

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber/{team}/_apis/work/backlogs/{id}?api-version=7.1

応答のサンプル

状態コード:: 200

{
  "id": "Microsoft.FeatureCategory",
  "name": "Features",
  "rank": 3,
  "workItemCountLimit": 1000,
  "addPanelFields": [
    {
      "referenceName": "System.Title",
      "name": "Title",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
    }
  ],
  "columnFields": [
    {
      "columnFieldReference": {
        "referenceName": "System.WorkItemType",
        "name": "Work Item Type",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
      },
      "width": 100
    },
    {
      "columnFieldReference": {
        "referenceName": "System.Title",
        "name": "Title",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
      },
      "width": 400
    },
    {
      "columnFieldReference": {
        "referenceName": "System.State",
        "name": "State",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
      },
      "width": 100
    },
    {
      "columnFieldReference": {
        "referenceName": "Microsoft.VSTS.Scheduling.Effort",
        "name": "Effort",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Scheduling.Effort"
      },
      "width": 50
    },
    {
      "columnFieldReference": {
        "referenceName": "Microsoft.VSTS.Common.BusinessValue",
        "name": "Business Value",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.BusinessValue"
      },
      "width": 50
    },
    {
      "columnFieldReference": {
        "referenceName": "Microsoft.VSTS.Common.ValueArea",
        "name": "Value Area",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.ValueArea"
      },
      "width": 100
    },
    {
      "columnFieldReference": {
        "referenceName": "System.Tags",
        "name": "Tags",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Tags"
      },
      "width": 200
    }
  ],
  "workItemTypes": [
    {
      "name": "Feature",
      "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Feature"
    }
  ],
  "defaultWorkItemType": {
    "name": "Feature",
    "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Feature"
  },
  "color": "773B93",
  "isHidden": false,
  "type": "portfolio"
}

定義

名前	説明
BacklogColumn
BacklogLevelConfiguration
BacklogType	このバックログレベルの種類
WorkItemFieldReference	作業項目内のフィールドへの参照
WorkItemTypeReference	作業項目の種類への参照。

BacklogColumn

Object

名前	型	説明
columnFieldReference	WorkItemFieldReference	作業項目内のフィールドへの参照
width	integer (int32)

BacklogLevelConfiguration

Object

名前	型	説明
addPanelFields	WorkItemFieldReference[]	[パネルの追加] に含めるフィールドの一覧
color	string	バックログレベルの色
columnFields	BacklogColumn[]	バックログの列の既定の一覧
defaultWorkItemType	WorkItemTypeReference	バックログの既定の作業項目の種類
id	string	バックログ ID (プロセス構成からのレガシバックログレベルの場合は categoryref 名にすることができます)
isHidden	boolean	バックログレベルが非表示かどうかを示します
name	string	バックログ名
rank	integer (int32)	バックログランク (タスクバックログは 0)
type	BacklogType	このバックログレベルの種類
workItemCountLimit	integer (int32)	指定されたバックログに表示する作業項目の最大数
workItemTypes	WorkItemTypeReference[]	プロジェクト/プロセスで認識されているこのバックログに参加している作業項目の種類は、バグのチーム設定によってオーバーライドできます

BacklogType

列挙

このバックログレベルの種類

値	説明
portfolio	ポートフォリオバックログレベル
requirement	要件バックログレベル
task	タスクバックログレベル

WorkItemFieldReference

Object

作業項目内のフィールドへの参照

名前	型	説明
name	string	フィールドのフレンドリ名。
referenceName	string	フィールドの参照名。
url	string	リソースの REST URL。

WorkItemTypeReference

Object

作業項目の種類への参照。

名前	型	説明
name	string	作業項目の種類の名前。
url	string

次の方法で共有

Backlogs - Get Backlog

URI パラメーター

応答

セキュリティ

oauth2

スコープ

例

Get backlog

要求のサンプル

応答のサンプル

定義

BacklogColumn

BacklogLevelConfiguration

BacklogType

WorkItemFieldReference

WorkItemTypeReference