Queries - Get Queries Batch

Odwołanie

Usługa:: Work Item Tracking

Wersja interfejsu API:: 5.0

Pobiera listę zapytań według identyfikatorów (maksymalnie 1000)

POST https://dev.azure.com/{organization}/{project}/_apis/wit/queriesbatch?api-version=5.0

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
api-version	query	True	string	Wersja interfejsu API do użycia. Powinno to być ustawione na wartość "5.0", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
$expand	QueryExpand	Parametry rozwijania zapytań. Możliwe opcje to { None, Wiql, Clauses, All, Minimum }
errorPolicy	QueryErrorPolicy	Flaga do kontrolowania zasad błędów w żądaniu wsadowym zapytania. Możliwe opcje to { Niepowodzenie, Pomiń }.
ids	string[]	Żądane identyfikatory zapytań

Odpowiedzi

Nazwa	Typ	Opis
200 OK	QueryHierarchyItem[]	operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

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.

Przykłady

Gets a list of queries by ids

Przykładowe żądanie

HTTP

POST https://dev.azure.com/fabrikam/{project}/_apis/wit/queriesbatch?api-version=5.0

{
  "ids": [
    "c6725763-d9ae-487e-bb42-00222e2f4d9f",
    "c19eec2d-07a0-4c20-be57-3f7903792ca6",
    "298f94fd-30ea-40f3-8d25-3202c9effa3a"
  ]
}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "count": 3,
  "value": [
    {
      "id": "c6725763-d9ae-487e-bb42-00222e2f4d9f",
      "name": "Work Items With Summary Values",
      "path": "Shared Queries/Troubleshooting/Work Items With Summary Values",
      "createdBy": {
        "displayName": "Jamal Hartnett",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
          }
        },
        "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "uniqueName": "fabrikamfiber4@hotmail.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      },
      "createdDate": "2018-09-26T19:01:44.6Z",
      "lastModifiedBy": {
        "displayName": "Jamal Hartnett",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
          }
        },
        "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "uniqueName": "fabrikamfiber4@hotmail.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      },
      "lastModifiedDate": "2018-09-26T19:01:44.6Z",
      "queryType": "oneHop",
      "isPublic": true,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/c6725763-d9ae-487e-bb42-00222e2f4d9f"
        },
        "html": {
          "href": "http://localhost:8080/tfs/web/qr.aspx?pguid=833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d&qid=c6725763-d9ae-487e-bb42-00222e2f4d9f"
        },
        "parent": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/0389af80-0be8-4c1b-800e-9e91d081e052"
        },
        "wiql": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/wiql/c6725763-d9ae-487e-bb42-00222e2f4d9f"
        }
      },
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/c6725763-d9ae-487e-bb42-00222e2f4d9f"
    },
    {
      "id": "c19eec2d-07a0-4c20-be57-3f7903792ca6",
      "name": "Product Planning",
      "path": "Shared Queries/Product Planning",
      "createdBy": {
        "displayName": "Jamal Hartnett",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
          }
        },
        "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "uniqueName": "fabrikamfiber4@hotmail.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      },
      "createdDate": "2018-09-26T19:01:44.6Z",
      "lastModifiedBy": {
        "displayName": "Jamal Hartnett",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
          }
        },
        "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "uniqueName": "fabrikamfiber4@hotmail.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      },
      "lastModifiedDate": "2018-09-26T19:01:44.6Z",
      "queryType": "flat",
      "isPublic": true,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/c19eec2d-07a0-4c20-be57-3f7903792ca6"
        },
        "html": {
          "href": "http://localhost:8080/tfs/web/qr.aspx?pguid=833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d&qid=c19eec2d-07a0-4c20-be57-3f7903792ca6"
        },
        "parent": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/06285cdf-e6f2-4230-80fd-66a2e11116d2"
        },
        "wiql": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/wiql/c19eec2d-07a0-4c20-be57-3f7903792ca6"
        }
      },
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/c19eec2d-07a0-4c20-be57-3f7903792ca6"
    },
    {
      "id": "298f94fd-30ea-40f3-8d25-3202c9effa3a",
      "name": "Current Iteration",
      "path": "Shared Queries/Current Iteration",
      "createdBy": {
        "displayName": "Jamal Hartnett",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
          }
        },
        "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "uniqueName": "fabrikamfiber4@hotmail.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      },
      "createdDate": "2018-09-26T19:01:44.6Z",
      "lastModifiedBy": {
        "displayName": "Jamal Hartnett",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
          }
        },
        "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "uniqueName": "fabrikamfiber4@hotmail.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
        "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
      },
      "lastModifiedDate": "2018-09-26T19:01:44.6Z",
      "isFolder": true,
      "hasChildren": true,
      "isPublic": true,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/298f94fd-30ea-40f3-8d25-3202c9effa3a"
        },
        "html": {
          "href": "http://localhost:8080/tfs/web/qr.aspx?pguid=833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d&qid=298f94fd-30ea-40f3-8d25-3202c9effa3a"
        },
        "parent": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/06285cdf-e6f2-4230-80fd-66a2e11116d2"
        }
      },
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/298f94fd-30ea-40f3-8d25-3202c9effa3a"
    }
  ]
}

Definicje

Nazwa	Opis
IdentityReference	Opisuje odwołanie do tożsamości.
LinkQueryMode	Tryb zapytania łącza.
LogicalOperation	Operator logiczny oddzielający klauzulę warunku
QueryBatchGetRequest	Opisuje żądanie pobrania listy zapytań
QueryErrorPolicy	Flaga do kontrolowania zasad błędów w żądaniu wsadowym zapytania. Możliwe opcje to { Niepowodzenie, Pomiń }.
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.
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

Object

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
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
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
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
uniqueName	string
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

LinkQueryMode

Enumeration

Tryb zapytania łącza.

Wartość	Opis
linksOneHopDoesNotContain	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	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	Zwraca elementy robocze, w których wszystkie kryteria źródła, elementu docelowego i łącza są spełnione.
linksRecursiveDoesNotContain
linksRecursiveMayContain	Zwraca elementy robocze hierarchię elementów roboczych, które domyślnie spełniają kryteria źródła
linksRecursiveMustContain
workItems

LogicalOperation

Enumeration

Operator logiczny oddzielający klauzulę warunku

Wartość	Opis
aND
nONE
oR

QueryBatchGetRequest

Object

Opisuje żądanie pobrania listy zapytań

Nazwa	Typ	Opis
$expand	QueryExpand	Parametry rozwijania zapytań. Możliwe opcje to { None, Wiql, Clauses, All, Minimum }
errorPolicy	QueryErrorPolicy	Flaga do kontrolowania zasad błędów w żądaniu wsadowym zapytania. Możliwe opcje to { Niepowodzenie, Pomiń }.
ids	string[]	Żądane identyfikatory zapytań

QueryErrorPolicy

Enumeration

Flaga do kontrolowania zasad błędów w żądaniu wsadowym zapytania. Możliwe opcje to { Niepowodzenie, Pomiń }.

Wartość	Opis
fail
omit

QueryExpand

Enumeration

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

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

QueryHierarchyItem

Object

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

QueryRecursionOption

Enumeration

Opcja rekursji do użycia w zapytaniu drzewa.

Wartość	Opis
childFirst	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	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

Enumeration

Typ zapytania.

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

ReferenceLinks

Object

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

Object

Opisuje operację pola elementu roboczego.

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

WorkItemFieldReference

Object

Odwołanie do pola w elemencie roboczym

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

WorkItemQueryClause

Object

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

Object

Kolumna sortowania.

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

Udostępnij przez

Queries - Get Queries Batch

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

oauth2

Zakresy

Przykłady

Gets a list of queries by ids

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

IdentityReference

LinkQueryMode

LogicalOperation

QueryBatchGetRequest

QueryErrorPolicy

QueryExpand

QueryHierarchyItem

QueryRecursionOption

QueryType

ReferenceLinks

WorkItemFieldOperation

WorkItemFieldReference

WorkItemQueryClause

WorkItemQuerySortColumn