Backlogs - List

Referenz

Dienst:: Work

API-Version:: 5.0-preview.1

Auflisten aller Backlogebenen

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path	True	string	Projekt-ID oder Projektname
team	path	True	string	Team-ID oder Teamname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "5.0-preview.1" festgelegt werden, um diese Version der API zu verwenden.

Antworten

Name	Typ	Beschreibung
200 OK	BacklogLevelConfiguration[]	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token-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

Bereiche

Name	Beschreibung
vso.work	Ermöglicht das Lesen von Arbeitselementen, Abfragen, Boards, Bereichs- und Iterationspfaden und anderen Metadaten zur Nachverfolgung von Arbeitselementen. Außerdem können Sie Abfragen ausführen, Arbeitselemente durchsuchen und Benachrichtigungen über Arbeitselementereignisse über Diensthaken empfangen.

Beispiele

Get backlogs

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "count": 4,
  "value": [
    {
      "id": "Microsoft.EpicCategory",
      "name": "Epics",
      "rank": 4,
      "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": "Epic",
          "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Epic"
        }
      ],
      "defaultWorkItemType": {
        "name": "Epic",
        "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Epic"
      },
      "color": "FF7B00",
      "isHidden": false,
      "type": "portfolio"
    },
    {
      "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"
    },
    {
      "id": "Microsoft.RequirementCategory",
      "name": "Stories",
      "rank": 2,
      "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.StoryPoints",
            "name": "Story Points",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Scheduling.StoryPoints"
          },
          "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.IterationPath",
            "name": "Iteration Path",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath"
          },
          "width": 200
        },
        {
          "columnFieldReference": {
            "referenceName": "System.Tags",
            "name": "Tags",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Tags"
          },
          "width": 200
        }
      ],
      "workItemTypes": [
        {
          "name": "User Story",
          "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/User%20Story"
        },
        {
          "name": "Bug",
          "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Bug"
        }
      ],
      "defaultWorkItemType": {
        "name": "User Story",
        "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/User%20Story"
      },
      "color": "009CCC",
      "isHidden": false,
      "type": "requirement"
    },
    {
      "id": "Microsoft.TaskCategory",
      "name": "Tasks",
      "rank": 1,
      "workItemCountLimit": 1000,
      "addPanelFields": [
        {
          "referenceName": "System.Title",
          "name": "Title",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
        }
      ],
      "columnFields": [
        {
          "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": "System.AssignedTo",
            "name": "Assigned To",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.AssignedTo"
          },
          "width": 100
        },
        {
          "columnFieldReference": {
            "referenceName": "Microsoft.VSTS.Scheduling.RemainingWork",
            "name": "Remaining Work",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Scheduling.RemainingWork"
          },
          "width": 50
        }
      ],
      "workItemTypes": [
        {
          "name": "Task",
          "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Task"
        }
      ],
      "defaultWorkItemType": {
        "name": "Task",
        "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Task"
      },
      "color": "F2CB1D",
      "isHidden": false,
      "type": "task"
    }
  ]
}

Definitionen

Name	Beschreibung
BacklogColumn
BacklogLevelConfiguration
BacklogType	Der Typ dieser Backlogebene
WorkItemFieldReference	Verweis auf ein Feld in einem Arbeitselement
WorkItemTypeReference	Verweis auf einen Arbeitselementtyp.

BacklogColumn

Objekt

Name	Typ	Beschreibung
columnFieldReference	WorkItemFieldReference	Verweis auf ein Feld in einem Arbeitselement
width	integer

BacklogLevelConfiguration

Objekt

Name	Typ	Beschreibung
addPanelFields	WorkItemFieldReference[]	Liste der Felder, die in den Bereich "Hinzufügen" aufgenommen werden sollen
color	string	Farbe für die Backlogebene
columnFields	BacklogColumn[]	Standardliste der Spalten für das Backlog
defaultWorkItemType	WorkItemTypeReference	Defaulst-Arbeitselementtyp für das Backlog
id	string	Backlog-ID (für legacy Backlog level from process config kann es categoryref name sein)
isHidden	boolean	Gibt an, ob die Backlogebene ausgeblendet ist.
name	string	Backlogname
rank	integer	Backlograng (Taskbacklog ist 0)
type	BacklogType	Der Typ dieser Backlogebene
workItemCountLimit	integer	Maximale Anzahl von Arbeitselementen, die im angegebenen Backlog angezeigt werden sollen
workItemTypes	WorkItemTypeReference[]	Arbeitselementtypen, die an diesem Backlog teilnehmen, wie vom Projekt/Prozess bekannt, können von Teameinstellungen für Fehler überschrieben werden.

BacklogType

Enumeration

Der Typ dieser Backlogebene

Wert	Beschreibung
portfolio	Portfoliobacklogebene
requirement	Anforderungsbacklogebene
task	Vorgangsbacklogebene

WorkItemFieldReference

Objekt

Verweis auf ein Feld in einem Arbeitselement

Name	Typ	Beschreibung
name	string	Der Name des Felds.
referenceName	string	Der Verweisname des Felds.
url	string	Die REST-URL der Ressource.

WorkItemTypeReference

Objekt

Verweis auf einen Arbeitselementtyp.

Name	Typ	Beschreibung
name	string	Name des Arbeitselementtyps.
url	string

Freigeben über

Backlogs - List

URI-Parameter

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

Get backlogs

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BacklogColumn

BacklogLevelConfiguration

BacklogType

WorkItemFieldReference

WorkItemTypeReference