Backlogs - Get Backlog

Usługa:

Work

Wersja interfejsu API:

7.1

Pobieranie poziomu listy prac

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
id	path	True	string	Identyfikator poziomu listy prac
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path	True	string	Identyfikator projektu lub nazwa projektu
team	path	True	string	Identyfikator zespołu lub nazwa zespołu
api-version	query	True	string	Wersja interfejsu API do użycia. Należy ustawić wartość "7.1", aby używać tej wersji interfejsu API.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	BacklogLevelConfiguration	operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

Nazwa	Opis
vso.work	Umożliwia odczytywanie elementów roboczych, zapytań, tablic, ścieżek obszaru i iteracji oraz innych metadanych powiązanych ze śledzeniem elementów roboczych. Ponadto umożliwia wykonywanie zapytań, wyszukiwanie elementów roboczych i odbieranie powiadomień o zdarzeniach elementów roboczych za pośrednictwem punktów zaczepienia usługi.

Przykłady

Get backlog

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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"
}

Definicje

Nazwa	Opis
BacklogColumn
BacklogLevelConfiguration
BacklogType	Typ tego poziomu listy prac
WorkItemFieldReference	Odwołanie do pola w elemencie roboczym
WorkItemTypeReference	Odwołanie do typu elementu roboczego.

BacklogColumn

Objekt

Nazwa	Typ	Opis
columnFieldReference	WorkItemFieldReference	Odwołanie do pola w elemencie roboczym
width	integer (int32)

BacklogLevelConfiguration

Objekt

Nazwa	Typ	Opis
addPanelFields	WorkItemFieldReference[]	Lista pól do uwzględnienia w panelu dodawania
color	string	Kolor na poziomie listy prac
columnFields	BacklogColumn[]	Domyślna lista kolumn listy prac
defaultWorkItemType	WorkItemTypeReference	Domyślny typ elementu roboczego listy prac
id	string	Identyfikator listy prac (dla starszego poziomu listy prac z konfiguracji procesu może być nazwą categoryref)
isHidden	boolean	Wskazuje, czy poziom listy prac jest ukryty
name	string	Nazwa listy prac
rank	integer (int32)	Ranga listy prac (lista zadań to 0)
type	BacklogType	Typ tego poziomu listy prac
workItemCountLimit	integer (int32)	Maksymalna liczba elementów roboczych do wyświetlenia na danej liście prac
workItemTypes	WorkItemTypeReference[]	Typy elementów roboczych biorące udział w tej liście prac znanej przez projekt/proces mogą być zastępowane przez ustawienia zespołu dla usterek

BacklogType

Wyliczanie

Typ tego poziomu listy prac

Wartość	Opis
portfolio	Poziom listy prac portfela
requirement	Poziom listy prac wymagań
task	Poziom listy prac zadań

WorkItemFieldReference

Objekt

Odwołanie do pola w elemencie roboczym

Nazwa	Typ	Opis
name	string	Przyjazna nazwa pola.
referenceName	string	Nazwa odwołania do pola.
url	string	Adres URL REST zasobu.

WorkItemTypeReference

Objekt

Odwołanie do typu elementu roboczego.

Nazwa	Typ	Opis
name	string	Nazwa typu elementu roboczego.
url	string