Freigeben über


Reporting Work Item Links - Get

Abrufen eines Batches von Arbeitselementlinks

GET https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemlinks?api-version=7.1-preview.3
GET https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemlinks?linkTypes={linkTypes}&types={types}&continuationToken={continuationToken}&startDateTime={startDateTime}&api-version=7.1-preview.3

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-preview.3" festgelegt werden, um diese Version der API zu verwenden.

continuationToken
query

string

Gibt den ContinuationToken an, von dem aus der Batch gestartet werden soll. Lassen Sie diesen Parameter weg, um den ersten Linkbatch abzurufen.

linkTypes
query

string

array (string)

Eine Liste von Typen zum Filtern der Ergebnisse nach bestimmten Linktypen. Lassen Sie diesen Parameter weg, um Arbeitselementlinks aller Linktypen abzurufen.

startDateTime
query

string

date-time

Datum/Uhrzeit, die als Ausgangspunkt für Linkänderungen verwendet werden sollen. Nur Linkänderungen, die nach diesem Datum/dieser Uhrzeit aufgetreten sind, werden zurückgegeben. Kann nicht in Verbindung mit dem Parameter "Wasserzeichen" verwendet werden.

types
query

string

array (string)

Eine Liste von Typen zum Filtern der Ergebnisse nach bestimmten Arbeitselementtypen. Lassen Sie diesen Parameter weg, um Arbeitselementlinks aller Arbeitselementtypen abzurufen.

Antworten

Name Typ Beschreibung
200 OK

ReportingWorkItemLinksBatch

Erfolgreicher Vorgang

Sicherheit

oauth2

Type: oauth2
Flow: accessCode
Authorization 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

Scopes

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

Sample Request

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

Sample Response

{
  "values": [
    {
      "rel": "System.LinkTypes.Hierarchy",
      "sourceId": 7,
      "targetId": 8,
      "changedDate": "2014-03-18T17:17:52.02Z",
      "isActive": true
    },
    {
      "rel": "System.LinkTypes.Hierarchy",
      "sourceId": 7,
      "targetId": 9,
      "changedDate": "2014-03-18T17:18:03.007Z",
      "isActive": true
    },
    {
      "rel": "System.LinkTypes.Hierarchy",
      "sourceId": 10,
      "targetId": 13,
      "changedDate": "2014-03-18T17:21:27.623Z",
      "isActive": true
    }
  ],
  "nextLink": "https://dev.azure.com/fabrikam/_apis/wit/reporting/workItemLinks?continuationToken=6281123&api-version=2.2",
  "isLastBatch": true
}

Definitionen

ReportingWorkItemLinksBatch

Name Typ Beschreibung
continuationToken

string

ContinuationToken fungiert als WaterMark. 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 das Arbeitselement.

values

string[]

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