Wiql - Query By Id

  • Reference
Service:
Work Item Tracking
API Version:
7.1-preview.2

Získá výsledky dotazu dané ID dotazu.

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql/{id}?api-version=7.1-preview.2
With optional parameters: 
GET https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql/{id}?timePrecision={timePrecision}&$top={$top}&api-version=7.1-preview.2

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
id
 path True

string

uuid

ID dotazu.
organization
 path True

string

Název organizace Azure DevOps.
project
 path

string

ID projektu nebo název projektu
team
 path

string

ID týmu nebo název týmu
api-version
 query True

string

Verze rozhraní API, která se má použít. Tato verze rozhraní API by měla být nastavená na 7.1-preview.2.
$top
 query

integer

int32

Maximální počet výsledků, které se mají vrátit.
timePrecision
 query

boolean

Zda se má použít časová přesnost nebo ne.

Odpovědi

Name Typ Description
200 OK

WorkItemQueryResult

ú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. Poskytuje také možnost spouštět dotazy, vyhledávat pracovní položky a přijímat oznámení o událostech pracovních položek prostřednictvím volání služeb.

Příklady

Sample Request

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/wiql/{id}?api-version=7.1-preview.2

Sample Response

Status code:
200 
{
  "queryType": "tree",
  "asOf": "2014-12-29T20:49:33.803Z",
  "columns": [
    {
      "referenceName": "System.Id",
      "name": "ID",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Id"
    },
    {
      "referenceName": "System.WorkItemType",
      "name": "Work Item Type",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
    },
    {
      "referenceName": "System.Title",
      "name": "Title",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
    },
    {
      "referenceName": "System.AssignedTo",
      "name": "Assigned To",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.AssignedTo"
    },
    {
      "referenceName": "System.State",
      "name": "State",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
    }
  ],
  "workItemRelations": [
    {
      "target": {
        "id": 4,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/4"
      }
    },
    {
      "target": {
        "id": 5,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/5"
      }
    },
    {
      "target": {
        "id": 6,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/6"
      }
    },
    {
      "target": {
        "id": 7,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/7"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 7,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/7"
      },
      "target": {
        "id": 8,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/8"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 7,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/7"
      },
      "target": {
        "id": 9,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/9"
      }
    },
    {
      "target": {
        "id": 11,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/11"
      }
    },
    {
      "target": {
        "id": 12,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/12"
      }
    },
    {
      "target": {
        "id": 20,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 20,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
      },
      "target": {
        "id": 1,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/1"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 20,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
      },
      "target": {
        "id": 2,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/2"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 20,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
      },
      "target": {
        "id": 3,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/3"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 20,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
      },
      "target": {
        "id": 10,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 10,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
      },
      "target": {
        "id": 13,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/13"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 10,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
      },
      "target": {
        "id": 14,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/14"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 10,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
      },
      "target": {
        "id": 15,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/15"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 10,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
      },
      "target": {
        "id": 16,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/16"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 10,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
      },
      "target": {
        "id": 17,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/17"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 10,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
      },
      "target": {
        "id": 18,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/18"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 10,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
      },
      "target": {
        "id": 19,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/19"
      }
    },
    {
      "target": {
        "id": 21,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/21"
      }
    },
    {
      "target": {
        "id": 33,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/33"
      }
    },
    {
      "target": {
        "id": 34,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/34"
      }
    },
    {
      "target": {
        "id": 46,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/46"
      }
    },
    {
      "target": {
        "id": 47,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/47"
      }
    },
    {
      "target": {
        "id": 58,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/58"
      }
    },
    {
      "target": {
        "id": 59,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/59"
      }
    },
    {
      "target": {
        "id": 297,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/297"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 297,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/297"
      },
      "target": {
        "id": 299,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/299"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 297,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/297"
      },
      "target": {
        "id": 300,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/300"
      }
    },
    {
      "target": {
        "id": 298,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/298"
      }
    }
  ]
}

Definice

Name Description
QueryResultType

Typ výsledku
QueryType

Typ dotazu.
WorkItemFieldReference

Odkaz na pole v pracovní položce
WorkItemLink

Propojení mezi dvěma pracovními položkami
WorkItemQueryResult

Výsledek dotazu na pracovní položky.
WorkItemQuerySortColumn

Sloupec řazení.
WorkItemReference

Obsahuje odkaz na pracovní položku.

QueryResultType

Typ výsledku

Name Typ Description
workItem

string

Seznam pracovních položek (pro ploché dotazy)
workItemLink

string

Seznam odkazů na pracovní položky (pro dotazy OneHop a Tree).

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

WorkItemFieldReference

Odkaz na pole v pracovní položce

Name Typ Description
name

string

Popisný název pole
referenceName

string

Název odkazu pole.
url

string

Adresa URL REST prostředku.

Propojení mezi dvěma pracovními položkami

Name Typ Description
rel

string

Typ odkazu.
source

WorkItemReference

Zdrojová pracovní položka.
target

WorkItemReference

Cílová pracovní položka.

WorkItemQueryResult

Výsledek dotazu na pracovní položky.

Name Typ Description
asOf

string

Datum, kdy byl dotaz spuštěn v kontextu.
columns

WorkItemFieldReference[]

Sloupce dotazu
queryResultType

QueryResultType

Typ výsledku
queryType

QueryType

Typ dotazu
sortColumns

WorkItemQuerySortColumn[]

Sloupce řazení dotazu
workItemRelations

WorkItemLink[]

Odkazy na pracovní položky vrácené dotazem
workItems

WorkItemReference[]

Pracovní položky vrácené dotazem

WorkItemQuerySortColumn

Sloupec řazení.

Name Typ Description
descending

boolean

Směr řazení.
field

WorkItemFieldReference

Pole pracovní položky.

WorkItemReference

Obsahuje odkaz na pracovní položku.

Name Typ Description
id

integer

ID pracovní položky.
url

string

Adresa URL rozhraní REST API prostředku