Wiql - Query By Wiql

참조

Service:: Work Item Tracking

API Version:: 6.1-preview.2

해당 WIQL이 지정된 쿼리의 결과를 가져옵니다.

POST https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql?api-version=6.1-preview.2

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql?timePrecision={timePrecision}&$top={$top}&api-version=6.1-preview.2

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
organization	path	True	string	Azure DevOps 조직의 이름입니다.
project	path		string	프로젝트 ID 또는 프로젝트 이름
team	path		string	팀 ID 또는 팀 이름
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 api를 사용하려면 '6.1-preview.2'로 설정해야 합니다.
$top	query		integer int32	반환할 최대 결과 수입니다.
timePrecision	query		boolean	시간 정밀도를 사용할지 여부입니다.

요청 본문

Name	형식	Description
query	string	WIQL 쿼리의 텍스트

응답

Name	형식	Description
200 OK	WorkItemQueryResult	성공한 작업

보안

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	작업 항목, 쿼리, 보드, 영역 및 반복 경로 및 기타 작업 항목 추적 관련 메타데이터를 읽을 수 있는 기능을 부여합니다. 또한 쿼리를 실행하고, 작업 항목을 검색하고, 서비스 후크를 통해 작업 항목 이벤트에 대한 알림을 받을 수 있는 기능을 부여합니다.

예제

Get results of a flat work item query.

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/wit/wiql?api-version=6.1-preview.2

{
  "query": "Select [System.Id], [System.Title], [System.State] From WorkItems Where [System.WorkItemType] = 'Task' AND [State] <> 'Closed' AND [State] <> 'Removed' order by [Microsoft.VSTS.Common.Priority] asc, [System.CreatedDate] desc"
}

Sample Response

Status code:: 200

{
  "queryType": "flat",
  "asOf": "2014-12-29T20:49:34.617Z",
  "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
    }
  ],
  "workItems": [
    {
      "id": 300,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/300"
    },
    {
      "id": 299,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/299"
    },
    {
      "id": 298,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/298"
    },
    {
      "id": 17,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/17"
    },
    {
      "id": 16,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/16"
    },
    {
      "id": 15,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/15"
    },
    {
      "id": 14,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/14"
    },
    {
      "id": 9,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/9"
    },
    {
      "id": 8,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/8"
    }
  ]
}

정의

Name	Description
QueryResultType	결과 유형입니다.
QueryType	쿼리 유형입니다.
Wiql	WIQL 쿼리
WorkItemFieldReference	작업 항목의 필드에 대한 참조
WorkItemLink	두 작업 항목 간의 링크입니다.
WorkItemQueryResult	작업 항목 쿼리의 결과입니다.
WorkItemQuerySortColumn	정렬 열입니다.
WorkItemReference	작업 항목에 대한 참조를 포함합니다.

QueryResultType

결과 유형입니다.

Name	형식	Description
workItem	string	작업 항목 목록입니다(플랫 쿼리의 경우).
workItemLink	string	작업 항목 링크 목록(OneHop 및 트리 쿼리의 경우).

QueryType

쿼리 유형입니다.

Name	형식	Description
flat	string	작업 항목의 플랫 목록을 가져옵니다.
oneHop	string	작업 항목 및 직접 링크 목록을 가져옵니다.
tree	string	링크 계층 구조를 보여 주는 작업 항목의 트리를 가져옵니다.

Wiql

WIQL 쿼리

Name	형식	Description
query	string	WIQL 쿼리의 텍스트

WorkItemFieldReference

작업 항목의 필드에 대한 참조

Name	형식	Description
name	string	필드의 이름입니다.
referenceName	string	필드의 참조 이름입니다.
url	string	리소스의 REST URL입니다.

WorkItemLink

두 작업 항목 간의 링크입니다.

Name	형식	Description
rel	string	링크 형식입니다.
source	WorkItemReference	원본 작업 항목입니다.
target	WorkItemReference	대상 작업 항목입니다.

WorkItemQueryResult

작업 항목 쿼리의 결과입니다.

Name	형식	Description
asOf	string	쿼리가 컨텍스트에서 실행된 날짜입니다.
columns	WorkItemFieldReference[]	쿼리의 열입니다.
queryResultType	QueryResultType	결과 유형입니다.
queryType	QueryType	쿼리의 형식입니다.
sortColumns	WorkItemQuerySortColumn[]	쿼리의 정렬 열입니다.
workItemRelations	WorkItemLink[]	쿼리에서 반환된 작업 항목 링크입니다.
workItems	WorkItemReference[]	쿼리에서 반환된 작업 항목입니다.

WorkItemQuerySortColumn

정렬 열입니다.

Name	형식	Description
descending	boolean	정렬 기준 방향입니다.
field	WorkItemFieldReference	작업 항목 필드입니다.

WorkItemReference

작업 항목에 대한 참조를 포함합니다.

Name	형식	Description
id	integer	작업 항목 ID입니다.
url	string	리소스의 REST API URL