次の方法で共有


Queries - Create

クエリを作成するか、クエリを移動します。

作業項目クエリ言語 (WIQL) 構文の詳細については 、こちらを参照してください

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

URI パラメーター

名前 / 必須 説明
organization
path True

string

Azure DevOps 組織の名前です。

project
path True

string

プロジェクト ID またはプロジェクト名

query
path True

string

クエリを作成する親 ID またはパス。

api-version
query True

string

使う API のバージョン。 このバージョンの API を使用するには、これを '5.0' に設定する必要があります。

要求本文

名前 説明
_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

ツリーまたは 1 ホップ リンク クエリのソース句。

targetClauses

WorkItemQueryClause

ツリーまたは 1 ホップ リンク クエリのターゲット句。

url

string

wiql

string

クエリの WIQL テキスト

応答

名前 説明
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

名前 説明
vso.work_write 作業項目とクエリの読み取り、作成、更新、ボード メタデータの更新、領域の読み取り、反復パスの他の作業項目追跡関連メタデータの実行、クエリの実行、サービス フックを介した作業項目イベントに関する通知の受信を行う機能を付与します。

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

定義

名前 説明
IdentityReference

ID への参照について説明します。

LinkQueryMode

リンク クエリ モード。

LogicalOperation

条件句を分離する論理演算子

QueryHierarchyItem

作業項目クエリ階層内のアイテムを表します。 クエリまたはフォルダーを指定できます。

QueryRecursionOption

ツリー クエリで使用する再帰オプション。

QueryType

クエリの種類。

ReferenceLinks

REST 参照リンクのコレクションを表す クラス。

WorkItemFieldOperation

作業項目フィールド操作について説明します。

WorkItemFieldReference

作業項目内のフィールドへの参照

WorkItemQueryClause

作業項目クエリの句を表します。 作業項目クエリの構造を示します。

WorkItemQuerySortColumn

並べ替え列。

IdentityReference

ID への参照について説明します。

名前 説明
_links

ReferenceLinks

このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。 これらのリンクを呼び出して、このグラフの主題に関する追加のリレーションシップや詳細情報を取得できます。

descriptor

string

記述子は、システムの実行中にグラフの件名を参照する主な方法です。 このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。

directoryAlias

string

displayName

string

これは、グラフの件名の一意でない表示名です。 このフィールドを変更するには、ソース プロバイダーでその値を変更する必要があります。

id

string

imageUrl

string

inactive

boolean

isAadIdentity

boolean

isContainer

boolean

isDeletedInOrigin

boolean

name

string

従来の back-compat プロパティ。 これは定数の WIT 固有の値です。 最新バージョンを対象としている場合を除き、クライアントでは非表示になります (ただし存在します)。

profileUrl

string

uniqueName

string

url

string

この URL は、このグラフの件名のソース リソースへの完全なルートです。

LinkQueryMode

リンク クエリ モード。

名前 説明
linksOneHopDoesNotContain

string

リンクとターゲットの条件を満たすリンクされた作業項目がない場合にのみ、ソースを満たす作業項目を返します。

linksOneHopMayContain

string

リンクされた作業項目がターゲット条件を満たしていない場合でも、ソースとリンクの条件を満たす作業項目を返します。

linksOneHopMustContain

string

ソース、ターゲット、リンクの条件がすべて満たされている作業項目を返します。

linksRecursiveDoesNotContain

string

linksRecursiveMayContain

string

既定でソースを満たす作業項目の階層を返します。

linksRecursiveMustContain

string

workItems

string

LogicalOperation

条件句を分離する論理演算子

名前 説明
aND

string

nONE

string

oR

string

QueryHierarchyItem

作業項目クエリ階層内のアイテムを表します。 クエリまたはフォルダーを指定できます。

名前 説明
_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

ツリーまたは 1 ホップ リンク クエリのソース句。

targetClauses

WorkItemQueryClause

ツリーまたは 1 ホップ リンク クエリのターゲット句。

url

string

wiql

string

クエリの WIQL テキスト

QueryRecursionOption

ツリー クエリで使用する再帰オプション。

名前 説明
childFirst

string

ソースとリンクの条件を満たす作業項目がない場合でも、対象の条件を満たす作業項目を返します。

parentFirst

string

リンクされた作業項目がターゲットとリンクの条件を満たしていない場合でも、ソースを満たす作業項目を返します。

QueryType

クエリの種類。

名前 説明
flat

string

作業項目のフラット な一覧を取得します。

oneHop

string

作業項目とその直接リンクの一覧を取得します。

tree

string

リンク階層を示す作業項目のツリーを取得します。

REST 参照リンクのコレクションを表す クラス。

名前 説明
links

object

リンクの読み取り時ビュー。 参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。

WorkItemFieldOperation

作業項目フィールド操作について説明します。

名前 説明
name

string

操作の名前。

referenceName

string

操作の参照名。

WorkItemFieldReference

作業項目内のフィールドへの参照

名前 説明
name

string

フィールドの名前。

referenceName

string

フィールドの参照名。

url

string

リソースの REST URL。

WorkItemQueryClause

作業項目クエリの句を表します。 作業項目クエリの構造を示します。

名前 説明
clauses

WorkItemQueryClause[]

現在の句が論理演算子の場合は、子句

field

WorkItemFieldReference

条件に関連付けられているフィールド

fieldValue

WorkItemFieldReference

フィールドとフィールドの比較時の条件の右側

isFieldValue

boolean

これがフィールド間の比較フィールドであるかどうかを判断します

logicalOperator

LogicalOperation

条件句を分離する論理演算子

operator

WorkItemFieldOperation

フィールド演算子

value

string

フィールドと値の比較時の条件の右側

WorkItemQuerySortColumn

並べ替え列。

名前 説明
descending

boolean

並べ替えの基準となる方向。

field

WorkItemFieldReference

作業項目フィールド。