Freigeben über

Reporting Work Item Revisions - Read Reporting Revisions Get

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

Abrufen eines Batches von Überarbeitungen von Arbeitsaufgaben mit der Option zum Einschließen gelöschter Elemente

GET https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemrevisions?api-version=7.1
Mit optionalen Parametern: 
GET https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemrevisions?fields={fields}&types={types}&continuationToken={continuationToken}&startDateTime={startDateTime}&includeIdentityRef={includeIdentityRef}&includeDeleted={includeDeleted}&includeTagRef={includeTagRef}&includeLatestOnly={includeLatestOnly}&$expand={$expand}&includeDiscussionChangesOnly={includeDiscussionChangesOnly}&$maxPageSize={$maxPageSize}&api-version=7.1

URI-Parameter

Name In Erforderlich Typ Beschreibung
organization
 path True

string

Der Name der Azure DevOps-Organisation.
project
 path

string

Projekt-ID oder Projektname
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

ReportingRevisionsExpand

Zurückgeben aller Felder in Überarbeitungen von Arbeitsaufgaben, einschließlich langer Textfelder, die standardmäßig nicht zurückgegeben werden
$maxPageSize
 query

integer (int32)

Die maximale Anzahl der Ergebnisse, die in diesem Batch zurückgegeben werden sollen
continuationToken
 query

string

Gibt das Wasserzeichen an, von dem der Stapel gestartet werden soll. Lassen Sie diesen Parameter aus, um den ersten Batch von Überarbeitungen abzurufen.
fields
 query

string (array (string))

Eine Liste der Felder, die in Überarbeitungen von Arbeitsaufgaben zurückgegeben werden sollen. Lassen Sie diesen Parameter weg, um alle berichtsfähigen Felder abzurufen.
includeDeleted
 query

boolean

Geben Sie an, ob das gelöschte Element zurückgegeben werden soll.
includeDiscussionChangesOnly
 query

boolean

Gibt nur die Überarbeitungen von Arbeitsaufgaben zurück, bei denen nur das Verlaufsfeld geändert wurde.
includeIdentityRef
 query

boolean

Zurückgeben eines Identitätsverweises anstelle eines Zeichenfolgenwerts für Identitätsfelder.
includeLatestOnly
 query

boolean

Gibt nur die neuesten Überarbeitungen von Arbeitsaufgaben zurück, wobei alle historischen Überarbeitungen übersprungen werden.
includeTagRef
 query

boolean

Geben Sie an, ob die Tagobjekte für das Feld "System.Tags" zurückgegeben werden sollen.
startDateTime
 query

string (date-time)

Datum/Uhrzeit, die als Ausgangspunkt für Überarbeitungen verwendet werden soll, treten alle Überarbeitungen nach diesem Datum/dieser Uhrzeit auf. In Verbindung mit dem Parameter "Wasserzeichen" kann nicht verwendet werden.
types
 query

string (array (string))

Eine Liste der Typen zum Filtern der Ergebnisse auf bestimmte Arbeitsaufgabentypen. Lassen Sie diesen Parameter weg, um Überarbeitungen aller Arbeitsaufgabentypen abzurufen.

Antworten

Name Typ Beschreibung
200 OK

ReportingWorkItemRevisionsBatch

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

Get a batch of work item revisions with identity references
Get the first batch of work item revisions

Get a batch of work item revisions with identity references

Beispielanforderung

GET https://dev.azure.com/fabrikam/_apis/wit/reporting/workitemrevisions?includeIdentityRef=true&api-version=7.1

Beispiel für eine Antwort

Statuscode:
200 
{
  "values": [
    {
      "id": 3,
      "rev": 8,
      "fields": {
        "System.Id": 3,
        "System.AreaPath": "Fabrikam-Fiber-Git",
        "System.TeamProject": "Fabrikam-Fiber-Git",
        "System.Rev": 8,
        "System.RevisedDate": "9999-01-01T00:00:00Z",
        "System.IterationPath": "Fabrikam-Fiber-Git\\Release 1\\Sprint 1",
        "System.WorkItemType": "Product Backlog Item",
        "System.State": "Done",
        "System.Reason": "Work finished",
        "System.CreatedDate": "2014-03-18T17:17:06.857Z",
        "System.CreatedBy": {
          "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
          "uniqueName": "Jamal Hartnett <fabrikamfiber4@hotmail.com>"
        },
        "System.ChangedDate": "2015-06-23T18:25:16.137Z",
        "System.ChangedBy": {
          "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
          "uniqueName": "Normal Paulk <fabrikamfiber16@hotmail.com>"
        },
        "System.Title": "Technician can submit invoices on Windows Phone",
        "System.BoardColumn": "Done",
        "Microsoft.VSTS.Common.ClosedDate": "2014-03-18T17:19:02.093Z",
        "Microsoft.VSTS.Common.Priority": 3,
        "Microsoft.VSTS.Common.BacklogPriority": 1000063244,
        "WEF_6CB513B6E70E43499D9FC94E5BBFB784_Kanban.Column": "Done"
      }
    },
    {
      "id": 350,
      "rev": 1,
      "fields": {
        "System.Id": 350,
        "System.AreaPath": "Fabrikam-Fiber-Git",
        "System.TeamProject": "Fabrikam-Fiber-Git",
        "System.Rev": 1,
        "System.RevisedDate": "9999-01-01T00:00:00Z",
        "System.IterationPath": "Fabrikam-Fiber-Git",
        "System.WorkItemType": "Epic",
        "System.State": "New",
        "System.Reason": "New epic",
        "System.CreatedDate": "2015-08-25T21:54:46.06Z",
        "System.CreatedBy": {
          "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
          "uniqueName": "Jamal Hartnett <fabrikamfiber4@hotmail.com>"
        },
        "System.ChangedDate": "2015-08-25T21:54:46.06Z",
        "System.ChangedBy": {
          "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
          "uniqueName": "Jamal Hartnett <fabrikamfiber4@hotmail.com>"
        },
        "System.Title": "Mobile Experiences",
        "System.BoardColumn": "New",
        "System.BoardColumnDone": false,
        "Microsoft.VSTS.Common.Priority": 2,
        "WEF_DF2CD50AB7B849C795850408B629AB43_Kanban.Column": "New",
        "WEF_DF2CD50AB7B849C795850408B629AB43_Kanban.Column.Done": false
      }
    }
  ],
  "nextLink": "https://dev.azure.com/fabrikam/_apis/wit/reporting/workItemRevisions?continuationToken=813;350;1&includeIdentityRef=true&api-version=2.0",
  "continuationToken": "813;350;1",
  "isLastBatch": true
}

Get the first batch of work item revisions

Beispielanforderung

GET https://dev.azure.com/fabrikam/_apis/wit/reporting/workitemrevisions?api-version=7.1

Beispiel für eine Antwort

Statuscode:
200 
{
  "values": [
    {
      "id": 1,
      "rev": 1,
      "fields": {
        "System.Id": 1,
        "System.AreaPath": "Fabrikam-Fiber-Git",
        "System.TeamProject": "Fabrikam-Fiber-Git",
        "System.Rev": 1,
        "System.RevisedDate": "2014-03-18T17:17:05.76Z",
        "System.IterationPath": "Fabrikam-Fiber-Git",
        "System.WorkItemType": "Product Backlog Item",
        "System.State": "New",
        "System.Reason": "New backlog item",
        "System.CreatedDate": "2014-03-18T17:16:56.25Z",
        "System.CreatedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
        "System.ChangedDate": "2014-03-18T17:16:56.25Z",
        "System.ChangedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
        "System.BoardColumn": "New",
        "WEF_6CB513B6E70E43499D9FC94E5BBFB784_Kanban.Column": "New",
        "System.Title": "Technician can check on parts orders on Windows Phone"
      }
    },
    {
      "id": 1,
      "rev": 2,
      "fields": {
        "System.Id": 1,
        "System.AreaPath": "Fabrikam-Fiber-Git",
        "System.TeamProject": "Fabrikam-Fiber-Git",
        "System.Rev": 2,
        "System.RevisedDate": "2014-03-18T17:19:02.093Z",
        "System.IterationPath": "Fabrikam-Fiber-Git",
        "System.WorkItemType": "Product Backlog Item",
        "System.State": "New",
        "System.Reason": "New backlog item",
        "System.CreatedDate": "2014-03-18T17:16:56.25Z",
        "System.CreatedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
        "System.ChangedDate": "2014-03-18T17:17:05.76Z",
        "System.ChangedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
        "System.BoardColumn": "New",
        "WEF_6CB513B6E70E43499D9FC94E5BBFB784_Kanban.Column": "New",
        "System.Title": "Technician can check on parts orders on Windows Phone",
        "Microsoft.VSTS.Common.BacklogPriority": 1000000000
      }
    },
    {
      "id": 2,
      "rev": 1,
      "fields": {
        "System.Id": 2,
        "System.AreaPath": "Fabrikam-Fiber-Git",
        "System.TeamProject": "Fabrikam-Fiber-Git",
        "System.Rev": 1,
        "System.RevisedDate": "2014-03-18T17:17:06.343Z",
        "System.IterationPath": "Fabrikam-Fiber-Git",
        "System.WorkItemType": "Product Backlog Item",
        "System.State": "New",
        "System.Reason": "New backlog item",
        "System.CreatedDate": "2014-03-18T17:17:06.01Z",
        "System.CreatedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
        "System.ChangedDate": "2014-03-18T17:17:06.01Z",
        "System.ChangedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
        "System.BoardColumn": "New",
        "WEF_6CB513B6E70E43499D9FC94E5BBFB784_Kanban.Column": "New",
        "System.Title": "Technician can look for closest hardware store from Windows Phone"
      }
    }
  ],
  "nextLink": "https://dev.azure.com/fabrikam/_apis/wit/reporting/workItemRevisions?continuationToken=3;2;1&api-version=2.0",
  "isLastBatch": true
}

Definitionen

Name Beschreibung
ReportingRevisionsExpand

Zurückgeben aller Felder in Überarbeitungen von Arbeitsaufgaben, einschließlich langer Textfelder, die standardmäßig nicht zurückgegeben werden
ReportingWorkItemRevisionsBatch

ReportingRevisionsExpand

Enumeration

Zurückgeben aller Felder in Überarbeitungen von Arbeitsaufgaben, einschließlich langer Textfelder, die standardmäßig nicht zurückgegeben werden

Wert Beschreibung
fields

Fügen Sie der Antwort Felder hinzu.
none

Standardverhalten.

ReportingWorkItemRevisionsBatch

Objekt
Name Typ Beschreibung
continuationToken

string

ContinuationToken fungiert als Wasserzeichen. Wird beim Abfragen großer Ergebnisse verwendet.
isLastBatch

boolean

Gibt "true" zurück, wenn es sich um den letzten Batch handelt, andernfalls "false".
nextLink

string

Der nächste Link für die Arbeitsaufgabe.
values

string[] (T)

Werte wie rel, sourceId, TargetId, ChangedDate, isActive.