WorkItemTrackingRestClient class
VSS REST API への要求を行うために使用する (派生する) 基本クラス
- Extends
プロパティ
| RESOURCE_AREA_ID |
メソッド
コンストラクターの詳細
WorkItemTrackingRestClient(IVssRestClientOptions)
プロパティの詳細
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string
プロパティ値
string
メソッドの詳細
createAttachment(any, string, string, string, string)
添付ファイルをアップロードします。
function createAttachment(content: any, project?: string, fileName?: string, uploadType?: string, areaPath?: string): Promise<AttachmentReference>
パラメーター
- content
-
any
アップロードするコンテンツ
- project
-
string
プロジェクト ID またはプロジェクト名
- fileName
-
string
ファイルの名前
- uploadType
-
string
添付ファイルのアップロードタイプ: シンプルまたはチャンク
- areaPath
-
string
ターゲット・プロジェクト・エリア・パス
戻り値
Promise<AttachmentReference>
createField(WorkItemField, string)
新しいフィールドを作成します。
function createField(workItemField: WorkItemField, project?: string): Promise<WorkItemField>
パラメーター
- workItemField
- WorkItemField
新しいフィールド定義
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<WorkItemField>
createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)
新しい分類ノードを作成するか、既存の分類ノードを更新します。
function createOrUpdateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>
パラメーター
- postedNode
- WorkItemClassificationNode
作成または更新するノード。
- project
-
string
プロジェクト ID またはプロジェクト名
- structureGroup
- TreeStructureGroup
分類ノード、エリア、または反復の構造グループ。
- path
-
string
分類ノードのパス。
戻り値
Promise<WorkItemClassificationNode>
createQuery(QueryHierarchyItem, string, string, boolean)
クエリを作成するか、クエリを移動します。
function createQuery(postedQuery: QueryHierarchyItem, project: string, query: string, validateWiqlOnly?: boolean): Promise<QueryHierarchyItem>
パラメーター
- postedQuery
- QueryHierarchyItem
作成するクエリ。
- project
-
string
プロジェクト ID またはプロジェクト名
- query
-
string
クエリを作成する親 ID またはパス。
- validateWiqlOnly
-
boolean
実際に作成せずに WIQL クエリを検証するだけの場合は、true に設定します。 既定値は false です。
戻り値
Promise<QueryHierarchyItem>
createTemplate(WorkItemTemplate, string, string)
テンプレートを作成します
function createTemplate(template: WorkItemTemplate, project: string, team: string): Promise<WorkItemTemplate>
パラメーター
- template
- WorkItemTemplate
テンプレートの内容
- project
-
string
プロジェクト ID またはプロジェクト名
- team
-
string
チーム ID またはチーム名
戻り値
Promise<WorkItemTemplate>
createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)
1 つの作業項目を作成します。
function createWorkItem(document: JsonPatchDocument, project: string, type: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemExpand): Promise<WorkItem>
パラメーター
- document
- JsonPatchDocument
作業項目を表す JSON パッチ ドキュメント
- project
-
string
プロジェクト ID またはプロジェクト名
- type
-
string
作成する作業項目の作業項目の種類
- validateOnly
-
boolean
作業項目を保存せずに変更のみを検証するかどうかを示します
- bypassRules
-
boolean
この更新プログラムに作業項目の種類の規則を適用しないでください
- suppressNotifications
-
boolean
この変更の通知を発生させないでください
- expand
- WorkItemExpand
作業項目属性の展開パラメーター。 可能なオプションは、{ None、Relations、Fields、Links、All } です。
戻り値
Promise<WorkItem>
deleteClassificationNode(string, TreeStructureGroup, string, number)
既存の分類ノードを削除します。
function deleteClassificationNode(project: string, structureGroup: TreeStructureGroup, path?: string, reclassifyId?: number): Promise<void>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- structureGroup
- TreeStructureGroup
分類ノード、エリア、または反復の構造グループ。
- path
-
string
分類ノードのパス。
- reclassifyId
-
number
再分類のターゲット分類ノードの ID。
戻り値
Promise<void>
deleteField(string, string)
フィールドを削除します。 フィールドの削除を取り消すには、「フィールドの更新」API を参照してください。
function deleteField(fieldNameOrRefName: string, project?: string): Promise<void>
パラメーター
- fieldNameOrRefName
-
string
フィールド単純名または参照名
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<void>
deleteQuery(string, string)
クエリまたはフォルダーを削除します。 これにより、削除されたクエリまたはフォルダ、およびその子孫 (フォルダの場合) に対するアクセス許可の変更が削除されます。 削除された権限の変更は、クエリまたはフォルダーの削除を取り消しても復元できないことに注意することが重要です。
function deleteQuery(project: string, query: string): Promise<void>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- query
-
string
削除するクエリまたはフォルダーの ID またはパス。
戻り値
Promise<void>
deleteTemplate(string, string, string)
指定されたIDのテンプレートを削除します
function deleteTemplate(project: string, team: string, templateId: string): Promise<void>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- team
-
string
チーム ID またはチーム名
- templateId
-
string
テンプレート ID
戻り値
Promise<void>
deleteWorkItem(number, string, boolean)
指定した作業項目を削除してごみ箱に送信し、必要に応じて復元できるようにします。 必要に応じて、destroy パラメーターが true に設定されている場合、作業項目は永続的に破棄されます。 警告: destroy パラメーターが true に設定されている場合、このコマンドによって削除された作業項目はごみ箱に行かず、削除後に復元/回復する方法はありません。 このパラメーターは使用しないことをお勧めします。 その場合は、このパラメータを細心の注意を払って使用してください。
function deleteWorkItem(id: number, project?: string, destroy?: boolean): Promise<WorkItemDelete>
パラメーター
- id
-
number
削除する作業項目の ID
- project
-
string
プロジェクト ID またはプロジェクト名
- destroy
-
boolean
オプションのパラメーター (true に設定すると、作業項目は完全に削除されます)。 注意:破壊アクションは永続的であり、元に戻すことはできません。
戻り値
Promise<WorkItemDelete>
destroyWorkItem(number, string)
指定した作業項目をごみ箱から完全に破棄します。 このアクションは元に戻すことはできません。
function destroyWorkItem(id: number, project?: string): Promise<void>
パラメーター
- id
-
number
完全に破棄される作業項目の ID
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<void>
exportWorkItemTypeDefinition(string, string, boolean)
作業項目の種類のエクスポート
function exportWorkItemTypeDefinition(project?: string, type?: string, exportGlobalLists?: boolean): Promise<WorkItemTypeTemplate>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- type
-
string
- exportGlobalLists
-
boolean
戻り値
Promise<WorkItemTypeTemplate>
getAccountMyWorkData(QueryOption)
内部のみ: アカウントのマイワークページで使用されます。 これにより、実行中、完了、フォロー、およびアクティビティ作業項目の詳細が返されます。
function getAccountMyWorkData(queryOption?: QueryOption): Promise<AccountMyWorkResult>
パラメーター
- queryOption
- QueryOption
戻り値
Promise<AccountMyWorkResult>
getAttachmentContent(string, string, string, boolean)
添付ファイルをダウンロードします。
function getAttachmentContent(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>
パラメーター
- id
-
string
添付ファイル ID
- project
-
string
プロジェクト ID またはプロジェクト名
- fileName
-
string
ファイルの名前
- download
-
boolean
<c>true</c>に設定されている場合は、常に添付ファイルをダウンロードします
戻り値
Promise<ArrayBuffer>
getAttachmentZip(string, string, string, boolean)
添付ファイルをダウンロードします。
function getAttachmentZip(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>
パラメーター
- id
-
string
添付ファイル ID
- project
-
string
プロジェクト ID またはプロジェクト名
- fileName
-
string
ファイルの名前
- download
-
boolean
<c>true</c>に設定されている場合は、常に添付ファイルをダウンロードします
戻り値
Promise<ArrayBuffer>
getClassificationNode(string, TreeStructureGroup, string, number)
特定のノード パスの分類ノードを取得します。
function getClassificationNode(project: string, structureGroup: TreeStructureGroup, path?: string, depth?: number): Promise<WorkItemClassificationNode>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- structureGroup
- TreeStructureGroup
分類ノード、エリア、または反復の構造グループ。
- path
-
string
分類ノードのパス。
- depth
-
number
取得する子の深さ。
戻り値
Promise<WorkItemClassificationNode>
getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)
特定のプロジェクトのノード ID の特定のリストのルート分類ノードまたは分類ノードのリストを取得します。 ids パラメーターを指定すると、それらの id の分類ノードのリストが表示されます。 それ以外の場合は、このプロジェクトのルート分類ノードを取得します。
function getClassificationNodes(project: string, ids: number[], depth?: number, errorPolicy?: ClassificationNodesErrorPolicy): Promise<WorkItemClassificationNode[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- ids
-
number[]
コンマ区切りの整数分類ノード ids。 ルートノードが必要な場合は、必須ではありません。
- depth
-
number
取得する子の深さ。
- errorPolicy
- ClassificationNodesErrorPolicy
いくつかのノードを取得する際のエラーを処理するフラグ。 可能なオプションは、Fail と Omit です。
戻り値
Promise<WorkItemClassificationNode[]>
getComment(number, number, string)
指定したリビジョンの作業項目のコメントを取得します。
function getComment(id: number, revision: number, project?: string): Promise<WorkItemComment>
パラメーター
- id
-
number
作業項目 ID
- revision
-
number
コメントを取得する必要があるリビジョン
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<WorkItemComment>
getComments(number, string, number, number, CommentSortOrder)
指定したリビジョンから作業項目の指定した数のコメントを取得します。
function getComments(id: number, project?: string, fromRevision?: number, top?: number, order?: CommentSortOrder): Promise<WorkItemComments>
パラメーター
- id
-
number
作業項目 ID
- project
-
string
プロジェクト ID またはプロジェクト名
- fromRevision
-
number
コメントの取得元となるリビジョン (デフォルトは 1)
- top
-
number
返すコメントの数 (デフォルトは 200)
- order
- CommentSortOrder
リビジョン ID による昇順または降順 (デフォルトは昇順)
戻り値
Promise<WorkItemComments>
getDeletedWorkItem(number, string)
ごみ箱から削除された作業項目を取得します。
function getDeletedWorkItem(id: number, project?: string): Promise<WorkItemDelete>
パラメーター
- id
-
number
返される作業項目の ID
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<WorkItemDelete>
getDeletedWorkItems(number[], string)
パラメーターで ID が指定されているごみ箱から作業項目を取得します。
function getDeletedWorkItems(ids: number[], project?: string): Promise<WorkItemDeleteReference[]>
パラメーター
- ids
-
number[]
返される削除された作業項目の ID のコンマ区切りリスト
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<WorkItemDeleteReference[]>
getDeletedWorkItemShallowReferences(string)
ごみ箱で削除された作業項目の ID と URL の一覧を取得します。
function getDeletedWorkItemShallowReferences(project?: string): Promise<WorkItemDeleteShallowReference[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<WorkItemDeleteShallowReference[]>
getField(string, string)
特定のフィールドに関する情報を取得します。
function getField(fieldNameOrRefName: string, project?: string): Promise<WorkItemField>
パラメーター
- fieldNameOrRefName
-
string
フィールド単純名または参照名
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<WorkItemField>
getFields(string, GetFieldsExpand)
すべてのフィールドの情報を返します。 プロジェクト ID/名前パラメーターは省略可能です。
function getFields(project?: string, expand?: GetFieldsExpand): Promise<WorkItemField[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- expand
- GetFieldsExpand
ExtensionFields を使用して拡張フィールドを含め、それ以外の場合は除外します。 このパラメーターの機能フラグが有効になっていない限り、拡張フィールドは常に含まれます。
戻り値
Promise<WorkItemField[]>
getQueries(string, QueryExpand, number, boolean)
ルートクエリとその子を取得します
function getQueries(project: string, expand?: QueryExpand, depth?: number, includeDeleted?: boolean): Promise<QueryHierarchyItem[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- expand
- QueryExpand
クエリ文字列 (wiql)、句、クエリ結果列、並べ替えオプションを結果に含めます。
- depth
-
number
クエリのフォルダーで、子クエリとフォルダーをこの深さまで返します。
- includeDeleted
-
boolean
削除されたクエリとフォルダーを含める
戻り値
Promise<QueryHierarchyItem[]>
getQueriesBatch(QueryBatchGetRequest, string)
idsによるクエリのリストを取得します(最大1000)
function getQueriesBatch(queryGetRequest: QueryBatchGetRequest, project: string): Promise<QueryHierarchyItem[]>
パラメーター
- queryGetRequest
- QueryBatchGetRequest
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<QueryHierarchyItem[]>
getQuery(string, string, QueryExpand, number, boolean, boolean)
個々のクエリとその子を取得します
function getQuery(project: string, query: string, expand?: QueryExpand, depth?: number, includeDeleted?: boolean, useIsoDateFormat?: boolean): Promise<QueryHierarchyItem>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- query
-
string
クエリの ID またはパス。
- expand
- QueryExpand
クエリ文字列 (wiql)、句、クエリ結果列、並べ替えオプションを結果に含めます。
- depth
-
number
クエリのフォルダーで、子クエリとフォルダーをこの深さまで返します。
- includeDeleted
-
boolean
削除されたクエリとフォルダーを含める
- useIsoDateFormat
-
boolean
DateTime クエリ句は、ISO 8601 準拠の形式を使用して書式設定されます
戻り値
Promise<QueryHierarchyItem>
getQueryResultCount(string, string, string, boolean, number)
クエリ ID を指定したクエリの結果を取得します。
function getQueryResultCount(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<number>
パラメーター
- id
-
string
クエリ ID。
- project
-
string
プロジェクト ID またはプロジェクト名
- team
-
string
チーム ID またはチーム名
- timePrecision
-
boolean
時間精度を使用するかどうか。
- top
-
number
返される結果の最大数。
戻り値
Promise<number>
getRecentActivityData()
最近の作業項目アクティビティを取得します
function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>
戻り値
Promise<AccountRecentActivityWorkItemModel2[]>
getRecentMentions()
内部のみ: アカウントのマイワークページで使用されます。
function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>
戻り値
Promise<AccountRecentMentionWorkItemModel[]>
getRelationType(string)
作業項目のリレーションシップの種類定義を取得します。
function getRelationType(relation: string): Promise<WorkItemRelationType>
パラメーター
- relation
-
string
リレーション名
戻り値
Promise<WorkItemRelationType>
getRelationTypes()
作業項目のリレーションの種類を取得します。
function getRelationTypes(): Promise<WorkItemRelationType[]>
戻り値
Promise<WorkItemRelationType[]>
getReportingLinksByLinkType(string, string[], string[], string, Date)
作業項目リンクのバッチを取得する
function getReportingLinksByLinkType(project?: string, linkTypes?: string[], types?: string[], continuationToken?: string, startDateTime?: Date): Promise<ReportingWorkItemLinksBatch>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- linkTypes
-
string[]
結果を特定のリンクタイプにフィルタリングするタイプのリスト。 このパラメーターを省略して、すべてのリンクの種類の作業項目リンクを取得します。
- types
-
string[]
結果を特定の作業項目の種類にフィルター処理する型の一覧。 このパラメーターを省略すると、すべての作業項目の種類の作業項目リンクが取得されます。
- continuationToken
-
string
バッチを開始するcontinuationTokenを指定します。 リンクの最初のバッチを取得するには、このパラメーターを省略します。
- startDateTime
-
Date
リンク変更の開始点として使用する日付/時刻。 その日付/時刻以降に発生したリンクの変更のみが返されます。 「watermark」パラメータと組み合わせて使用することはできません。
戻り値
Promise<ReportingWorkItemLinksBatch>
getRevision(number, number, string, WorkItemExpand)
要求されたリビジョンの完全にハイドレートされた作業項目を返します
function getRevision(id: number, revisionNumber: number, project?: string, expand?: WorkItemExpand): Promise<WorkItem>
パラメーター
- id
-
number
- revisionNumber
-
number
- project
-
string
プロジェクト ID またはプロジェクト名
- expand
- WorkItemExpand
戻り値
Promise<WorkItem>
getRevisions(number, string, number, number, WorkItemExpand)
完全にハイドレートされた作業項目リビジョンの一覧をページ分けして返します。
function getRevisions(id: number, project?: string, top?: number, skip?: number, expand?: WorkItemExpand): Promise<WorkItem[]>
パラメーター
- id
-
number
- project
-
string
プロジェクト ID またはプロジェクト名
- top
-
number
- skip
-
number
- expand
- WorkItemExpand
戻り値
Promise<WorkItem[]>
getRootNodes(string, number)
プロジェクトの下のルート分類ノードを取得します。
function getRootNodes(project: string, depth?: number): Promise<WorkItemClassificationNode[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- depth
-
number
取得する子の深さ。
戻り値
Promise<WorkItemClassificationNode[]>
getTemplate(string, string, string)
指定された ID のテンプレートを取得します
function getTemplate(project: string, team: string, templateId: string): Promise<WorkItemTemplate>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- team
-
string
チーム ID またはチーム名
- templateId
-
string
テンプレート ID
戻り値
Promise<WorkItemTemplate>
getTemplates(string, string, string)
テンプレートを取得する
function getTemplates(project: string, team: string, workitemtypename?: string): Promise<WorkItemTemplateReference[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- team
-
string
チーム ID またはチーム名
- workitemtypename
-
string
オプションで、指定すると、特定の作業項目の種類のテンプレートが返されます。
戻り値
Promise<WorkItemTemplateReference[]>
getUpdate(number, number, string)
作業項目の 1 つの更新を返します
function getUpdate(id: number, updateNumber: number, project?: string): Promise<WorkItemUpdate>
パラメーター
- id
-
number
- updateNumber
-
number
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<WorkItemUpdate>
getUpdates(number, string, number, number)
作業項目のリビジョン間の差分を返します
function getUpdates(id: number, project?: string, top?: number, skip?: number): Promise<WorkItemUpdate[]>
パラメーター
- id
-
number
- project
-
string
プロジェクト ID またはプロジェクト名
- top
-
number
- skip
-
number
戻り値
Promise<WorkItemUpdate[]>
getWorkArtifactLinkTypes()
作業項目追跡送信成果物リンクの種類の一覧を取得します。
function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>
戻り値
Promise<WorkArtifactLink[]>
getWorkItem(number, string, string[], Date, WorkItemExpand)
1 つの作業項目を返します。
function getWorkItem(id: number, project?: string, fields?: string[], asOf?: Date, expand?: WorkItemExpand): Promise<WorkItem>
パラメーター
- id
-
number
作業項目 ID
- project
-
string
プロジェクト ID またはプロジェクト名
- fields
-
string[]
要求されたフィールドのコンマ区切りリスト
- asOf
-
Date
AsOf UTC 日付時刻文字列
- expand
- WorkItemExpand
作業項目属性の展開パラメーター。 可能なオプションは、{ None、Relations、Fields、Links、All } です。
戻り値
Promise<WorkItem>
getWorkItemIconJson(string, string, number)
フレンドリ名とアイコンの色を指定した作業項目アイコンを取得します。
function getWorkItemIconJson(icon: string, color?: string, v?: number): Promise<WorkItemIcon>
パラメーター
- icon
-
string
アイコンの名前
- color
-
string
アイコンの 6 桁の 16 進数の色
- v
-
number
アイコンのバージョン (キャッシュの無効化にのみ使用)
戻り値
Promise<WorkItemIcon>
getWorkItemIcons()
すべての作業項目アイコンの一覧を取得します。
function getWorkItemIcons(): Promise<WorkItemIcon[]>
戻り値
Promise<WorkItemIcon[]>
getWorkItemIconSvg(string, string, number)
フレンドリ名とアイコンの色を指定した作業項目アイコンを取得します。
function getWorkItemIconSvg(icon: string, color?: string, v?: number): Promise<any>
パラメーター
- icon
-
string
アイコンの名前
- color
-
string
アイコンの 6 桁の 16 進数の色
- v
-
number
アイコンのバージョン (キャッシュの無効化にのみ使用)
戻り値
Promise<any>
getWorkItemIconXaml(string, string, number)
フレンドリ名とアイコンの色を指定した作業項目アイコンを取得します。
function getWorkItemIconXaml(icon: string, color?: string, v?: number): Promise<any>
パラメーター
- icon
-
string
アイコンの名前
- color
-
string
アイコンの 6 桁の 16 進数の色
- v
-
number
アイコンのバージョン (キャッシュの無効化にのみ使用)
戻り値
Promise<any>
getWorkItemNextStatesOnCheckinAction(number[], string)
指定された作業項目 ID の次の状態を返します。
function getWorkItemNextStatesOnCheckinAction(ids: number[], action?: string): Promise<WorkItemNextStateOnTransition[]>
パラメーター
- ids
-
number[]
作業項目 ID の一覧
- action
-
string
可能なアクション。 現在、チェックインのみをサポートしています
戻り値
Promise<WorkItemNextStateOnTransition[]>
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)
作業項目の一覧を返します (最大 200)
function getWorkItems(ids: number[], project?: string, fields?: string[], asOf?: Date, expand?: WorkItemExpand, errorPolicy?: WorkItemErrorPolicy): Promise<WorkItem[]>
パラメーター
- ids
-
number[]
要求された作業項目 ID のコンマ区切りリスト。 (最大 200 個の ID が許可されます)。
- project
-
string
プロジェクト ID またはプロジェクト名
- fields
-
string[]
要求されたフィールドのコンマ区切りリスト
- asOf
-
Date
AsOf UTC 日付時刻文字列
- expand
- WorkItemExpand
作業項目属性の展開パラメーター。 可能なオプションは、{ None、Relations、Fields、Links、All } です。
- errorPolicy
- WorkItemErrorPolicy
作業項目の一括取得要求のエラー ポリシーを制御するフラグ。 可能なオプションは {Fail, Omit} です。
戻り値
Promise<WorkItem[]>
getWorkItemsBatch(WorkItemBatchGetRequest, string)
作業項目 ID の一覧の作業項目を取得します (最大 200)
function getWorkItemsBatch(workItemGetRequest: WorkItemBatchGetRequest, project?: string): Promise<WorkItem[]>
パラメーター
- workItemGetRequest
- WorkItemBatchGetRequest
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<WorkItem[]>
getWorkItemStateColors(string[])
内部のみ: マイアカウントの仕事の経験に使用されます。 複数のプロジェクトの作業項目の種類の状態色を取得する
function getWorkItemStateColors(projectNames: string[]): Promise<ProjectWorkItemStateColors[]>
パラメーター
- projectNames
-
string[]
戻り値
Promise<ProjectWorkItemStateColors[]>
getWorkItemTemplate(string, string, string, Date, WorkItemExpand)
テンプレートから 1 つの作業項目を返します。
function getWorkItemTemplate(project: string, type: string, fields?: string, asOf?: Date, expand?: WorkItemExpand): Promise<WorkItem>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- type
-
string
作業項目の種類名
- fields
-
string
要求されたフィールドのコンマ区切りリスト
- asOf
-
Date
AsOf UTC 日付時刻文字列
- expand
- WorkItemExpand
作業項目属性の展開パラメーター。 可能なオプションは、{ None、Relations、Fields、Links、All } です。
戻り値
Promise<WorkItem>
getWorkItemType(string, string)
作業項目の種類定義を返します。
function getWorkItemType(project: string, type: string): Promise<WorkItemType>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- type
-
string
作業項目の種類名
戻り値
Promise<WorkItemType>
getWorkItemTypeCategories(string)
すべての作業項目の種類カテゴリを取得します。
function getWorkItemTypeCategories(project: string): Promise<WorkItemTypeCategory[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<WorkItemTypeCategory[]>
getWorkItemTypeCategory(string, string)
特定の作業項目の種類カテゴリを名前で取得します。
function getWorkItemTypeCategory(project: string, category: string): Promise<WorkItemTypeCategory>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- category
-
string
カテゴリ名
戻り値
Promise<WorkItemTypeCategory>
getWorkItemTypeColorAndIcons(string[])
内部のみ: 色とアイコンのプロバイダーに使用されます。 複数のプロジェクトのウィットタイプの色を取得する
function getWorkItemTypeColorAndIcons(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>
パラメーター
- projectNames
-
string[]
戻り値
Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>
getWorkItemTypeColors(string[])
内部のみ: マイアカウントの仕事の経験に使用されます。 複数のプロジェクトのウィットタイプの色を取得する
function getWorkItemTypeColors(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColor[] }[]>
パラメーター
- projectNames
-
string[]
戻り値
Promise<{ key: string, value: WorkItemTypeColor[] }[]>
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)
詳細な参照を含む作業項目の種類のフィールドの一覧を取得します。
function getWorkItemTypeFieldsWithReferences(project: string, type: string, expand?: WorkItemTypeFieldsExpandLevel): Promise<WorkItemTypeFieldWithReferences[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- type
-
string
作業項目の種類。
API 応答の [レベル] を展開します。 プロパティ:応答の一部としてallowedvalues、defaultvalue、isRequiredなどを含めます。None: これらのプロパティをスキップします。
戻り値
Promise<WorkItemTypeFieldWithReferences[]>
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)
詳細な参照を含む作業項目の種類のフィールドを取得します。
function getWorkItemTypeFieldWithReferences(project: string, type: string, field: string, expand?: WorkItemTypeFieldsExpandLevel): Promise<WorkItemTypeFieldWithReferences>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- type
-
string
作業項目の種類。
- field
-
string
API 応答の [レベル] を展開します。 プロパティ:応答の一部としてallowedvalues、defaultvalue、isRequiredなどを含めます。None: これらのプロパティをスキップします。
戻り値
Promise<WorkItemTypeFieldWithReferences>
getWorkItemTypes(string)
作業項目の種類の一覧を返します
function getWorkItemTypes(project: string): Promise<WorkItemType[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<WorkItemType[]>
getWorkItemTypeStates(string, string)
作業項目の種類の状態名と色を返します。
function getWorkItemTypeStates(project: string, type: string): Promise<WorkItemStateColor[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- type
-
string
州名
戻り値
Promise<WorkItemStateColor[]>
queryById(string, string, string, boolean, number)
クエリ ID を指定したクエリの結果を取得します。
function queryById(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemQueryResult>
パラメーター
- id
-
string
クエリ ID。
- project
-
string
プロジェクト ID またはプロジェクト名
- team
-
string
チーム ID またはチーム名
- timePrecision
-
boolean
時間精度を使用するかどうか。
- top
-
number
返される結果の最大数。
戻り値
Promise<WorkItemQueryResult>
queryByWiql(Wiql, string, string, boolean, number)
WIQL が指定されたクエリの結果を取得します。
function queryByWiql(wiql: Wiql, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemQueryResult>
パラメーター
- wiql
- Wiql
WIQL を含むクエリ。
- project
-
string
プロジェクト ID またはプロジェクト名
- team
-
string
チーム ID またはチーム名
- timePrecision
-
boolean
時間精度を使用するかどうか。
- top
-
number
返される結果の最大数。
戻り値
Promise<WorkItemQueryResult>
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)
成果物 URI の特定のリストにリンクされた作業項目を照会します。
function queryWorkItemsForArtifactUris(artifactUriQuery: ArtifactUriQuery, project?: string): Promise<ArtifactUriQueryResult>
パラメーター
- artifactUriQuery
- ArtifactUriQuery
作業項目を照会するための成果物 URI の一覧を定義します。
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<ArtifactUriQueryResult>
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)
削除されたアイテムを含めるオプションを使用して、作業項目リビジョンのバッチを取得する
function readReportingRevisionsGet(project?: string, fields?: string[], types?: string[], continuationToken?: string, startDateTime?: Date, includeIdentityRef?: boolean, includeDeleted?: boolean, includeTagRef?: boolean, includeLatestOnly?: boolean, expand?: ReportingRevisionsExpand, includeDiscussionChangesOnly?: boolean, maxPageSize?: number): Promise<ReportingWorkItemRevisionsBatch>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- fields
-
string[]
作業項目のリビジョンで返されるフィールドの一覧。 このパラメーターを省略すると、レポート可能なすべてのフィールドが取得されます。
- types
-
string[]
結果を特定の作業項目の種類にフィルター処理する型の一覧。 このパラメーターを省略して、すべての作業項目の種類の作業項目リビジョンを取得します。
- continuationToken
-
string
バッチを開始するウォーターマークを指定します。 このパラメータを省略すると、リビジョンの最初のバッチが取得されます。
- startDateTime
-
Date
改訂の開始点として使用する日付/時刻、すべての改訂はこの日付/時刻より後に行われます。 「watermark」パラメータと組み合わせて使用することはできません。
- includeIdentityRef
-
boolean
ID フィールドの文字列値の代わりに ID 参照を返します。
- includeDeleted
-
boolean
削除したアイテムを返すかどうかを指定します。
- includeTagRef
-
boolean
System.Tags フィールドにタグ オブジェクトを返すかどうかを指定します。
- includeLatestOnly
-
boolean
作業項目の最新のリビジョンのみを返し、すべての履歴リビジョンをスキップします
- expand
- ReportingRevisionsExpand
既定では返されない長いテキスト フィールドを含む、作業項目リビジョンのすべてのフィールドを返します
- includeDiscussionChangesOnly
-
boolean
履歴フィールドのみが変更された作業項目のリビジョンのみを返します
- maxPageSize
-
number
このバッチで返される結果の最大数
戻り値
Promise<ReportingWorkItemRevisionsBatch>
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)
作業項目のリビジョンのバッチを取得します。 このリクエストは、フィールドのリストが十分に大きく、長さの制限を超えて URL を実行する可能性がある場合に使用できます。
function readReportingRevisionsPost(filter: ReportingWorkItemRevisionsFilter, project?: string, continuationToken?: string, startDateTime?: Date, expand?: ReportingRevisionsExpand): Promise<ReportingWorkItemRevisionsBatch>
パラメーター
要求設定を含むオブジェクト (フィールド フィルター、タイプ フィルター、ID 形式)
- project
-
string
プロジェクト ID またはプロジェクト名
- continuationToken
-
string
バッチを開始するウォーターマークを指定します。 このパラメータを省略すると、リビジョンの最初のバッチが取得されます。
- startDateTime
-
Date
改訂の開始点として使用する日付/時刻、すべての改訂はこの日付/時刻より後に行われます。 「watermark」パラメータと組み合わせて使用することはできません。
- expand
- ReportingRevisionsExpand
戻り値
Promise<ReportingWorkItemRevisionsBatch>
replaceTemplate(WorkItemTemplate, string, string, string)
テンプレートの内容を置き換える
function replaceTemplate(templateContent: WorkItemTemplate, project: string, team: string, templateId: string): Promise<WorkItemTemplate>
パラメーター
- templateContent
- WorkItemTemplate
置換するテンプレートの内容
- project
-
string
プロジェクト ID またはプロジェクト名
- team
-
string
チーム ID またはチーム名
- templateId
-
string
テンプレート ID
戻り値
Promise<WorkItemTemplate>
restoreWorkItem(WorkItemDeleteUpdate, number, string)
削除された作業項目をごみ箱から復元します。
function restoreWorkItem(payload: WorkItemDeleteUpdate, id: number, project?: string): Promise<WorkItemDelete>
パラメーター
- payload
- WorkItemDeleteUpdate
IsDeleted フラグを false に更新する手順を含む Paylod
- id
-
number
復元する作業項目の ID
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<WorkItemDelete>
searchQueries(string, string, number, QueryExpand, boolean)
現在のプロジェクトでユーザーがアクセスできるすべてのクエリを検索します
function searchQueries(project: string, filter: string, top?: number, expand?: QueryExpand, includeDeleted?: boolean): Promise<QueryHierarchyItemsResult>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- filter
-
string
クエリをフィルター処理するテキスト。
- top
-
number
返すクエリの数 (デフォルトは 50、最大値は 200)。
- expand
- QueryExpand
- includeDeleted
-
boolean
削除されたクエリとフォルダーを含める
戻り値
Promise<QueryHierarchyItemsResult>
sendMail(SendMailBody, string)
RESTful メソッドを使用して、選択/クエリされた作業項目のメールを送信します。
function sendMail(body: SendMailBody, project?: string): Promise<void>
パラメーター
- body
- SendMailBody
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<void>
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)
既存の分類ノードを更新します。
function updateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>
パラメーター
- postedNode
- WorkItemClassificationNode
作成または更新するノード。
- project
-
string
プロジェクト ID またはプロジェクト名
- structureGroup
- TreeStructureGroup
分類ノード、エリア、または反復の構造グループ。
- path
-
string
分類ノードのパス。
戻り値
Promise<WorkItemClassificationNode>
updateField(UpdateWorkItemField, string, string)
フィールドを更新します。
function updateField(payload: UpdateWorkItemField, fieldNameOrRefName: string, project?: string): Promise<WorkItemField>
パラメーター
- payload
- UpdateWorkItemField
ペイロードには、フィールドのプロパティの必要な値が含まれます
- fieldNameOrRefName
-
string
更新するフィールドの名前/参照名
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<WorkItemField>
updateQuery(QueryHierarchyItem, string, string, boolean)
クエリまたはフォルダーを更新します。 これにより、クエリとフォルダーの更新、名前変更、移動が可能になります。
function updateQuery(queryUpdate: QueryHierarchyItem, project: string, query: string, undeleteDescendants?: boolean): Promise<QueryHierarchyItem>
パラメーター
- queryUpdate
- QueryHierarchyItem
更新するクエリ。
- project
-
string
プロジェクト ID またはプロジェクト名
- query
-
string
更新するクエリの ID またはパス。
- undeleteDescendants
-
boolean
このフォルダの子の削除を取り消します。 これにより、以前に子孫に適用された権限の変更は戻らないことに注意することが重要です。
戻り値
Promise<QueryHierarchyItem>
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)
1 つの作業項目を更新します。
function updateWorkItem(document: JsonPatchDocument, id: number, project?: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemExpand): Promise<WorkItem>
パラメーター
- document
- JsonPatchDocument
更新を表す JSON パッチ ドキュメント
- id
-
number
更新する作業項目の ID
- project
-
string
プロジェクト ID またはプロジェクト名
- validateOnly
-
boolean
作業項目を保存せずに変更のみを検証するかどうかを示します
- bypassRules
-
boolean
この更新プログラムに作業項目の種類の規則を適用しないでください
- suppressNotifications
-
boolean
この変更の通知を発生させないでください
- expand
- WorkItemExpand
作業項目属性の展開パラメーター。 可能なオプションは、{ None、Relations、Fields、Links、All } です。
戻り値
Promise<WorkItem>
updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)
作業項目の種類を追加/更新する
function updateWorkItemTypeDefinition(updateModel: WorkItemTypeTemplateUpdateModel, project?: string): Promise<ProvisioningResult>
パラメーター
- updateModel
- WorkItemTypeTemplateUpdateModel
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<ProvisioningResult>