次の方法で共有


Queries - Search Queries

現在のプロジェクトでユーザーがアクセスできるすべてのクエリを検索します

GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries?$filter={$filter}&api-version=5.0
GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries?$filter={$filter}&$top={$top}&$expand={$expand}&$includeDeleted={$includeDeleted}&api-version=5.0

URI パラメーター

名前 / 必須 説明
organization
path True

string

Azure DevOps 組織の名前です。

project
path True

string

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

$filter
query True

string

クエリをフィルター処理するテキスト。

api-version
query True

string

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

$expand
query

QueryExpand

$includeDeleted
query

boolean

削除されたクエリとフォルダーを含める

$top
query

integer

int32

返すクエリの数 (既定値は 50、最大値は 200)。

応答

名前 説明
200 OK

QueryHierarchyItemsResult

成功した操作

セキュリティ

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 作業項目、クエリ、ボード、領域とイテレーションのパス、およびその他の作業項目追跡関連のメタデータを読み取る機能を付与します。 また、クエリを実行したり、作業項目を検索したり、サービス フックを介して作業項目イベントに関する通知を受信したりすることもできます。

定義

名前 説明
IdentityReference

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

LinkQueryMode

リンク クエリ モード。

LogicalOperation

条件句を区切る論理演算子

QueryExpand

クエリの展開パラメーター。 使用可能なオプションは{ なし、Wiql、句、すべて、最小 } です。

QueryHierarchyItem

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

QueryHierarchyItemsResult
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

QueryExpand

クエリの展開パラメーター。 使用可能なオプションは{ なし、Wiql、句、すべて、最小 } です。

名前 説明
all

string

すべてのプロパティを展開します

clauses

string

列、リンク、ChangeInfo、WIQL テキスト、句を展開します

minimal

string

最小限のプロパティと WIQL テキストを表示します

none

string

列、リンク、および ChangeInfo を展開します

wiql

string

列、リンク、ChangeInfo、WIQL テキストを展開します

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

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

targetClauses

WorkItemQueryClause

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

url

string

wiql

string

クエリの WIQL テキスト

QueryHierarchyItemsResult

名前 説明
count

integer

アイテムの数。

hasMore

boolean

最大戻り値の上限に達したが、さらに多くの項目が存在するかどうかを示します

value

QueryHierarchyItem[]

項目の一覧

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

作業項目フィールド。