Queries - Search Queries
Prohledá všechny dotazy, ke které má uživatel přístup v aktuálním projektu.
GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries?$filter={$filter}&api-version=6.0
GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries?$filter={$filter}&$top={$top}&$expand={$expand}&$includeDeleted={$includeDeleted}&api-version=6.0
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
organization
|
path | True |
string |
Název organizace Azure DevOps. |
project
|
path | True |
string |
ID projektu nebo název projektu |
$filter
|
query | True |
string |
Text, pomocí který chcete filtrovat dotazy. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na hodnotu 6.0. |
$expand
|
query | |||
$include
|
query |
boolean |
Zahrnutí odstraněných dotazů a složek |
|
$top
|
query |
integer int32 |
Počet dotazů, které se mají vrátit (výchozí hodnota je 50 a maximum je 200). |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
úspěšná operace |
Zabezpečení
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 | Description |
---|---|
vso.work | Umožňuje číst pracovní položky, dotazy, panely, cesty oblastí a iterací a další metadata související se sledováním pracovních položek. Umožňuje také spouštět dotazy, prohledávat pracovní položky a přijímat oznámení o událostech pracovních položek prostřednictvím služeb. |
Definice
Name | Description |
---|---|
Identity |
Popisuje odkaz na identitu. |
Link |
Režim dotazu odkazu. |
Logical |
Logický operátor oddělující klauzuli podmínky |
Query |
Parametry rozbalení pro dotazy. Možné možnosti jsou { None, Wiql, Clauses, All, Minimal } |
Query |
Představuje položku v hierarchii dotazů pracovních položek. Může se jednat o dotaz nebo složku. |
Query |
|
Query |
Možnost rekurze pro použití ve stromovém dotazu. |
Query |
Typ dotazu. |
Reference |
Třída představující kolekci odkazů REST. |
Work |
Popisuje operaci pole pracovní položky. |
Work |
Odkaz na pole v pracovní položce |
Work |
Představuje klauzuli v dotazu na pracovní položku. Zobrazí se struktura dotazu na pracovní položky. |
Work |
Sloupec řazení. |
IdentityReference
Popisuje odkaz na identitu.
Name | Typ | Description |
---|---|---|
_links |
Toto pole obsahuje nula nebo více zajímavých odkazů o předmětu grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto předmětu grafu. |
|
descriptor |
string |
Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu napříč účty i organizacemi. |
directoryAlias |
string |
Zastaralé – lze načíst dotazem uživatele Graphu, na který odkazuje položka "self" slovníku IdentityRef "_links". |
displayName |
string |
Toto je jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli. |
id |
string |
|
imageUrl |
string |
Zastaralé – k dispozici v položce avatar ve slovníku IdentityRef "_links". |
inactive |
boolean |
Zastaralé – lze načíst dotazem na stav členství graphu, na který odkazuje položka membershipState slovníku GraphUser "_links". |
isAadIdentity |
boolean |
Zastaralé – lze odvodit z typu předmětu popisovače (Descriptor.IsAadUserType/Descriptor.IsAadGroupType). |
isContainer |
boolean |
Zastaralé – lze odvodit z typu předmětu popisovače (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
name |
string |
Starší vlastnost back-compat Jedná se o hodnotu specifickou pro WIT z konstant. Bude na klientovi skrytá (ale existuje), pokud cílí na nejnovější verzi. |
profileUrl |
string |
Zastaralé – nepoužívá se ve většině existujících implementací ToIdentityRef |
uniqueName |
string |
Zastaralé – místo toho použijte Domain+PrincipalName. |
url |
string |
Tato adresa URL je úplná trasa ke zdrojovému prostředku tohoto předmětu grafu. |
LinkQueryMode
Režim dotazu odkazu.
Name | Typ | Description |
---|---|---|
linksOneHopDoesNotContain |
string |
Vrátí pracovní položky, které splňují zdroj, pouze pokud žádná propojená pracovní položka nesplňuje kritéria propojení a cíle. |
linksOneHopMayContain |
string |
Vrátí pracovní položky, které splňují kritéria zdroje a propojení, i když žádná propojená pracovní položka nesplňuje cílová kritéria. |
linksOneHopMustContain |
string |
Vrátí pracovní položky, u kterých jsou splněná kritéria zdroje, cíle a odkazu. |
linksRecursiveDoesNotContain |
string |
|
linksRecursiveMayContain |
string |
Vrátí pracovní položky jako hierarchii pracovních položek, které ve výchozím nastavení vyhovují zdroji. |
linksRecursiveMustContain |
string |
|
workItems |
string |
Vrátí plochý seznam pracovních položek. |
LogicalOperation
Logický operátor oddělující klauzuli podmínky
Name | Typ | Description |
---|---|---|
and |
string |
|
none |
string |
|
or |
string |
QueryExpand
Parametry rozbalení pro dotazy. Možné možnosti jsou { None, Wiql, Clauses, All, Minimal }
Name | Typ | Description |
---|---|---|
all |
string |
Rozbalí všechny vlastnosti. |
clauses |
string |
Rozbalí sloupce, odkazy, changeinfo, text a klauzule WIQL. |
minimal |
string |
Zobrazí minimální vlastnosti a text WIQL. |
none |
string |
Rozbalí sloupce, odkazy a ChangeInfo. |
wiql |
string |
Rozbalí sloupce, odkazy, changeinfo a text WIQL. |
QueryHierarchyItem
Představuje položku v hierarchii dotazů pracovních položek. Může se jednat o dotaz nebo složku.
Name | Typ | Description |
---|---|---|
_links |
Odkazy na související prostředky REST |
|
children |
Podřízené položky dotazů ve složce dotazů. |
|
clauses |
Klauzule pro plochý dotaz. |
|
columns |
Sloupce dotazu |
|
createdBy |
Identita, která vytvořila položku dotazu. |
|
createdDate |
string |
Při vytvoření položky dotazu. |
filterOptions |
Režim dotazu odkazu. |
|
hasChildren |
boolean |
Pokud se jedná o složku dotazu, označuje, jestli obsahuje podřízené položky. |
id |
string |
ID položky dotazu. |
isDeleted |
boolean |
Označuje, jestli je tato položka dotazu odstraněna. Pokud tuto hodnotu nastavíte u odstraněné položky dotazu na hodnotu false, zrušíte ji. Zrušením příkazu nebo složky se nevrátí změny oprávnění, které se na něj dříve použily. |
isFolder |
boolean |
Označuje, jestli se jedná o složku dotazu nebo dotaz. |
isInvalidSyntax |
boolean |
Označuje, jestli je hodnota WIQL tohoto dotazu neplatná. Příčinou může být neplatná syntaxe nebo neplatná cesta k oblasti nebo iteraci. |
isPublic |
boolean |
Označuje, jestli je tato položka dotazu veřejná nebo soukromá. |
lastExecutedBy |
Identita, která naposledy spustila dotaz. |
|
lastExecutedDate |
string |
Kdy byl dotaz naposledy spuštěn. |
lastModifiedBy |
Identita, která naposledy upravila položku dotazu |
|
lastModifiedDate |
string |
Kdy byla položka dotazu naposledy změněna. |
linkClauses |
Klauzule dotazu odkazu |
|
name |
string |
Název položky dotazu. |
path |
string |
Cesta k položce dotazu. |
queryRecursionOption |
Možnost rekurze pro použití ve stromovém dotazu. |
|
queryType |
Typ dotazu. |
|
sortColumns |
Sloupce řazení dotazu. |
|
sourceClauses |
Zdrojové klauzule ve stromovém dotazu nebo dotazu s jedním směrováním. |
|
targetClauses |
Cílové klauzule ve stromu nebo dotazu na propojení s jedním segmentem směrování. |
|
url |
string |
|
wiql |
string |
Text WIQL dotazu |
QueryHierarchyItemsResult
Name | Typ | Description |
---|---|---|
count |
integer |
Počet položek. |
hasMore |
boolean |
Označuje, jestli došlo k dosažení maximálního limitu vrácení, ale stále existuje více položek. |
value |
Seznam položek |
QueryRecursionOption
Možnost rekurze pro použití ve stromovém dotazu.
Name | Typ | Description |
---|---|---|
childFirst |
string |
Vrátí pracovní položky, které splňují cílová kritéria, i když žádná pracovní položka nesplňuje kritéria zdroje a odkazu. |
parentFirst |
string |
Vrátí pracovní položky, které vyhovují zdroji, i když žádná propojená pracovní položka nesplňuje kritéria cíle a odkazu. |
QueryType
Typ dotazu.
Name | Typ | Description |
---|---|---|
flat |
string |
Získá plochý seznam pracovních položek. |
oneHop |
string |
Získá seznam pracovních položek a jejich přímé odkazy. |
tree |
string |
Získá strom pracovních položek zobrazující jejich hierarchii propojení. |
ReferenceLinks
Třída představující kolekci odkazů REST.
Name | Typ | Description |
---|---|---|
links |
object |
Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako jen pro čtení. |
WorkItemFieldOperation
Popisuje operaci pole pracovní položky.
Name | Typ | Description |
---|---|---|
name |
string |
Popisný název operace |
referenceName |
string |
Referenční název operace. |
WorkItemFieldReference
Odkaz na pole v pracovní položce
Name | Typ | Description |
---|---|---|
name |
string |
Popisný název pole |
referenceName |
string |
Referenční název pole. |
url |
string |
Adresa URL REST prostředku. |
WorkItemQueryClause
Představuje klauzuli v dotazu na pracovní položku. Zobrazí se struktura dotazu na pracovní položky.
Name | Typ | Description |
---|---|---|
clauses |
Podřízené klauzule, pokud je aktuální klauzule logickým operátorem |
|
field |
Pole přidružené k podmínce |
|
fieldValue |
Pravá strana podmínky při porovnání polí s poli |
|
isFieldValue |
boolean |
Určuje, jestli se jedná o porovnání polí. |
logicalOperator |
Logický operátor oddělující klauzuli podmínky |
|
operator |
Operátor pole |
|
value |
string |
Pravá strana podmínky při porovnání pole s hodnotou |
WorkItemQuerySortColumn
Sloupec řazení.
Name | Typ | Description |
---|---|---|
descending |
boolean |
Směr řazení. |
field |
Pole pracovní položky. |