Queries - Get Queries Batch

참조

Service:: Work Item Tracking

API Version:: 5.0

ID로 쿼리 목록을 가져옵니다(최대 1000).

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
organization	path	True	string	Azure DevOps 조직의 이름입니다.
project	path	True	string	프로젝트 ID 또는 프로젝트 이름
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 api를 사용하려면 '5.0'으로 설정해야 합니다.

요청 본문

Name	형식	Description
$expand	QueryExpand	쿼리에 대한 확장 매개 변수입니다. 가능한 옵션은 { None, Wiql, Clauses, All, Minimal }입니다.
errorPolicy	QueryErrorPolicy	쿼리 일괄 처리 요청에서 오류 정책을 제어하는 플래그입니다. 가능한 옵션은 { Fail, Omit }입니다.
ids	string[]	요청된 쿼리 ID

응답

Name	형식	Description
200 OK	QueryHierarchyItem[]	성공한 작업

보안

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

예제

Gets a list of queries by ids

Sample Request

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"
  ]
}

Sample Response

Status code:: 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"
    }
  ]
}

정의

Name	Description
IdentityReference	ID에 대한 참조를 설명합니다.
LinkQueryMode	링크 쿼리 모드입니다.
LogicalOperation	조건 절을 분리하는 논리 연산자
QueryBatchGetRequest	쿼리 목록을 가져오는 요청에 대해 설명합니다.
QueryErrorPolicy	쿼리 일괄 처리 요청에서 오류 정책을 제어하는 플래그입니다. 가능한 옵션은 { Fail, Omit }입니다.
QueryExpand	쿼리에 대한 확장 매개 변수입니다. 가능한 옵션은 { None, Wiql, Clauses, All, Minimal }입니다.
QueryHierarchyItem	작업 항목 쿼리 계층의 항목을 나타냅니다. 쿼리 또는 폴더일 수 있습니다.
QueryRecursionOption	트리 쿼리에 사용할 재귀 옵션입니다.
QueryType	쿼리 유형입니다.
ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
WorkItemFieldOperation	작업 항목 필드 작업을 설명합니다.
WorkItemFieldReference	작업 항목의 필드에 대한 참조
WorkItemQueryClause	작업 항목 쿼리의 절을 나타냅니다. 작업 항목 쿼리의 구조를 보여줍니다.
WorkItemQuerySortColumn	정렬 열입니다.

IdentityReference

ID에 대한 참조를 설명합니다.

Name	형식	Description
_links	ReferenceLinks	이 필드에는 그래프 제목에 대한 0개 이상의 흥미로운 링크가 포함되어 있습니다. 이러한 링크를 호출하여 이 그래프 제목에 대한 추가 관계 또는 자세한 정보를 얻을 수 있습니다.
descriptor	string	설명자는 시스템이 실행되는 동안 그래프 제목을 참조하는 기본 방법입니다. 이 필드는 계정과 조직 모두에서 동일한 그래프 제목을 고유하게 식별합니다.
directoryAlias	string
displayName	string	그래프 주체의 고유하지 않은 표시 이름입니다. 이 필드를 변경하려면 원본 공급자에서 해당 값을 변경해야 합니다.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
name	string	레거시 역호환 속성입니다. 상수의 WIT 특정 값입니다. 최신 버전을 대상으로 하지 않는 한 클라이언트에서 숨겨지지만 존재합니다.
profileUrl	string
uniqueName	string
url	string	이 URL은 이 그래프 주체의 원본 리소스에 대한 전체 경로입니다.

LinkQueryMode

링크 쿼리 모드입니다.

Name	형식	Description
linksOneHopDoesNotContain	string	링크 및 대상 조건을 충족하는 연결된 작업 항목이 없는 경우에만 원본을 충족하는 작업 항목을 반환합니다.
linksOneHopMayContain	string	대상 조건을 충족하는 연결된 작업 항목이 없더라도 원본 및 링크 조건을 충족하는 작업 항목을 반환합니다.
linksOneHopMustContain	string	원본, 대상 및 링크 조건이 모두 충족되는 작업 항목을 반환합니다.
linksRecursiveDoesNotContain	string
linksRecursiveMayContain	string	기본적으로 원본을 충족하는 작업 항목의 계층 구조인 작업 항목을 반환합니다.
linksRecursiveMustContain	string
workItems	string

LogicalOperation

조건 절을 분리하는 논리 연산자

Name	형식	Description
aND	string
nONE	string
oR	string

QueryBatchGetRequest

쿼리 목록을 가져오는 요청에 대해 설명합니다.

Name	형식	Description
$expand	QueryExpand	쿼리에 대한 확장 매개 변수입니다. 가능한 옵션은 { None, Wiql, Clauses, All, Minimal }입니다.
errorPolicy	QueryErrorPolicy	쿼리 일괄 처리 요청에서 오류 정책을 제어하는 플래그입니다. 가능한 옵션은 { Fail, Omit }입니다.
ids	string[]	요청된 쿼리 ID

QueryErrorPolicy

쿼리 일괄 처리 요청에서 오류 정책을 제어하는 플래그입니다. 가능한 옵션은 { Fail, Omit }입니다.

Name	형식	Description
fail	string
omit	string

QueryExpand

쿼리에 대한 확장 매개 변수입니다. 가능한 옵션은 { None, Wiql, Clauses, All, Minimal }입니다.

Name	형식	Description
all	string	모든 속성을 확장합니다.
clauses	string	열, 링크, ChangeInfo, WIQL 텍스트 및 절을 확장합니다.
minimal	string	최소 속성 및 WIQL 텍스트를 표시합니다.
none	string	열, 링크 및 ChangeInfo를 확장합니다.
wiql	string	열, 링크, ChangeInfo 및 WIQL 텍스트를 확장합니다.

QueryHierarchyItem

작업 항목 쿼리 계층의 항목을 나타냅니다. 쿼리 또는 폴더일 수 있습니다.

Name	형식	Description
_links	ReferenceLinks	관련 REST 리소스에 대한 참조를 연결합니다.
children	QueryHierarchyItem[]	쿼리 폴더 내의 자식 쿼리 항목입니다.
clauses	WorkItemQueryClause	플랫 쿼리에 대한 절입니다.
columns	WorkItemFieldReference[]	쿼리의 열입니다.
createdBy	IdentityReference	쿼리 항목을 만든 ID입니다.
createdDate	string	쿼리 항목을 만든 경우입니다.
filterOptions	LinkQueryMode	링크 쿼리 모드입니다.
hasChildren	boolean	쿼리 폴더인 경우 는 자식이 포함되어 있는지를 나타냅니다.
id	string	쿼리 항목의 ID입니다.
isDeleted	boolean	이 쿼리 항목이 삭제되었는지를 나타냅니다. 삭제된 쿼리 항목에서 false로 설정하면 삭제되지 않습니다. 쿼리 또는 폴더를 삭제하지 않으면 이전에 적용된 권한 변경 내용이 다시 표시되지 않습니다.
isFolder	boolean	쿼리 폴더인지 쿼리인지를 나타냅니다.
isInvalidSyntax	boolean	이 쿼리의 WIQL이 잘못된지 나타냅니다. 이는 잘못된 구문 또는 더 이상 유효한 영역/반복 경로가 없기 때문일 수 있습니다.
isPublic	boolean	이 쿼리 항목이 퍼블릭 또는 프라이빗인지를 나타냅니다.
lastExecutedBy	IdentityReference	쿼리를 마지막으로 실행한 ID입니다.
lastExecutedDate	string	쿼리가 마지막으로 실행된 시기입니다.
lastModifiedBy	IdentityReference	쿼리 항목을 마지막으로 수정한 ID입니다.
lastModifiedDate	string	쿼리 항목이 마지막으로 수정된 경우입니다.
linkClauses	WorkItemQueryClause	링크 쿼리 절입니다.
name	string	쿼리 항목의 이름입니다.
path	string	쿼리 항목의 경로입니다.
queryRecursionOption	QueryRecursionOption	트리 쿼리에 사용할 재귀 옵션입니다.
queryType	QueryType	쿼리 유형입니다.
sortColumns	WorkItemQuerySortColumn[]	쿼리의 정렬 열입니다.
sourceClauses	WorkItemQueryClause	트리 또는 원홉 링크 쿼리의 소스 절입니다.
targetClauses	WorkItemQueryClause	트리 또는 원홉 링크 쿼리의 대상 절입니다.
url	string
wiql	string	쿼리의 WIQL 텍스트

QueryRecursionOption

트리 쿼리에 사용할 재귀 옵션입니다.

Name	형식	Description
childFirst	string	원본 및 링크 조건을 충족하는 작업 항목이 없더라도 대상 조건을 충족하는 작업 항목을 반환합니다.
parentFirst	string	대상 및 링크 조건을 충족하는 연결된 작업 항목이 없더라도 원본을 충족하는 작업 항목을 반환합니다.

QueryType

쿼리 유형입니다.

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

ReferenceLinks

REST 참조 링크의 컬렉션을 나타내는 클래스입니다.

Name	형식	Description
links	object	링크의 읽기 전용 보기입니다. 참조 링크는 읽기 전용이므로 읽기 전용으로만 노출하려고 합니다.

WorkItemFieldOperation

작업 항목 필드 작업을 설명합니다.

Name	형식	Description
name	string	작업의 이름입니다.
referenceName	string	작업의 참조 이름입니다.

WorkItemFieldReference

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

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

WorkItemQueryClause

작업 항목 쿼리의 절을 나타냅니다. 작업 항목 쿼리의 구조를 보여줍니다.

Name	형식	Description
clauses	WorkItemQueryClause[]	현재 절이 논리 연산자인 경우 자식 절
field	WorkItemFieldReference	조건과 연결된 필드
fieldValue	WorkItemFieldReference	필드 간 비교 시 조건의 오른쪽
isFieldValue	boolean	필드 간 비교인지 확인합니다.
logicalOperator	LogicalOperation	조건 절을 분리하는 논리 연산자
operator	WorkItemFieldOperation	필드 연산자
value	string	필드와 값 비교의 경우 조건의 오른쪽

WorkItemQuerySortColumn

정렬 열입니다.

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

다음을 통해 공유