Queries - Search Queries

Service:

Work Item Tracking

API Version:

7.1-preview.2

Durchsucht alle Abfragen, auf die der Benutzer im aktuellen Projekt Zugriff hat

GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries?$filter={$filter}&api-version=7.1-preview.2

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries?$filter={$filter}&$top={$top}&$expand={$expand}&$includeDeleted={$includeDeleted}&api-version=7.1-preview.2

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
$filter	query	True	string	Der Text, mit dem die Abfragen gefiltert werden sollen.
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1-preview.2" festgelegt werden, um diese Version der API zu verwenden.
$expand	query		QueryExpand
$includeDeleted	query		boolean	Einschließen gelöschter Abfragen und Ordner
$top	query		integer int32	Die Anzahl der zurückgegebenen Abfragen (Standardwert ist 50 und maximal 200).

Antworten

Name	Typ	Beschreibung
200 OK	QueryHierarchyItemsResult	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.

Definitionen

Name	Beschreibung
IdentityReference	Beschreibt einen Verweis auf eine Identität.
LinkQueryMode	Der Linkabfragemodus.
LogicalOperation	Logischer Operator, der die Bedingungsklausel trennt
QueryExpand	Die Erweiterungsparameter für Abfragen. Mögliche Optionen sind { None, Wiql, Clauses, All, Minimal }
QueryHierarchyItem	Stellt ein Element in der Arbeitselementabfragehierarchie dar. Dies kann entweder eine Abfrage oder ein Ordner sein.
QueryHierarchyItemsResult
QueryRecursionOption	Die Rekursionsoption für die Verwendung in einer Strukturabfrage.
QueryType	Der Abfragetyp.
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
WorkItemFieldOperation	Beschreibt einen Arbeitselementfeldvorgang.
WorkItemFieldReference	Verweis auf ein Feld in einem Arbeitselement
WorkItemQueryClause	Stellt eine Klausel in einer Arbeitselementabfrage dar. Dies zeigt die Struktur einer Arbeitselementabfrage an.
WorkItemQuerySortColumn	Eine Sortierspalte.

IdentityReference

Beschreibt einen Verweis auf eine Identität.

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Diagrammthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graph-Thema zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Möglichkeit, auf den Graphengegenstand zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert.
directoryAlias	string	Veraltet: Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im Eintrag "selbst" des IdentityRef-Wörterbuchs "_links" verwiesen wird.
displayName	string	Dies ist der nicht eindeutige Anzeigename des Diagrammsubjekts. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.
id	string
imageUrl	string	Veraltet: Verfügbar im Eintrag "avatar" des IdentityRef-Wörterbuchs "_links"
inactive	boolean	Veraltet: Kann durch Abfragen des Graph-Mitgliedschaftsstatus abgerufen werden, auf den im Eintrag "membershipState" des GraphUser-Wörterbuchs "_links" verwiesen wird.
isAadIdentity	boolean	Veraltet: Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Veraltet: Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
name	string	Legacy-Back-compat-Eigenschaft. Dies war der WIT-spezifische Wert aus Konstanten. Wird auf dem Client ausgeblendet (ist aber vorhanden), es sei denn, er zielt auf die neueste Version ab.
profileUrl	string	Veraltet: Wird in den meisten bereits vorhandenen Implementierungen von ToIdentityRef nicht verwendet.
uniqueName	string	Veraltet: Verwenden Sie stattdessen Domain+PrincipalName.
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

LinkQueryMode

Der Linkabfragemodus.

Name	Typ	Beschreibung
linksOneHopDoesNotContain	string	Gibt Arbeitselemente zurück, die die Quelle erfüllen, nur, wenn kein verknüpftes Arbeitselement die Link- und Zielkriterien erfüllt.
linksOneHopMayContain	string	Gibt Arbeitselemente zurück, die die Quell- und Linkkriterien erfüllen, auch wenn kein verknüpftes Arbeitselement die Zielkriterien erfüllt.
linksOneHopMustContain	string	Gibt Arbeitselemente zurück, bei denen die Quell-, Ziel- und Linkkriterien erfüllt sind.
linksRecursiveDoesNotContain	string
linksRecursiveMayContain	string	Gibt arbeitselemente eine Hierarchie von Arbeitselementen zurück, die standardmäßig die Quelle erfüllen
linksRecursiveMustContain	string
workItems	string	Gibt eine flache Liste von Arbeitselementen zurück.

LogicalOperation

Logischer Operator, der die Bedingungsklausel trennt

Name	Typ	Beschreibung
and	string
none	string
or	string

QueryExpand

Die Erweiterungsparameter für Abfragen. Mögliche Optionen sind { None, Wiql, Clauses, All, Minimal }

Name	Typ	Beschreibung
all	string	Erweitert alle Eigenschaften
clauses	string	Erweitert Spalten, Links, ChangeInfo, WIQL-Text und -Klauseln
minimal	string	Zeigt minimale Eigenschaften und den WIQL-Text an
none	string	Erweitert Spalten, Links und ChangeInfo
wiql	string	Erweitert Spalten, Links, ChangeInfo und WIQL-Text

QueryHierarchyItem

Stellt ein Element in der Arbeitselementabfragehierarchie dar. Dies kann entweder eine Abfrage oder ein Ordner sein.

Name	Typ	Beschreibung
_links	ReferenceLinks	Verknüpfen Sie Verweise auf verwandte REST-Ressourcen.
children	QueryHierarchyItem[]	Die untergeordneten Abfrageelemente in einem Abfrageordner.
clauses	WorkItemQueryClause	Die Klauseln für eine flache Abfrage.
columns	WorkItemFieldReference[]	Die Spalten der Abfrage.
createdBy	IdentityReference	Die Identität, die das Abfrageelement erstellt hat.
createdDate	string	Wenn das Abfrageelement erstellt wurde.
filterOptions	LinkQueryMode	Der Linkabfragemodus.
hasChildren	boolean	Wenn es sich um einen Abfrageordner handelt, gibt an, ob er untergeordnete Elemente enthält.
id	string	Die ID des Abfrageelements.
isDeleted	boolean	Gibt an, ob dieses Abfrageelement gelöscht wird. Wenn Sie dies für ein gelöschtes Abfrageelement auf false festlegen, wird es wiederherstellen. Durch das Rückgängigmachen einer Abfrage oder eines Ordners werden die zuvor auf sie angewendeten Berechtigungsänderungen nicht zurückgesetzt.
isFolder	boolean	Gibt an, ob es sich um einen Abfrageordner oder eine Abfrage handelt.
isInvalidSyntax	boolean	Gibt an, ob die WIQL dieser Abfrage ungültig ist. Dies kann auf eine ungültige Syntax oder einen nicht mehr gültigen Bereichs-/Iterationspfad zurückzuführen sein.
isPublic	boolean	Gibt an, ob dieses Abfrageelement öffentlich oder privat ist.
lastExecutedBy	IdentityReference	Die Identität, die die Abfrage zuletzt ausgeführt hat.
lastExecutedDate	string	Wann die Abfrage zuletzt ausgeführt wurde.
lastModifiedBy	IdentityReference	Die Identität, die das Abfrageelement zuletzt geändert hat.
lastModifiedDate	string	Wann das Abfrageelement zuletzt geändert wurde.
linkClauses	WorkItemQueryClause	Die Linkabfrageklausel.
name	string	Der Name des Abfrageelements.
path	string	Der Pfad des Abfrageelements.
queryRecursionOption	QueryRecursionOption	Die Rekursionsoption für die Verwendung in einer Strukturabfrage.
queryType	QueryType	Der Abfragetyp.
sortColumns	WorkItemQuerySortColumn[]	Die Sortierspalten der Abfrage.
sourceClauses	WorkItemQueryClause	Die Quellklauseln in einer Struktur- oder One-Hop-Linkabfrage.
targetClauses	WorkItemQueryClause	Die Zielklauseln in einer Struktur- oder One-Hop-Linkabfrage.
url	string
wiql	string	Der WIQL-Text der Abfrage

QueryHierarchyItemsResult

Name	Typ	Beschreibung
count	integer	Die Anzahl der Elemente.
hasMore	boolean	Gibt an, ob das maximale Rückgabelimit erreicht wurde, aber noch weitere Elemente vorhanden sind.
value	QueryHierarchyItem[]	Die Liste der Elemente

QueryRecursionOption

Die Rekursionsoption für die Verwendung in einer Strukturabfrage.

Name	Typ	Beschreibung
childFirst	string	Gibt Arbeitselemente zurück, die die Zielkriterien erfüllen, auch wenn kein Arbeitselement die Quell- und Linkkriterien erfüllt.
parentFirst	string	Gibt Arbeitselemente zurück, die die Quelle erfüllen, auch wenn kein verknüpftes Arbeitselement die Ziel- und Linkkriterien erfüllt.

QueryType

Der Abfragetyp.

Name	Typ	Beschreibung
flat	string	Ruft eine flache Liste von Arbeitselementen ab.
oneHop	string	Ruft eine Liste der Arbeitselemente und deren direkte Links ab.
tree	string	Ruft eine Struktur von Arbeitselementen ab, die ihre Linkhierarchie anzeigen.

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

WorkItemFieldOperation

Beschreibt einen Arbeitselementfeldvorgang.

Name	Typ	Beschreibung
name	string	Anzeigename des Vorgangs.
referenceName	string	Verweisname des Vorgangs.

WorkItemFieldReference

Verweis auf ein Feld in einem Arbeitselement

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

WorkItemQueryClause

Stellt eine Klausel in einer Arbeitselementabfrage dar. Dies zeigt die Struktur einer Arbeitselementabfrage an.

Name	Typ	Beschreibung
clauses	WorkItemQueryClause[]	Untergeordnete Klauseln, wenn die aktuelle Klausel ein logischer Operator ist
field	WorkItemFieldReference	Der Bedingung zugeordnetes Feld
fieldValue	WorkItemFieldReference	Rechte Seite der Bedingung, wenn ein Feld-zu-Feld-Vergleich
isFieldValue	boolean	Bestimmt, ob es sich um einen Feld-zu-Feld-Vergleich handelt
logicalOperator	LogicalOperation	Logischer Operator, der die Bedingungsklausel trennt
operator	WorkItemFieldOperation	Der Feldoperator
value	string	Rechte Seite der Bedingung, wenn ein Feld mit Einem Wertvergleich

WorkItemQuerySortColumn

Eine Sortierspalte.

Name	Typ	Beschreibung
descending	boolean	Die Richtung, nach der sortiert werden soll.
field	WorkItemFieldReference	Ein Arbeitselementfeld.