Queries - Create

Vytvoří dotaz nebo přesune dotaz.

Další informace o syntaxi jazyka WIQL (Work Item Query Language) najdete tady.

POST https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query}?api-version=5.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

query
path True

string

ID nadřazeného objektu nebo cesta, pod kterou se má dotaz vytvořit.

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 5.0.

Text požadavku

Name Typ Description
_links

ReferenceLinks

Odkazy na související prostředky REST.

children

QueryHierarchyItem[]

Podřízené položky dotazů ve složce dotazů.

clauses

WorkItemQueryClause

Klauzule pro plochý dotaz.

columns

WorkItemFieldReference[]

Sloupce dotazu

createdBy

IdentityReference

Identita, která vytvořila položku dotazu.

createdDate

string

Kdy byla vytvořena položka dotazu.

filterOptions

LinkQueryMode

Režim dotazu odkazu.

hasChildren

boolean

Pokud se jedná o složku dotazů, označuje, jestli obsahuje nějaké podřízené položky.

id

string

ID položky dotazu.

isDeleted

boolean

Označuje, jestli je tato položka dotazu odstraněna. Nastavením této hodnoty na false u odstraněné položky dotazu se zruší odstranění. Zrušením odstranění dotazu nebo složky se nevrátí změny oprávnění, které se na dotaz nebo složku dříve použily.

isFolder

boolean

Určuje, jestli se jedná o složku dotazů nebo dotaz.

isInvalidSyntax

boolean

Označuje, jestli je jazyk WIQL tohoto dotazu neplatný. Příčinou může být neplatná syntaxe nebo neplatná cesta k oblasti nebo iteraci.

isPublic

boolean

Určuje, jestli je tato položka dotazu veřejná nebo soukromá.

lastExecutedBy

IdentityReference

Identita, která dotaz naposledy spustila.

lastExecutedDate

string

Kdy byl dotaz naposledy spuštěn.

lastModifiedBy

IdentityReference

Identita, která naposledy upravila položku dotazu.

lastModifiedDate

string

Kdy byla položka dotazu naposledy změněna.

linkClauses

WorkItemQueryClause

Klauzule dotazu odkazu

name

string

Název položky dotazu.

path

string

Cesta k položce dotazu.

queryRecursionOption

QueryRecursionOption

Možnost rekurze pro použití ve stromovém dotazu.

queryType

QueryType

Typ dotazu.

sortColumns

WorkItemQuerySortColumn[]

Sloupce řazení dotazu

sourceClauses

WorkItemQueryClause

Zdrojové klauzule ve stromovém dotazu nebo dotazu propojení s jedním segmentem směrování.

targetClauses

WorkItemQueryClause

Cílové klauzule ve stromovém dotazu nebo dotazu propojení s jedním segmentem směrování.

url

string

wiql

string

Text dotazu v jazyce WIQL

Odpovědi

Name Typ Description
200 OK

QueryHierarchyItem

ú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_write Uděluje možnost číst, vytvářet a aktualizovat pracovní položky a dotazy, metadata aktualizačního panelu, oblast čtení a iterace cest k jiným metadatům souvisejícím se sledováním pracovních položek, spouštět dotazy a přijímat oznámení o událostech pracovních položek prostřednictvím zachytávání služeb.

Příklady

Create a folder
Create a query
Move a query or folder

Create a folder

Sample Request

POST https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?api-version=5.0

{
  "name": "Website team",
  "isFolder": true
}

Sample Response

{
  "id": "8a8c8212-15ca-41ed-97aa-1d6fbfbcd581",
  "name": "Website team",
  "path": "Shared Queries/Website team",
  "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": "2016-06-01T16:58:56.323Z",
  "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": "2016-06-01T16:58:56.323Z",
  "isFolder": true,
  "hasChildren": false,
  "isPublic": true,
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
    },
    "html": {
      "href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
    },
    "parent": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/eb5c1e25-9b3e-4416-a833-e500122882c7"
    }
  },
  "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
}

Create a query

Sample Request

POST https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?api-version=5.0

{
  "name": "All Bugs",
  "wiql": "Select [System.Id], [System.Title], [System.State] From WorkItems Where [System.WorkItemType] = 'Bug' order by [Microsoft.VSTS.Common.Priority] asc, [System.CreatedDate] desc"
}

Sample Response

{
  "id": "342f0f44-4069-46b1-a940-3d0468979ceb",
  "name": "All Bugs",
  "path": "Shared Queries/Website team/All Bugs",
  "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": "2016-06-01T16:58:56.64Z",
  "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": "2016-06-01T16:58:56.64Z",
  "queryType": "flat",
  "columns": [
    {
      "referenceName": "System.Id",
      "name": "ID",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Id"
    },
    {
      "referenceName": "System.Title",
      "name": "Title",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
    },
    {
      "referenceName": "System.State",
      "name": "State",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
    }
  ],
  "sortColumns": [
    {
      "field": {
        "referenceName": "Microsoft.VSTS.Common.Priority",
        "name": "Priority",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.Priority"
      },
      "descending": false
    },
    {
      "field": {
        "referenceName": "System.CreatedDate",
        "name": "Created Date",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.CreatedDate"
      },
      "descending": true
    }
  ],
  "wiql": "select [System.Id], [System.Title], [System.State] from WorkItems where [System.WorkItemType] = 'Bug' order by [Microsoft.VSTS.Common.Priority] asc, [System.CreatedDate] desc",
  "isPublic": true,
  "clauses": {
    "field": {
      "referenceName": "System.WorkItemType",
      "name": "Work Item Type",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
    },
    "operator": {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    "value": "Bug"
  },
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/342f0f44-4069-46b1-a940-3d0468979ceb"
    },
    "html": {
      "href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=342f0f44-4069-46b1-a940-3d0468979ceb"
    },
    "parent": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
    },
    "wiql": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/wiql/342f0f44-4069-46b1-a940-3d0468979ceb"
    }
  },
  "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/342f0f44-4069-46b1-a940-3d0468979ceb"
}

Move a query or folder

Sample Request

POST https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?api-version=5.0

{
  "id": "8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
}

Sample Response

{
  "id": "8a8c8212-15ca-41ed-97aa-1d6fbfbcd581",
  "name": "Website",
  "path": "My Queries/Website",
  "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": "2016-06-01T16:58:56.323Z",
  "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": "2016-06-01T16:58:59.407Z",
  "isFolder": true,
  "hasChildren": true,
  "isPublic": false,
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
    },
    "html": {
      "href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
    },
    "parent": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/3c65fbc1-d427-48ce-9091-633dde9e27e2"
    }
  },
  "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
}

Definice

Name Description
IdentityReference

Popisuje odkaz na identitu.

LinkQueryMode

Režim dotazu odkazu.

LogicalOperation

Logický operátor oddělující podmínku klauzule

QueryHierarchyItem

Představuje položku v hierarchii dotazů pracovní položky. Může se jednat o dotaz nebo složku.

QueryRecursionOption

Možnost rekurze pro použití ve stromovém dotazu.

QueryType

Typ dotazu.

ReferenceLinks

Třída představující kolekci odkazů REST.

WorkItemFieldOperation

Popisuje operaci pole pracovní položky.

WorkItemFieldReference

Odkaz na pole v pracovní položce

WorkItemQueryClause

Představuje klauzuli v dotazu pracovní položky. Zobrazí strukturu dotazu na pracovní položky.

WorkItemQuerySortColumn

Sloupec řazení.

IdentityReference

Popisuje odkaz na identitu.

Name Typ Description
_links

ReferenceLinks

Toto pole neobsahuje žádný nebo více zajímavých odkazů na téma 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 v rámci účtů i organizací.

directoryAlias

string

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

inactive

boolean

isAadIdentity

boolean

isContainer

boolean

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

uniqueName

string

url

string

Tato adresa URL představuje úplnou trasu 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é vyhovují zdroji, 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ěna všechna kritéria zdroje, cíle a odkazu.

linksRecursiveDoesNotContain

string

linksRecursiveMayContain

string

Vrátí pracovní položky hierarchii pracovních položek, které ve výchozím nastavení vyhovují zdroji.

linksRecursiveMustContain

string

workItems

string

LogicalOperation

Logický operátor oddělující podmínku klauzule

Name Typ Description
aND

string

nONE

string

oR

string

QueryHierarchyItem

Představuje položku v hierarchii dotazů pracovní položky. Může se jednat o dotaz nebo složku.

Name Typ Description
_links

ReferenceLinks

Odkazy na související prostředky REST.

children

QueryHierarchyItem[]

Podřízené položky dotazů ve složce dotazů.

clauses

WorkItemQueryClause

Klauzule pro plochý dotaz.

columns

WorkItemFieldReference[]

Sloupce dotazu

createdBy

IdentityReference

Identita, která vytvořila položku dotazu.

createdDate

string

Kdy byla vytvořena položka dotazu.

filterOptions

LinkQueryMode

Režim dotazu odkazu.

hasChildren

boolean

Pokud se jedná o složku dotazů, označuje, jestli obsahuje nějaké podřízené položky.

id

string

ID položky dotazu.

isDeleted

boolean

Označuje, jestli je tato položka dotazu odstraněna. Nastavením této hodnoty na false u odstraněné položky dotazu se zruší odstranění. Zrušením odstranění dotazu nebo složky se nevrátí změny oprávnění, které se na dotaz nebo složku dříve použily.

isFolder

boolean

Určuje, jestli se jedná o složku dotazů nebo dotaz.

isInvalidSyntax

boolean

Označuje, jestli je jazyk WIQL tohoto dotazu neplatný. Příčinou může být neplatná syntaxe nebo neplatná cesta k oblasti nebo iteraci.

isPublic

boolean

Určuje, jestli je tato položka dotazu veřejná nebo soukromá.

lastExecutedBy

IdentityReference

Identita, která dotaz naposledy spustila.

lastExecutedDate

string

Kdy byl dotaz naposledy spuštěn.

lastModifiedBy

IdentityReference

Identita, která naposledy upravila položku dotazu.

lastModifiedDate

string

Kdy byla položka dotazu naposledy změněna.

linkClauses

WorkItemQueryClause

Klauzule dotazu odkazu

name

string

Název položky dotazu.

path

string

Cesta k položce dotazu.

queryRecursionOption

QueryRecursionOption

Možnost rekurze pro použití ve stromovém dotazu.

queryType

QueryType

Typ dotazu.

sortColumns

WorkItemQuerySortColumn[]

Sloupce řazení dotazu

sourceClauses

WorkItemQueryClause

Zdrojové klauzule ve stromovém dotazu nebo dotazu propojení s jedním segmentem směrování.

targetClauses

WorkItemQueryClause

Cílové klauzule ve stromovém dotazu nebo dotazu propojení s jedním segmentem směrování.

url

string

wiql

string

Text dotazu v jazyce WIQL

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 propojení.

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í.

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 odkazy jen pro čtení.

WorkItemFieldOperation

Popisuje operaci pole pracovní položky.

Name Typ Description
name

string

Název operace.

referenceName

string

Referenční název operace.

WorkItemFieldReference

Odkaz na pole v pracovní položce

Name Typ Description
name

string

Název pole.

referenceName

string

Název odkazu pole.

url

string

Adresa URL REST prostředku.

WorkItemQueryClause

Představuje klauzuli v dotazu pracovní položky. Zobrazí strukturu dotazu na pracovní položky.

Name Typ Description
clauses

WorkItemQueryClause[]

Podřízené klauzule, pokud je aktuální klauzule logickým operátorem

field

WorkItemFieldReference

Pole přidružené k podmínce

fieldValue

WorkItemFieldReference

Pravá strana podmínky při porovnání pole s poli

isFieldValue

boolean

Určuje, jestli se jedná o pole pro porovnání polí.

logicalOperator

LogicalOperation

Logický operátor oddělující podmínku klauzule

operator

WorkItemFieldOperation

Operátor pole

value

string

Pravá strana podmínky při porovnání pole k hodnotě

WorkItemQuerySortColumn

Sloupec řazení.

Name Typ Description
descending

boolean

Směr řazení.

field

WorkItemFieldReference

Pole pracovní položky.