Queries - Search Queries

Odwołanie

Service:: Work Item Tracking

API Version:: 7.1-preview.2

Wyszukuje wszystkie zapytania, do których użytkownik ma dostęp w bieżącym projekcie

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path	True	string	Identyfikator projektu lub nazwa projektu
$filter	query	True	string	Tekst do filtrowania zapytań za pomocą.
api-version	query	True	string	Wersja interfejsu API do użycia. Ta wersja interfejsu API powinna być ustawiona na wartość "7.1-preview.2".
$expand	query		QueryExpand
$includeDeleted	query		boolean	Dołączanie usuniętych zapytań i folderów
$top	query		integer int32	Liczba zwracanych zapytań (wartość domyślna to 50, a maksymalna to 200).

Odpowiedzi

Nazwa	Typ	Opis
200 OK	QueryHierarchyItemsResult	operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa	Opis
vso.work	Umożliwia odczytywanie elementów roboczych, zapytań, tablic, ścieżek obszaru i iteracji oraz innych metadanych powiązanych ze śledzeniem elementów roboczych. Umożliwia również wykonywanie zapytań, wyszukiwanie elementów roboczych i odbieranie powiadomień o zdarzeniach elementów roboczych za pośrednictwem punktów zaczepienia usługi.

Definicje

Nazwa	Opis
IdentityReference	Opisuje odwołanie do tożsamości.
LinkQueryMode	Tryb zapytania łącza.
LogicalOperation	Operator logiczny oddzielający klauzulę warunku
QueryExpand	Parametry rozwijania zapytań. Możliwe opcje to { None, Wiql, Clauses, All, Minimum }
QueryHierarchyItem	Reprezentuje element w hierarchii zapytań elementu roboczego. Może to być zapytanie lub folder.
QueryHierarchyItemsResult
QueryRecursionOption	Opcja rekursji do użycia w zapytaniu drzewa.
QueryType	Typ zapytania.
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
WorkItemFieldOperation	Opisuje operację pola elementu roboczego.
WorkItemFieldReference	Odwołanie do pola w elemencie roboczym
WorkItemQueryClause	Reprezentuje klauzulę w zapytaniu elementu roboczego. Spowoduje to wyświetlenie struktury zapytania elementu roboczego.
WorkItemQuerySortColumn	Kolumna sortowania.

IdentityReference

Opisuje odwołanie do tożsamości.

Nazwa	Typ	Opis
_links	ReferenceLinks	To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu.
descriptor	string	Deskryptor jest podstawowym sposobem odwoływanie się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji.
directoryAlias	string	Przestarzałe — można je pobrać, wykonując zapytanie względem użytkownika programu Graph, do których odwołuje się wpis "self" słownika IdentityRef "_links"
displayName	string	Jest to nieu unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, należy zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string	Przestarzałe — dostępne we wpisie "avatar" słownika IdentityRef "_links"
inactive	boolean	Przestarzałe — można pobrać, wykonując zapytanie dotyczące stanu członkostwa programu Graph, do których odwołuje się wpis "membershipState" słownika GraphUser "_links"
isAadIdentity	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
name	string	Starsza właściwość back-compat. Była to wartość specyficzna dla funkcji WIT z stałych. Będzie ukryty (ale istnieje) na kliencie, chyba że są one przeznaczone dla najnowszej wersji
profileUrl	string	Przestarzałe — nie jest używane w większości istniejących implementacji elementu ToIdentityRef
uniqueName	string	Przestarzałe — zamiast tego użyj nazwy Domain+PrincipalName
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

LinkQueryMode

Tryb zapytania łącza.

Nazwa	Typ	Opis
linksOneHopDoesNotContain	string	Zwraca elementy robocze spełniające źródło tylko wtedy, gdy żaden połączony element roboczy nie spełnia kryteriów łącza i elementu docelowego.
linksOneHopMayContain	string	Zwraca elementy robocze spełniające kryteria źródła i łącza, nawet jeśli żaden połączony element roboczy nie spełnia kryteriów docelowych.
linksOneHopMustContain	string	Zwraca elementy robocze, w których wszystkie kryteria źródła, elementu docelowego i łącza są spełnione.
linksRecursiveDoesNotContain	string
linksRecursiveMayContain	string	Zwraca elementy robocze hierarchię elementów roboczych, które domyślnie spełniają kryteria źródła
linksRecursiveMustContain	string
workItems	string	Zwraca płaską listę elementów roboczych.

LogicalOperation

Operator logiczny oddzielający klauzulę warunku

Nazwa	Typ	Opis
and	string
none	string
or	string

QueryExpand

Parametry rozwijania zapytań. Możliwe opcje to { None, Wiql, Clauses, All, Minimum }

Nazwa	Typ	Opis
all	string	Rozwija wszystkie właściwości
clauses	string	Rozwija kolumny, łącza, ChangeInfo, tekst I klauzule WIQL
minimal	string	Wyświetla minimalne właściwości i tekst WIQL
none	string	Rozwija kolumny, łącza i informacje o zmianie
wiql	string	Rozwija kolumny, łącza, tekst ChangeInfo i WIQL

QueryHierarchyItem

Reprezentuje element w hierarchii zapytań elementu roboczego. Może to być zapytanie lub folder.

Nazwa	Typ	Opis
_links	ReferenceLinks	Linki do powiązanych zasobów REST.
children	QueryHierarchyItem[]	Podrzędne elementy zapytania wewnątrz folderu zapytania.
clauses	WorkItemQueryClause	Klauzule dla zapytania płaskiego.
columns	WorkItemFieldReference[]	Kolumny zapytania.
createdBy	IdentityReference	Tożsamość, która utworzyła element zapytania.
createdDate	string	Po utworzeniu elementu zapytania.
filterOptions	LinkQueryMode	Tryb zapytania łącza.
hasChildren	boolean	Jeśli jest to folder zapytań, wskazuje, czy zawiera jakiekolwiek elementy podrzędne.
id	string	Identyfikator elementu zapytania.
isDeleted	boolean	Wskazuje, czy ten element zapytania został usunięty. Ustawienie wartości false w usuniętym elemencie zapytania spowoduje jego cofnięcie. Usunięcie zapytania lub folderu nie spowoduje przywrócenia zmian uprawnień, które zostały wcześniej do niego zastosowane.
isFolder	boolean	Wskazuje, czy jest to folder zapytania, czy zapytanie.
isInvalidSyntax	boolean	Wskazuje, czy WIQL tego zapytania jest nieprawidłowy. Może to być spowodowane nieprawidłową składnią lub nieprawidłową ścieżką obszaru/iteracji.
isPublic	boolean	Wskazuje, czy ten element zapytania jest publiczny lub prywatny.
lastExecutedBy	IdentityReference	Tożsamość, która ostatnio uruchomiła zapytanie.
lastExecutedDate	string	Kiedy zapytanie zostało ostatnio uruchomione.
lastModifiedBy	IdentityReference	Tożsamość, która ostatnio zmodyfikowała element zapytania.
lastModifiedDate	string	Kiedy element zapytania został ostatnio zmodyfikowany.
linkClauses	WorkItemQueryClause	Klauzula kwerendy linku.
name	string	Nazwa elementu zapytania.
path	string	Ścieżka elementu zapytania.
queryRecursionOption	QueryRecursionOption	Opcja rekursji do użycia w zapytaniu drzewa.
queryType	QueryType	Typ zapytania.
sortColumns	WorkItemQuerySortColumn[]	Sortowanie kolumn zapytania.
sourceClauses	WorkItemQueryClause	Klauzule źródłowe w zapytaniu linku drzewa lub jednego przeskoku.
targetClauses	WorkItemQueryClause	Klauzule docelowe w zapytaniu linku drzewa lub jednego przeskoku.
url	string
wiql	string	Tekst WIQL zapytania

QueryHierarchyItemsResult

Nazwa	Typ	Opis
count	integer	Liczba elementów.
hasMore	boolean	Wskazuje, czy osiągnięto maksymalny limit zwrotu, ale jest jeszcze więcej elementów
value	QueryHierarchyItem[]	Lista elementów

QueryRecursionOption

Opcja rekursji do użycia w zapytaniu drzewa.

Nazwa	Typ	Opis
childFirst	string	Zwraca elementy robocze spełniające kryteria docelowe, nawet jeśli żaden element roboczy nie spełnia kryteriów źródła i łącza.
parentFirst	string	Zwraca elementy robocze spełniające źródło, nawet jeśli żaden połączony element roboczy nie spełnia kryteriów elementu docelowego i linku.

QueryType

Typ zapytania.

Nazwa	Typ	Opis
flat	string	Pobiera płaską listę elementów roboczych.
oneHop	string	Pobiera listę elementów roboczych i ich linków bezpośrednich.
tree	string	Pobiera drzewo elementów roboczych z ich hierarchią łączy.

ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Widok linków w trybie tylko do odczytu. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.

WorkItemFieldOperation

Opisuje operację pola elementu roboczego.

Nazwa	Typ	Opis
name	string	Przyjazna nazwa operacji.
referenceName	string	Nazwa odwołania do operacji.

WorkItemFieldReference

Odwołanie do pola w elemencie roboczym

Nazwa	Typ	Opis
name	string	Przyjazna nazwa pola.
referenceName	string	Nazwa odwołania do pola.
url	string	Adres URL REST zasobu.

WorkItemQueryClause

Reprezentuje klauzulę w zapytaniu elementu roboczego. Spowoduje to wyświetlenie struktury zapytania elementu roboczego.

Nazwa	Typ	Opis
clauses	WorkItemQueryClause[]	Klauzule podrzędne, jeśli bieżąca klauzula jest operatorem logicznym
field	WorkItemFieldReference	Pole skojarzone z warunkiem
fieldValue	WorkItemFieldReference	Prawa strona warunku, gdy porównywanie pól do pola
isFieldValue	boolean	Określa, czy jest to pole do porównania pól
logicalOperator	LogicalOperation	Operator logiczny oddzielający klauzulę warunku
operator	WorkItemFieldOperation	Operator pola
value	string	Prawa strona warunku, gdy pole do porównania wartości

WorkItemQuerySortColumn

Kolumna sortowania.

Nazwa	Typ	Opis
descending	boolean	Kierunek sortowania według.
field	WorkItemFieldReference	Pole elementu roboczego.

Udostępnij za pośrednictwem