Freigeben über

Work Items - Get Work Item Template

  • Referenz
Dienst:
Work Item Tracking
API-Version:
7.1

Gibt eine einzelne Arbeitsaufgabe aus einer Vorlage zurück.

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?api-version=7.1
Mit optionalen Parametern: 
GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?fields={fields}&asOf={asOf}&$expand={$expand}&api-version=7.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
type
 path True

string

Der Name des Arbeitsaufgabentyps
api-version
 query True

string

Version der zu verwendenden API. Dies sollte auf "7.1" festgelegt werden, um diese Version der API zu verwenden.
$expand
 query

WorkItemExpand

Die Erweiterungsparameter für Arbeitsaufgabenattribute. Mögliche Optionen sind { None, Relations, Fields, Links, All }.
asOf
 query

string (date-time)

AsOf UTC-Datums-Uhrzeitzeichenfolge
fields
 query

string

Durch Trennzeichen getrennte Liste der angeforderten Felder

Antworten

Name Typ Beschreibung
200 OK

WorkItem

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 Gewährt die Möglichkeit, Arbeitsaufgaben, Abfragen, Boards, Flächen- und Iterationspfade und andere Metadaten zur Nachverfolgung von Arbeitsaufgaben zu lesen. Gewährt außerdem die Möglichkeit, Abfragen auszuführen, Arbeitsaufgaben zu durchsuchen und Benachrichtigungen über Arbeitsaufgabenereignisse über Dienst-Hooks zu erhalten.

Beispiele

Returns a single work item from a template

Beispielanforderung

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?api-version=7.1

Beispiel für eine Antwort

Statuscode:
200 
{
  "fields": {
    "System.WorkItemType": "Bug",
    "System.AreaPath": "Test Project",
    "System.TeamProject": "Test Project",
    "System.IterationPath": "Test Project",
    "System.State": "New",
    "System.Reason": "New",
    "Microsoft.VSTS.Common.StateChangeDate": "1753-01-01T00:00:00Z",
    "System.ChangedBy": {
      "displayName": "Fabricam Zhang",
      "url": "https://app.vssps.visualstudio.com/Accf03646-3dbb-4c84-91f3-739a6c8797a1/_apis/Identities/5f499b36-f993-6330-9295-1abf1a669337",
      "_links": {
        "avatar": {
          "href": "https://dev.azure.com/fabricam3/_apis/GraphProfile/MemberAvatars/msa.NWY0OTliMzYtZjk5My03MzMwLTkyOTUtMWFiZjFhNjY5MzM3"
        }
      },
      "id": "5f499b36-f993-6330-9295-1abf1a669337",
      "uniqueName": "fabricam2@outlook.com",
      "imageUrl": "https://dev.azure.com/fabricam3/_api/_common/identityImage?id=5f499b36-f993-6330-9295-1abf1a669337",
      "descriptor": "msa.NWY0OTliMzYtZjk5My03MzMwLTkyOTUtMWFiZjFhNjY5MzM3"
    },
    "System.CreatedBy": {
      "displayName": "Fabricam Zhang",
      "url": "https://app.vssps.visualstudio.com/Accf03646-3dbb-4c84-91f3-739a6c8797a1/_apis/Identities/5f499b36-f993-6330-9295-1abf1a669337",
      "_links": {
        "avatar": {
          "href": "https://dev.azure.com/fabricam3/_apis/GraphProfile/MemberAvatars/msa.NWY0OTliMzYtZjk5My03MzMwLTkyOTUtMWFiZjFhNjY5MzM3"
        }
      },
      "id": "5f499b36-f993-6330-9295-1abf1a669337",
      "uniqueName": "fabricam2@outlook.com",
      "imageUrl": "https://dev.azure.com/fabricam3/_api/_common/identityImage?id=5f499b36-f993-6330-9295-1abf1a669337",
      "descriptor": "msa.NWY0OTliMzYtZjk5My03MzMwLTkyOTUtMWFiZjFhNjY5MzM3"
    },
    "Microsoft.VSTS.Common.Priority": 2,
    "Microsoft.VSTS.Common.Severity": "3 - Medium",
    "Microsoft.VSTS.Common.ValueArea": "Business"
  },
  "_links": {
    "workItemType": {
      "href": "https://dev.azure.com/fabricam3/c1b5ee8b-7c3f-4e7d-bb53-ce022cf5af4b/_apis/wit/workItemTypes/Bug"
    },
    "fields": {
      "href": "https://dev.azure.com/fabricam3/c1b5ee8b-7c3f-4e7d-bb53-ce022cf5af4b/_apis/wit/fields"
    }
  },
  "url": "https://dev.azure.com/fabricam3/c1b5ee8b-7c3f-4e7d-bb53-ce022cf5af4b/_apis/wit/workItems"
}

Definitionen

Name Beschreibung
ReferenceLinks

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
WorkItem

Beschreibt eine Arbeitsaufgabe.
WorkItemCommentVersionRef

Stellt den Verweis auf eine bestimmte Version eines Kommentars zu einer Arbeitsaufgabe dar.
WorkItemExpand

Die Erweiterungsparameter für Arbeitsaufgabenattribute. Mögliche Optionen sind { None, Relations, Fields, Links, All }
WorkItemRelation
Objekt

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Referenzlinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

WorkItem

Objekt

Beschreibt eine Arbeitsaufgabe.

Name Typ Beschreibung
_links

ReferenceLinks

Verknüpfen Sie Verweise auf verwandte REST-Ressourcen.
commentVersionRef

WorkItemCommentVersionRef

Verweisen Sie auf eine bestimmte Version des Kommentars, der in dieser Überarbeitung hinzugefügt/bearbeitet/gelöscht wurde.
fields

object

Zuordnung von Feld und Werten für die Arbeitsaufgabe.
id

integer (int32)

Die Arbeitsaufgaben-ID.
relations

WorkItemRelation[]

Beziehungen der Arbeitsaufgabe.
rev

integer (int32)

Revisionsnummer der Arbeitsaufgabe.
url

string

WorkItemCommentVersionRef

Objekt

Stellt den Verweis auf eine bestimmte Version eines Kommentars zu einer Arbeitsaufgabe dar.

Name Typ Beschreibung
commentId

integer (int32)

Die dem Kommentar zugewiesene ID.
createdInRevision

integer (int32)

[Intern] Die Überarbeitung der Arbeitsaufgabe, in der dieser Kommentar ursprünglich hinzugefügt wurde.
isDeleted

boolean

[Intern] Gibt an, ob ein Kommentar gelöscht wurde.
text

string

[Intern] Der Text des Kommentars.
url

string

version

integer (int32)

Die Versionsnummer.

WorkItemExpand

Enumeration

Die Erweiterungsparameter für Arbeitsaufgabenattribute. Mögliche Optionen sind { None, Relations, Fields, Links, All }

Wert Beschreibung
all

Erweitert alle.
fields

Die Arbeitsaufgabe für Felder wird erweitert.
links

Verknüpfungen für Arbeitsaufgabe werden erweitert.
none

Standardverhalten.
relations

Die Arbeitsaufgabe "Beziehungen" wird erweitert.

WorkItemRelation

Objekt
Name Typ Beschreibung
attributes

object

Sammlung von Verknüpfungsattributen.
rel

string

Beziehungstyp.
url

string

Link-URL.