WorkItemTrackingRestClient class

Paket:: azure-devops-extension-api

Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api

Memperluas: RestClientBase

Konstruktor

WorkItemTrackingRestClient(IVssRestClientOptions)

Properti

Metode

createAttachment(any, string, string, string, string)	Mengupload lampiran.
createField(WorkItemField, string)	Buat bidang baru.
createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Buat baru atau perbarui simpul klasifikasi yang ada.
createQuery(QueryHierarchyItem, string, string, boolean)	Membuat kueri, atau memindahkan kueri.
createTemplate(WorkItemTemplate, string, string)	Membuat templat
createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)	Membuat satu item kerja.
deleteClassificationNode(string, TreeStructureGroup, string, number)	Hapus simpul klasifikasi yang ada.
deleteField(string, string)	Menghapus bidang. Untuk membatalkan penghapusan file, lihat API "Perbarui Bidang".
deleteQuery(string, string)	Hapus kueri atau folder. Ini menghapus perubahan izin apa pun pada kueri atau folder yang dihapus dan salah satu turunannya jika itu adalah folder. Penting untuk dicatat bahwa perubahan izin yang dihapus tidak dapat dipulihkan setelah membatalkan penghapusan kueri atau folder.
deleteTemplate(string, string, string)	Menghapus templat dengan id yang diberikan
deleteWorkItem(number, string, boolean)	Menghapus item kerja yang ditentukan dan mengirimkannya ke Recycle Bin, sehingga dapat dipulihkan kembali, jika diperlukan. Secara opsional, jika parameter destroy telah diatur ke true, parameter tersebut akan menghancurkan item kerja secara permanen. PERINGATAN: Jika parameter destroy diatur ke true, item kerja yang dihapus oleh perintah ini TIDAK akan masuk ke recycle-bin dan tidak ada cara untuk memulihkan/memulihkannya setelah dihapus. Disarankan untuk TIDAK menggunakan parameter ini. Jika ya, harap gunakan parameter ini dengan sangat hati-hati.
destroyWorkItem(number, string)	Menghancurkan item kerja yang ditentukan secara permanen dari Recycle Bin. Tindakan ini tidak dapat dibatalkan.
exportWorkItemTypeDefinition(string, string, boolean)	Ekspor jenis item kerja
getAccountMyWorkData(QueryOption)	HANYA INTERNAL: DIGUNAKAN OLEH AKUN HALAMAN KANTOR SAYA. Ini mengembalikan detail item kerja Lakukan, Selesai, Ikuti, dan aktivitas.
getAttachmentContent(string, string, string, boolean)	Mengunduh lampiran.
getAttachmentZip(string, string, string, boolean)	Mengunduh lampiran.
getClassificationNode(string, TreeStructureGroup, string, number)	Mendapatkan simpul klasifikasi untuk jalur simpul tertentu.
getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)	Mendapatkan simpul klasifikasi akar atau daftar simpul klasifikasi untuk daftar id simpul tertentu, untuk proyek tertentu. Jika parameter ids disediakan, Anda akan mendapatkan daftar node klasifikasi untuk id tersebut. Jika tidak, Anda akan mendapatkan simpul klasifikasi akar untuk proyek ini.
getComment(number, number, string)	Mendapatkan komentar untuk item kerja pada revisi yang ditentukan.
getComments(number, string, number, number, CommentSortOrder)	Mendapatkan jumlah komentar yang ditentukan untuk item kerja dari revisi yang ditentukan.
getDeletedWorkItem(number, string)	Mendapatkan item kerja yang dihapus dari Recycle Bin.
getDeletedWorkItems(number[], string)	Mendapatkan item kerja dari tempat sampah, yang ID-nya telah ditentukan dalam parameter
getDeletedWorkItemShallowReferences(string)	Mendapatkan daftar ID dan URL item kerja yang dihapus di Recycle Bin.
getField(string, string)	Mendapatkan informasi tentang bidang tertentu.
getFields(string, GetFieldsExpand)	Mengembalikan informasi untuk semua bidang. Parameter ID/nama proyek bersifat opsional.
getQueries(string, QueryExpand, number, boolean)	Mendapatkan kueri root dan turunannya
getQueriesBatch(QueryBatchGetRequest, string)	Mendapatkan daftar kueri berdasarkan id (Maksimum 1000)
getQuery(string, string, QueryExpand, number, boolean, boolean)	Mengambil kueri individual dan turunannya
getQueryResultCount(string, string, string, boolean, number)	Mendapatkan hasil kueri yang diberikan ID kueri.
getRecentActivityData()	Mendapatkan aktivitas item kerja terbaru
getRecentMentions()	HANYA INTERNAL: DIGUNAKAN OLEH AKUN HALAMAN KANTOR SAYA.
getRelationType(string)	Mendapatkan definisi jenis relasi item kerja.
getRelationTypes()	Mendapatkan jenis relasi item kerja.
getReportingLinksByLinkType(string, string[], string[], string, Date)	Mendapatkan kumpulan tautan item kerja
getRevision(number, number, string, WorkItemExpand)	Mengembalikan item kerja yang terhidrasi penuh untuk revisi yang diminta
getRevisions(number, string, number, number, WorkItemExpand)	Mengembalikan daftar revisi item kerja yang terhidrasi penuh, halaman.
getRootNodes(string, number)	Mendapatkan simpul klasifikasi akar di bawah proyek.
getTemplate(string, string, string)	Mendapatkan templat dengan id yang ditentukan
getTemplates(string, string, string)	Mendapatkan templat
getUpdate(number, number, string)	Mengembalikan satu pembaruan untuk item kerja
getUpdates(number, string, number, number)	Mengembalikan delta antara revisi item kerja
getWorkArtifactLinkTypes()	Dapatkan daftar jenis tautan artefak keluar pelacakan item kerja.
getWorkItem(number, string, string[], Date, WorkItemExpand)	Mengembalikan satu item kerja.
getWorkItemIconJson(string, string, number)	Dapatkan ikon item kerja dengan nama dan warna ikon yang ramah.
getWorkItemIcons()	Dapatkan daftar semua ikon item kerja.
getWorkItemIconSvg(string, string, number)	Dapatkan ikon item kerja dengan nama dan warna ikon yang ramah.
getWorkItemIconXaml(string, string, number)	Dapatkan ikon item kerja dengan nama dan warna ikon yang ramah.
getWorkItemNextStatesOnCheckinAction(number[], string)	Mengembalikan status berikutnya pada ID item kerja yang diberikan.
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)	Mengembalikan daftar item kerja (Maksimum 200)
getWorkItemsBatch(WorkItemBatchGetRequest, string)	Mendapatkan item kerja untuk daftar id item kerja (Maksimum 200)
getWorkItemStateColors(string[])	HANYA INTERNAL: Ini akan digunakan untuk pengalaman kerja akun saya. Dapatkan warna status jenis item kerja untuk beberapa proyek
getWorkItemTemplate(string, string, string, Date, WorkItemExpand)	Mengembalikan satu item kerja dari templat.
getWorkItemType(string, string)	Mengembalikan definisi jenis item kerja.
getWorkItemTypeCategories(string)	Dapatkan semua kategori jenis item kerja.
getWorkItemTypeCategory(string, string)	Dapatkan kategori jenis item kerja tertentu berdasarkan nama.
getWorkItemTypeColorAndIcons(string[])	HANYA INTERNAL: Ini digunakan untuk penyedia warna dan ikon. Dapatkan warna jenis kecerdasan untuk beberapa proyek
getWorkItemTypeColors(string[])	HANYA INTERNAL: Ini akan digunakan untuk pengalaman kerja akun saya. Dapatkan warna jenis kecerdasan untuk beberapa proyek
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)	Dapatkan daftar bidang untuk jenis item kerja dengan referensi terperinci.
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)	Dapatkan bidang untuk jenis item kerja dengan referensi terperinci.
getWorkItemTypes(string)	Mengembalikan daftar jenis item kerja
getWorkItemTypeStates(string, string)	Mengembalikan nama status dan warna untuk jenis item kerja.
queryById(string, string, string, boolean, number)	Mendapatkan hasil kueri yang diberikan ID kueri.
queryByWiql(Wiql, string, string, boolean, number)	Mendapatkan hasil kueri berdasarkan WIQL-nya.
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)	Mengkueri item kerja yang ditautkan ke daftar URI artefak tertentu.
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)	Dapatkan sekumpulan revisi item kerja dengan opsi menyertakan item yang dihapus
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)	Dapatkan sekumpulan revisi item kerja. Permintaan ini dapat digunakan jika daftar kolom Anda cukup besar sehingga URL dapat menjalankan URL melebihi batas panjang.
replaceTemplate(WorkItemTemplate, string, string, string)	Mengganti konten template
restoreWorkItem(WorkItemDeleteUpdate, number, string)	Memulihkan item kerja yang dihapus dari Recycle Bin.
searchQueries(string, string, number, QueryExpand, boolean)	Mencari semua kueri yang dapat diakses pengguna dalam proyek saat ini
sendMail(SendMailBody, string)	Metode RESTful untuk mengirim email untuk item kerja yang dipilih/dikueri.
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Perbarui simpul klasifikasi yang ada.
updateField(UpdateWorkItemField, string, string)	Perbarui bidang.
updateQuery(QueryHierarchyItem, string, string, boolean)	Perbarui kueri atau folder. Ini memungkinkan Anda untuk memperbarui, mengganti nama, dan memindahkan kueri dan folder.
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)	Memperbarui satu item kerja.
updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)	Menambahkan/memperbarui jenis item kerja

Detail Konstruktor

WorkItemTrackingRestClient(IVssRestClientOptions)

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

Parameter

options: IVssRestClientOptions

Detail Properti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Nilai Properti

string

Detail Metode

createAttachment(any, string, string, string, string)

Mengupload lampiran.

function createAttachment(content: any, project?: string, fileName?: string, uploadType?: string, areaPath?: string): Promise<AttachmentReference>

Parameter

content: any

Konten yang akan diunggah

project: string

ID proyek atau nama proyek

fileName: string

Nama file

uploadType: string

Jenis unggahan lampiran: Sederhana atau Terpotong

areaPath: string

Jalur Area proyek target

Mengembalikan

Promise<AttachmentReference>

createField(WorkItemField, string)

Buat bidang baru.

function createField(workItemField: WorkItemField, project?: string): Promise<WorkItemField>

Parameter

workItemField: WorkItemField

Definisi bidang baru

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<WorkItemField>

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Buat baru atau perbarui simpul klasifikasi yang ada.

function createOrUpdateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>

Parameter

postedNode: WorkItemClassificationNode

Node untuk dibuat atau diperbarui.

project: string

ID proyek atau nama proyek

structureGroup: TreeStructureGroup

Kelompok struktur simpul klasifikasi, area atau iterasi.

path: string

Jalur simpul klasifikasi.

Mengembalikan

Promise<WorkItemClassificationNode>

createQuery(QueryHierarchyItem, string, string, boolean)

Membuat kueri, atau memindahkan kueri.

function createQuery(postedQuery: QueryHierarchyItem, project: string, query: string, validateWiqlOnly?: boolean): Promise<QueryHierarchyItem>

Parameter

postedQuery: QueryHierarchyItem

Kueri yang akan dibuat.

project: string

ID proyek atau nama proyek

query: string

ID induk atau jalur di mana kueri akan dibuat.

validateWiqlOnly: boolean

Jika Anda hanya ingin memvalidasi kueri WIQL Anda tanpa benar-benar membuatnya, atur ke true. Secara default adalah false.

Mengembalikan

Promise<QueryHierarchyItem>

createTemplate(WorkItemTemplate, string, string)

Membuat templat

function createTemplate(template: WorkItemTemplate, project: string, team: string): Promise<WorkItemTemplate>

Parameter

template: WorkItemTemplate

Isi templat

project: string

ID proyek atau nama proyek

team: string

ID tim atau nama tim

Mengembalikan

Promise<WorkItemTemplate>

createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)

Membuat satu item kerja.

function createWorkItem(document: JsonPatchDocument, project: string, type: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemExpand): Promise<WorkItem>

Parameter

document: JsonPatchDocument

Dokumen JSON Patch yang mewakili item kerja

project: string

ID proyek atau nama proyek

type: string

Jenis item kerja item kerja yang akan dibuat

validateOnly: boolean

Tunjukkan apakah Anda hanya ingin memvalidasi perubahan tanpa menyimpan item kerja

bypassRules: boolean

Jangan terapkan aturan jenis item kerja pada pembaruan ini

suppressNotifications: boolean

Jangan menembakkan pemberitahuan apa pun untuk perubahan ini

expand: WorkItemExpand

Perluas parameter untuk atribut item kerja. Opsi yang mungkin adalah { None, Relations, Fields, Links, All }.

Mengembalikan

Promise<WorkItem>

deleteClassificationNode(string, TreeStructureGroup, string, number)

Hapus simpul klasifikasi yang ada.

function deleteClassificationNode(project: string, structureGroup: TreeStructureGroup, path?: string, reclassifyId?: number): Promise<void>

Parameter

project: string

ID proyek atau nama proyek

structureGroup: TreeStructureGroup

Kelompok struktur simpul klasifikasi, area atau iterasi.

path: string

Jalur simpul klasifikasi.

reclassifyId: number

Id simpul klasifikasi target untuk klasifikasi ulang.

Mengembalikan

Promise<void>

deleteField(string, string)

Menghapus bidang. Untuk membatalkan penghapusan file, lihat API "Perbarui Bidang".

function deleteField(fieldNameOrRefName: string, project?: string): Promise<void>

Parameter

fieldNameOrRefName: string

Nama sederhana bidang atau nama referensi

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<void>

deleteQuery(string, string)

Hapus kueri atau folder. Ini menghapus perubahan izin apa pun pada kueri atau folder yang dihapus dan salah satu turunannya jika itu adalah folder. Penting untuk dicatat bahwa perubahan izin yang dihapus tidak dapat dipulihkan setelah membatalkan penghapusan kueri atau folder.

function deleteQuery(project: string, query: string): Promise<void>

Parameter

project: string

ID proyek atau nama proyek

query: string

ID atau jalur kueri atau folder yang akan dihapus.

Mengembalikan

Promise<void>

deleteTemplate(string, string, string)

Menghapus templat dengan id yang diberikan

function deleteTemplate(project: string, team: string, templateId: string): Promise<void>

Parameter

project: string

ID proyek atau nama proyek

team: string

ID tim atau nama tim

templateId: string

ID templat

Mengembalikan

Promise<void>

deleteWorkItem(number, string, boolean)

Menghapus item kerja yang ditentukan dan mengirimkannya ke Recycle Bin, sehingga dapat dipulihkan kembali, jika diperlukan. Secara opsional, jika parameter destroy telah diatur ke true, parameter tersebut akan menghancurkan item kerja secara permanen. PERINGATAN: Jika parameter destroy diatur ke true, item kerja yang dihapus oleh perintah ini TIDAK akan masuk ke recycle-bin dan tidak ada cara untuk memulihkan/memulihkannya setelah dihapus. Disarankan untuk TIDAK menggunakan parameter ini. Jika ya, harap gunakan parameter ini dengan sangat hati-hati.

function deleteWorkItem(id: number, project?: string, destroy?: boolean): Promise<WorkItemDelete>

Parameter

id: number

ID item kerja yang akan dihapus

project: string

ID proyek atau nama proyek

destroy: boolean

Parameter opsional, jika diatur ke true, item kerja dihapus secara permanen. Harap dicatat: tindakan penghancuran bersifat PERMANEN dan tidak dapat dibatalkan.

Mengembalikan

Promise<WorkItemDelete>

destroyWorkItem(number, string)

Menghancurkan item kerja yang ditentukan secara permanen dari Recycle Bin. Tindakan ini tidak dapat dibatalkan.

function destroyWorkItem(id: number, project?: string): Promise<void>

Parameter

id: number

ID item kerja yang akan dihancurkan secara permanen

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<void>

exportWorkItemTypeDefinition(string, string, boolean)

Ekspor jenis item kerja

function exportWorkItemTypeDefinition(project?: string, type?: string, exportGlobalLists?: boolean): Promise<WorkItemTypeTemplate>

Parameter

project: string

ID proyek atau nama proyek

type: string

exportGlobalLists: boolean

Mengembalikan

Promise<WorkItemTypeTemplate>

getAccountMyWorkData(QueryOption)

HANYA INTERNAL: DIGUNAKAN OLEH AKUN HALAMAN KANTOR SAYA. Ini mengembalikan detail item kerja Lakukan, Selesai, Ikuti, dan aktivitas.

function getAccountMyWorkData(queryOption?: QueryOption): Promise<AccountMyWorkResult>

Parameter

queryOption: QueryOption

Mengembalikan

Promise<AccountMyWorkResult>

getAttachmentContent(string, string, string, boolean)

Mengunduh lampiran.

function getAttachmentContent(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>

Parameter

id: string

ID Lampiran

project: string

ID proyek atau nama proyek

fileName: string

Nama file

download: boolean

Jika diatur ke <c>true</c> selalu unduh lampiran

Mengembalikan

Promise<ArrayBuffer>

getAttachmentZip(string, string, string, boolean)

Mengunduh lampiran.

function getAttachmentZip(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>

Parameter

id: string

ID Lampiran

project: string

ID proyek atau nama proyek

fileName: string

Nama file

download: boolean

Jika diatur ke <c>true</c> selalu unduh lampiran

Mengembalikan

Promise<ArrayBuffer>

getClassificationNode(string, TreeStructureGroup, string, number)

Mendapatkan simpul klasifikasi untuk jalur simpul tertentu.

function getClassificationNode(project: string, structureGroup: TreeStructureGroup, path?: string, depth?: number): Promise<WorkItemClassificationNode>

Parameter

project: string

ID proyek atau nama proyek

structureGroup: TreeStructureGroup

Kelompok struktur simpul klasifikasi, area atau iterasi.

path: string

Jalur simpul klasifikasi.

depth: number

Kedalaman anak-anak untuk mengambil.

Mengembalikan

Promise<WorkItemClassificationNode>

getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)

Mendapatkan simpul klasifikasi akar atau daftar simpul klasifikasi untuk daftar id simpul tertentu, untuk proyek tertentu. Jika parameter ids disediakan, Anda akan mendapatkan daftar node klasifikasi untuk id tersebut. Jika tidak, Anda akan mendapatkan simpul klasifikasi akar untuk proyek ini.

function getClassificationNodes(project: string, ids: number[], depth?: number, errorPolicy?: ClassificationNodesErrorPolicy): Promise<WorkItemClassificationNode[]>

Parameter

project: string

ID proyek atau nama proyek

ids: number[]

Id node klasifikasi bilangan bulat yang dipisahkan koma. Ini tidak diperlukan, jika Anda menginginkan simpul root.

depth: number

Kedalaman anak-anak untuk mengambil.

errorPolicy: ClassificationNodesErrorPolicy

Tandai untuk menangani kesalahan dalam mendapatkan beberapa node. Opsi yang mungkin adalah Gagal dan Hilangkan.

Mengembalikan

Promise<WorkItemClassificationNode[]>

getComment(number, number, string)

Mendapatkan komentar untuk item kerja pada revisi yang ditentukan.

function getComment(id: number, revision: number, project?: string): Promise<WorkItemComment>

Parameter

id: number

Id item kerja

revision: number

Revisi yang komentarnya perlu diambil

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<WorkItemComment>

getComments(number, string, number, number, CommentSortOrder)

Mendapatkan jumlah komentar yang ditentukan untuk item kerja dari revisi yang ditentukan.

function getComments(id: number, project?: string, fromRevision?: number, top?: number, order?: CommentSortOrder): Promise<WorkItemComments>

Parameter

id: number

Id item kerja

project: string

ID proyek atau nama proyek

fromRevision: number

Revisi dari mana komentar akan diambil (defaultnya adalah 1)

top: number

Jumlah komentar yang akan dikembalikan (defaultnya adalah 200)

order: CommentSortOrder

Naik atau menurun dengan id revisi (defaultnya naik)

Mengembalikan

Promise<WorkItemComments>

getDeletedWorkItem(number, string)

Mendapatkan item kerja yang dihapus dari Recycle Bin.

function getDeletedWorkItem(id: number, project?: string): Promise<WorkItemDelete>

Parameter

id: number

ID item kerja yang akan dikembalikan

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<WorkItemDelete>

getDeletedWorkItems(number[], string)

Mendapatkan item kerja dari tempat sampah, yang ID-nya telah ditentukan dalam parameter

function getDeletedWorkItems(ids: number[], project?: string): Promise<WorkItemDeleteReference[]>

Parameter

ids: number[]

Daftar ID yang dipisahkan koma dari item kerja yang akan dihapus untuk dikembalikan

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<WorkItemDeleteReference[]>

getDeletedWorkItemShallowReferences(string)

Mendapatkan daftar ID dan URL item kerja yang dihapus di Recycle Bin.

function getDeletedWorkItemShallowReferences(project?: string): Promise<WorkItemDeleteShallowReference[]>

Parameter

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<WorkItemDeleteShallowReference[]>

getField(string, string)

Mendapatkan informasi tentang bidang tertentu.

function getField(fieldNameOrRefName: string, project?: string): Promise<WorkItemField>

Parameter

fieldNameOrRefName: string

Nama sederhana bidang atau nama referensi

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

Mengembalikan informasi untuk semua bidang. Parameter ID/nama proyek bersifat opsional.

function getFields(project?: string, expand?: GetFieldsExpand): Promise<WorkItemField[]>

Parameter

project: string

ID proyek atau nama proyek

expand: GetFieldsExpand

Gunakan ExtensionFields untuk menyertakan bidang ekstensi, jika tidak, kecualikan. Kecuali bendera fitur untuk parameter ini diaktifkan, bidang ekstensi selalu disertakan.

Mengembalikan

Promise<WorkItemField[]>

getQueries(string, QueryExpand, number, boolean)

Mendapatkan kueri root dan turunannya

function getQueries(project: string, expand?: QueryExpand, depth?: number, includeDeleted?: boolean): Promise<QueryHierarchyItem[]>

Parameter

project: string

ID proyek atau nama proyek

expand: QueryExpand

Sertakan string kueri (wiql), klausa, kolom hasil kueri, dan opsi pengurutan dalam hasil.

depth: number

Dalam folder kueri, kembalikan kueri dan folder turunan ke kedalaman ini.

includeDeleted: boolean

Sertakan kueri dan folder yang dihapus

Mengembalikan

Promise<QueryHierarchyItem[]>

getQueriesBatch(QueryBatchGetRequest, string)

Mendapatkan daftar kueri berdasarkan id (Maksimum 1000)

function getQueriesBatch(queryGetRequest: QueryBatchGetRequest, project: string): Promise<QueryHierarchyItem[]>

Parameter

queryGetRequest: QueryBatchGetRequest

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<QueryHierarchyItem[]>

getQuery(string, string, QueryExpand, number, boolean, boolean)

Mengambil kueri individual dan turunannya

function getQuery(project: string, query: string, expand?: QueryExpand, depth?: number, includeDeleted?: boolean, useIsoDateFormat?: boolean): Promise<QueryHierarchyItem>

Parameter

project: string

ID proyek atau nama proyek

query: string

ID atau jalur kueri.

expand: QueryExpand

Sertakan string kueri (wiql), klausa, kolom hasil kueri, dan opsi pengurutan dalam hasil.

depth: number

Dalam folder kueri, kembalikan kueri dan folder turunan ke kedalaman ini.

includeDeleted: boolean

Sertakan kueri dan folder yang dihapus

useIsoDateFormat: boolean

Klausa kueri DateTime akan diformat menggunakan format yang sesuai dengan ISO 8601

Mengembalikan

Promise<QueryHierarchyItem>

getQueryResultCount(string, string, string, boolean, number)

Mendapatkan hasil kueri yang diberikan ID kueri.

function getQueryResultCount(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<number>

Parameter

id: string

ID kueri.

project: string

ID proyek atau nama proyek

team: string

ID tim atau nama tim

timePrecision: boolean

Apakah akan menggunakan presisi waktu atau tidak.

top: number

Jumlah maksimum hasil yang akan dikembalikan.

Mengembalikan

Promise<number>

getRecentActivityData()

Mendapatkan aktivitas item kerja terbaru

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Mengembalikan

Promise<AccountRecentActivityWorkItemModel2[]>

getRecentMentions()

HANYA INTERNAL: DIGUNAKAN OLEH AKUN HALAMAN KANTOR SAYA.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Mengembalikan

Promise<AccountRecentMentionWorkItemModel[]>

getRelationType(string)

Mendapatkan definisi jenis relasi item kerja.

function getRelationType(relation: string): Promise<WorkItemRelationType>

Parameter

relation: string

Nama relasi

Mengembalikan

Promise<WorkItemRelationType>

getRelationTypes()

Mendapatkan jenis relasi item kerja.

function getRelationTypes(): Promise<WorkItemRelationType[]>

Mengembalikan

Promise<WorkItemRelationType[]>

getReportingLinksByLinkType(string, string[], string[], string, Date)

Mendapatkan kumpulan tautan item kerja

function getReportingLinksByLinkType(project?: string, linkTypes?: string[], types?: string[], continuationToken?: string, startDateTime?: Date): Promise<ReportingWorkItemLinksBatch>

Parameter

project: string

ID proyek atau nama proyek

linkTypes: string[]

Daftar jenis untuk memfilter hasil ke jenis tautan tertentu. Hilangkan parameter ini untuk mendapatkan tautan item kerja dari semua jenis tautan.

types: string[]

Daftar jenis untuk memfilter hasil ke jenis item kerja tertentu. Hilangkan parameter ini untuk mendapatkan tautan item kerja dari semua jenis item kerja.

continuationToken: string

Menentukan continuationToken untuk memulai batch. Hilangkan parameter ini untuk mendapatkan kumpulan tautan pertama.

startDateTime: Date

Tanggal/waktu untuk digunakan sebagai titik awal untuk perubahan tautan. Hanya perubahan tautan yang terjadi setelah tanggal/waktu tersebut yang akan ditampilkan. Tidak dapat digunakan bersama dengan parameter 'watermark'.

Mengembalikan

Promise<ReportingWorkItemLinksBatch>

getRevision(number, number, string, WorkItemExpand)

Mengembalikan item kerja yang terhidrasi penuh untuk revisi yang diminta

function getRevision(id: number, revisionNumber: number, project?: string, expand?: WorkItemExpand): Promise<WorkItem>

Parameter

id: number

revisionNumber: number

project: string

ID proyek atau nama proyek

expand: WorkItemExpand

Mengembalikan

Promise<WorkItem>

getRevisions(number, string, number, number, WorkItemExpand)

Mengembalikan daftar revisi item kerja yang terhidrasi penuh, halaman.

function getRevisions(id: number, project?: string, top?: number, skip?: number, expand?: WorkItemExpand): Promise<WorkItem[]>

Parameter

id: number

project: string

ID proyek atau nama proyek

top: number

skip: number

expand: WorkItemExpand

Mengembalikan

Promise<WorkItem[]>

getRootNodes(string, number)

Mendapatkan simpul klasifikasi akar di bawah proyek.

function getRootNodes(project: string, depth?: number): Promise<WorkItemClassificationNode[]>

Parameter

project: string

ID proyek atau nama proyek

depth: number

Kedalaman anak-anak untuk mengambil.

Mengembalikan

Promise<WorkItemClassificationNode[]>

getTemplate(string, string, string)

Mendapatkan templat dengan id yang ditentukan

function getTemplate(project: string, team: string, templateId: string): Promise<WorkItemTemplate>

Parameter

project: string

ID proyek atau nama proyek

team: string

ID tim atau nama tim

templateId: string

ID Templat

Mengembalikan

Promise<WorkItemTemplate>

getTemplates(string, string, string)

Mendapatkan templat

function getTemplates(project: string, team: string, workitemtypename?: string): Promise<WorkItemTemplateReference[]>

Parameter

project: string

ID proyek atau nama proyek

team: string

ID tim atau nama tim

workitemtypename: string

Opsional, Saat ditentukan mengembalikan templat untuk jenis item Kerja yang diberikan.

Mengembalikan

Promise<WorkItemTemplateReference[]>

getUpdate(number, number, string)

Mengembalikan satu pembaruan untuk item kerja

function getUpdate(id: number, updateNumber: number, project?: string): Promise<WorkItemUpdate>

Parameter

id: number

updateNumber: number

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<WorkItemUpdate>

getUpdates(number, string, number, number)

Mengembalikan delta antara revisi item kerja

function getUpdates(id: number, project?: string, top?: number, skip?: number): Promise<WorkItemUpdate[]>

Parameter

id: number

project: string

ID proyek atau nama proyek

top: number

skip: number

Mengembalikan

Promise<WorkItemUpdate[]>

getWorkArtifactLinkTypes()

Dapatkan daftar jenis tautan artefak keluar pelacakan item kerja.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

Mengembalikan

Promise<WorkArtifactLink[]>

getWorkItem(number, string, string[], Date, WorkItemExpand)

Mengembalikan satu item kerja.

function getWorkItem(id: number, project?: string, fields?: string[], asOf?: Date, expand?: WorkItemExpand): Promise<WorkItem>

Parameter

id: number

ID item kerja

project: string

ID proyek atau nama proyek

fields: string[]

Daftar bidang yang diminta yang dipisahkan koma

asOf: Date

AsOf UTC string tanggal waktu

expand: WorkItemExpand

Perluas parameter untuk atribut item kerja. Opsi yang mungkin adalah { None, Relations, Fields, Links, All }.

Mengembalikan

Promise<WorkItem>

getWorkItemIconJson(string, string, number)

Dapatkan ikon item kerja dengan nama dan warna ikon yang ramah.

function getWorkItemIconJson(icon: string, color?: string, v?: number): Promise<WorkItemIcon>

Parameter

icon: string

Nama ikon

color: string

Warna hex 6 digit untuk ikon

v: number

Versi ikon (hanya digunakan untuk pembatalan cache)

Mengembalikan

Promise<WorkItemIcon>

getWorkItemIcons()

Dapatkan daftar semua ikon item kerja.

function getWorkItemIcons(): Promise<WorkItemIcon[]>

Mengembalikan

Promise<WorkItemIcon[]>

getWorkItemIconSvg(string, string, number)

Dapatkan ikon item kerja dengan nama dan warna ikon yang ramah.

function getWorkItemIconSvg(icon: string, color?: string, v?: number): Promise<any>

Parameter

icon: string

Nama ikon

color: string

Warna hex 6 digit untuk ikon

v: number

Versi ikon (hanya digunakan untuk pembatalan cache)

Mengembalikan

Promise<any>

getWorkItemIconXaml(string, string, number)

Dapatkan ikon item kerja dengan nama dan warna ikon yang ramah.

function getWorkItemIconXaml(icon: string, color?: string, v?: number): Promise<any>

Parameter

icon: string

Nama ikon

color: string

Warna hex 6 digit untuk ikon

v: number

Versi ikon (hanya digunakan untuk pembatalan cache)

Mengembalikan

Promise<any>

getWorkItemNextStatesOnCheckinAction(number[], string)

Mengembalikan status berikutnya pada ID item kerja yang diberikan.

function getWorkItemNextStatesOnCheckinAction(ids: number[], action?: string): Promise<WorkItemNextStateOnTransition[]>

Parameter

ids: number[]

Daftar ID item kerja

action: string

tindakan yang mungkin. Saat ini hanya mendukung check-in

Mengembalikan

Promise<WorkItemNextStateOnTransition[]>

getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)

Mengembalikan daftar item kerja (Maksimum 200)

function getWorkItems(ids: number[], project?: string, fields?: string[], asOf?: Date, expand?: WorkItemExpand, errorPolicy?: WorkItemErrorPolicy): Promise<WorkItem[]>

Parameter

ids: number[]

Daftar id item kerja yang dipisahkan koma (Maksimum 200 id diizinkan).

project: string

ID proyek atau nama proyek

fields: string[]

Daftar bidang yang diminta yang dipisahkan koma

asOf: Date

AsOf UTC string tanggal waktu

expand: WorkItemExpand

Perluas parameter untuk atribut item kerja. Opsi yang mungkin adalah { None, Relations, Fields, Links, All }.

errorPolicy: WorkItemErrorPolicy

Bendera untuk mengontrol kebijakan kesalahan dalam permintaan mendapatkan item kerja massal. Opsi yang mungkin adalah {Gagal, Hilangkan}.

Mengembalikan

Promise<WorkItem[]>

getWorkItemsBatch(WorkItemBatchGetRequest, string)

Mendapatkan item kerja untuk daftar id item kerja (Maksimum 200)

function getWorkItemsBatch(workItemGetRequest: WorkItemBatchGetRequest, project?: string): Promise<WorkItem[]>

Parameter

workItemGetRequest: WorkItemBatchGetRequest

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<WorkItem[]>

getWorkItemStateColors(string[])

HANYA INTERNAL: Ini akan digunakan untuk pengalaman kerja akun saya. Dapatkan warna status jenis item kerja untuk beberapa proyek

function getWorkItemStateColors(projectNames: string[]): Promise<ProjectWorkItemStateColors[]>

Parameter

projectNames: string[]

Mengembalikan

Promise<ProjectWorkItemStateColors[]>

getWorkItemTemplate(string, string, string, Date, WorkItemExpand)

Mengembalikan satu item kerja dari templat.

function getWorkItemTemplate(project: string, type: string, fields?: string, asOf?: Date, expand?: WorkItemExpand): Promise<WorkItem>

Parameter

project: string

ID proyek atau nama proyek

type: string

Nama jenis item kerja

fields: string

Daftar bidang yang diminta yang dipisahkan koma

asOf: Date

AsOf UTC string tanggal waktu

expand: WorkItemExpand

Perluas parameter untuk atribut item kerja. Opsi yang mungkin adalah { None, Relations, Fields, Links, All }.

Mengembalikan

Promise<WorkItem>

getWorkItemType(string, string)

Mengembalikan definisi jenis item kerja.

function getWorkItemType(project: string, type: string): Promise<WorkItemType>

Parameter

project: string

ID proyek atau nama proyek

type: string

Nama jenis item kerja

Mengembalikan

Promise<WorkItemType>

getWorkItemTypeCategories(string)

Dapatkan semua kategori jenis item kerja.

function getWorkItemTypeCategories(project: string): Promise<WorkItemTypeCategory[]>

Parameter

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<WorkItemTypeCategory[]>

getWorkItemTypeCategory(string, string)

Dapatkan kategori jenis item kerja tertentu berdasarkan nama.

function getWorkItemTypeCategory(project: string, category: string): Promise<WorkItemTypeCategory>

Parameter

project: string

ID proyek atau nama proyek

category: string

Nama kategori

Mengembalikan

Promise<WorkItemTypeCategory>

getWorkItemTypeColorAndIcons(string[])

HANYA INTERNAL: Ini digunakan untuk penyedia warna dan ikon. Dapatkan warna jenis kecerdasan untuk beberapa proyek

function getWorkItemTypeColorAndIcons(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>

Parameter

projectNames: string[]

Mengembalikan

Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>

getWorkItemTypeColors(string[])

HANYA INTERNAL: Ini akan digunakan untuk pengalaman kerja akun saya. Dapatkan warna jenis kecerdasan untuk beberapa proyek

function getWorkItemTypeColors(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColor[] }[]>

Parameter

projectNames: string[]

Mengembalikan

Promise<{ key: string, value: WorkItemTypeColor[] }[]>

getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)

Dapatkan daftar bidang untuk jenis item kerja dengan referensi terperinci.

function getWorkItemTypeFieldsWithReferences(project: string, type: string, expand?: WorkItemTypeFieldsExpandLevel): Promise<WorkItemTypeFieldWithReferences[]>

Parameter

project: string

ID proyek atau nama proyek

type: string

Jenis item kerja.

expand: WorkItemTypeFieldsExpandLevel

Perluas level untuk respons API. Properti: untuk menyertakan allowvalues, nilai default, isRequired, dll. sebagai bagian dari respons; Tidak ada: untuk melewati properti ini.

Mengembalikan

Promise<WorkItemTypeFieldWithReferences[]>

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

Dapatkan bidang untuk jenis item kerja dengan referensi terperinci.

function getWorkItemTypeFieldWithReferences(project: string, type: string, field: string, expand?: WorkItemTypeFieldsExpandLevel): Promise<WorkItemTypeFieldWithReferences>

Parameter

project: string

ID proyek atau nama proyek

type: string

Jenis item kerja.

field: string

expand: WorkItemTypeFieldsExpandLevel

Perluas level untuk respons API. Properti: untuk menyertakan allowvalues, nilai default, isRequired, dll. sebagai bagian dari respons; Tidak ada: untuk melewati properti ini.

Mengembalikan

Promise<WorkItemTypeFieldWithReferences>

getWorkItemTypes(string)

Mengembalikan daftar jenis item kerja

function getWorkItemTypes(project: string): Promise<WorkItemType[]>

Parameter

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<WorkItemType[]>

getWorkItemTypeStates(string, string)

Mengembalikan nama status dan warna untuk jenis item kerja.

function getWorkItemTypeStates(project: string, type: string): Promise<WorkItemStateColor[]>

Parameter

project: string

ID proyek atau nama proyek

type: string

Nama negara bagian

Mengembalikan

Promise<WorkItemStateColor[]>

queryById(string, string, string, boolean, number)

Mendapatkan hasil kueri yang diberikan ID kueri.

function queryById(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemQueryResult>

Parameter

id: string

ID kueri.

project: string

ID proyek atau nama proyek

team: string

ID tim atau nama tim

timePrecision: boolean

Apakah akan menggunakan presisi waktu atau tidak.

top: number

Jumlah maksimum hasil yang akan dikembalikan.

Mengembalikan

Promise<WorkItemQueryResult>

queryByWiql(Wiql, string, string, boolean, number)

Mendapatkan hasil kueri berdasarkan WIQL-nya.

function queryByWiql(wiql: Wiql, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemQueryResult>

Parameter

wiql: Wiql

Kueri yang berisi WIQL.

project: string

ID proyek atau nama proyek

team: string

ID tim atau nama tim

timePrecision: boolean

Apakah akan menggunakan presisi waktu atau tidak.

top: number

Jumlah maksimum hasil yang akan dikembalikan.

Mengembalikan

Promise<WorkItemQueryResult>

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

Mengkueri item kerja yang ditautkan ke daftar URI artefak tertentu.

function queryWorkItemsForArtifactUris(artifactUriQuery: ArtifactUriQuery, project?: string): Promise<ArtifactUriQueryResult>

Parameter

artifactUriQuery: ArtifactUriQuery

Menentukan daftar URI artefak untuk mengkueri item kerja.

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<ArtifactUriQueryResult>

readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)

Dapatkan sekumpulan revisi item kerja dengan opsi menyertakan item yang dihapus

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>

Parameter

project: string

ID proyek atau nama proyek

fields: string[]

Daftar bidang yang akan dikembalikan dalam revisi item kerja. Hilangkan parameter ini untuk mendapatkan semua bidang yang dapat dilaporkan.

types: string[]

Daftar jenis untuk memfilter hasil ke jenis item kerja tertentu. Hilangkan parameter ini untuk mendapatkan revisi item kerja dari semua jenis item kerja.

continuationToken: string

Menentukan tanda air untuk memulai batch. Hilangkan parameter ini untuk mendapatkan batch revisi pertama.

startDateTime: Date

Tanggal/waktu untuk digunakan sebagai titik awal revisi, semua revisi akan terjadi setelah tanggal/waktu ini. Tidak dapat digunakan bersama dengan parameter 'watermark'.

includeIdentityRef: boolean

Mengembalikan referensi identitas alih-alih nilai string untuk bidang identitas.

includeDeleted: boolean

Tentukan apakah item yang dihapus harus dikembalikan.

includeTagRef: boolean

Tentukan apakah objek tag harus dikembalikan untuk bidang System.Tags.

includeLatestOnly: boolean

Mengembalikan hanya revisi terbaru item kerja, melewati semua revisi historis

expand: ReportingRevisionsExpand

Mengembalikan semua bidang dalam revisi item kerja, termasuk bidang teks panjang yang tidak dikembalikan secara default

includeDiscussionChangesOnly: boolean

Mengembalikan hanya revisi item kerja, di mana hanya bidang riwayat yang diubah

maxPageSize: number

Jumlah maksimum hasil yang akan dikembalikan dalam batch ini

Mengembalikan

Promise<ReportingWorkItemRevisionsBatch>

readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)

Dapatkan sekumpulan revisi item kerja. Permintaan ini dapat digunakan jika daftar kolom Anda cukup besar sehingga URL dapat menjalankan URL melebihi batas panjang.

function readReportingRevisionsPost(filter: ReportingWorkItemRevisionsFilter, project?: string, continuationToken?: string, startDateTime?: Date, expand?: ReportingRevisionsExpand): Promise<ReportingWorkItemRevisionsBatch>

Parameter

filter: ReportingWorkItemRevisionsFilter

Objek yang berisi pengaturan permintaan: filter bidang, filter jenis, format identitas

project: string

ID proyek atau nama proyek

continuationToken: string

Menentukan tanda air untuk memulai batch. Hilangkan parameter ini untuk mendapatkan batch revisi pertama.

startDateTime: Date

Tanggal/waktu untuk digunakan sebagai titik awal revisi, semua revisi akan terjadi setelah tanggal/waktu ini. Tidak dapat digunakan bersama dengan parameter 'watermark'.

expand: ReportingRevisionsExpand

Mengembalikan

Promise<ReportingWorkItemRevisionsBatch>

replaceTemplate(WorkItemTemplate, string, string, string)

Mengganti konten template

function replaceTemplate(templateContent: WorkItemTemplate, project: string, team: string, templateId: string): Promise<WorkItemTemplate>

Parameter

templateContent: WorkItemTemplate

Konten template untuk diganti dengan

project: string

ID proyek atau nama proyek

team: string

ID tim atau nama tim

templateId: string

ID templat

Mengembalikan

Promise<WorkItemTemplate>

restoreWorkItem(WorkItemDeleteUpdate, number, string)

Memulihkan item kerja yang dihapus dari Recycle Bin.

function restoreWorkItem(payload: WorkItemDeleteUpdate, id: number, project?: string): Promise<WorkItemDelete>

Parameter

payload: WorkItemDeleteUpdate

Paylod dengan instruksi untuk memperbarui bendera IsDeleted menjadi false

id: number

ID item kerja yang akan dipulihkan

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<WorkItemDelete>

searchQueries(string, string, number, QueryExpand, boolean)

Mencari semua kueri yang dapat diakses pengguna dalam proyek saat ini

function searchQueries(project: string, filter: string, top?: number, expand?: QueryExpand, includeDeleted?: boolean): Promise<QueryHierarchyItemsResult>

Parameter

project: string

ID proyek atau nama proyek

filter: string

Teks untuk memfilter kueri.

top: number

Jumlah kueri yang akan dikembalikan (Default adalah 50 dan maksimum adalah 200).

expand: QueryExpand

includeDeleted: boolean

Sertakan kueri dan folder yang dihapus

Mengembalikan

Promise<QueryHierarchyItemsResult>

sendMail(SendMailBody, string)

Metode RESTful untuk mengirim email untuk item kerja yang dipilih/dikueri.

function sendMail(body: SendMailBody, project?: string): Promise<void>

Parameter

body: SendMailBody

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<void>

updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Perbarui simpul klasifikasi yang ada.

function updateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>

Parameter

postedNode: WorkItemClassificationNode

Node untuk dibuat atau diperbarui.

project: string

ID proyek atau nama proyek

structureGroup: TreeStructureGroup

Kelompok struktur simpul klasifikasi, area atau iterasi.

path: string

Jalur simpul klasifikasi.

Mengembalikan

Promise<WorkItemClassificationNode>

updateField(UpdateWorkItemField, string, string)

Perbarui bidang.

function updateField(payload: UpdateWorkItemField, fieldNameOrRefName: string, project?: string): Promise<WorkItemField>

Parameter

payload: UpdateWorkItemField

Payload berisi nilai yang diinginkan dari properti bidang

fieldNameOrRefName: string

Nama/nama referensi bidang yang akan diperbarui

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<WorkItemField>

updateQuery(QueryHierarchyItem, string, string, boolean)

Perbarui kueri atau folder. Ini memungkinkan Anda untuk memperbarui, mengganti nama, dan memindahkan kueri dan folder.

function updateQuery(queryUpdate: QueryHierarchyItem, project: string, query: string, undeleteDescendants?: boolean): Promise<QueryHierarchyItem>

Parameter

queryUpdate: QueryHierarchyItem

Kueri yang akan diperbarui.

project: string

ID proyek atau nama proyek

query: string

ID atau jalur untuk kueri yang akan diperbarui.

undeleteDescendants: boolean

Batalkan penghapusan turunan folder ini. Penting untuk dicatat bahwa ini tidak akan mengembalikan perubahan izin yang sebelumnya diterapkan pada keturunan.

Mengembalikan

Promise<QueryHierarchyItem>

updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)

Memperbarui satu item kerja.

function updateWorkItem(document: JsonPatchDocument, id: number, project?: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemExpand): Promise<WorkItem>

Parameter

document: JsonPatchDocument

Dokumen JSON Patch yang mewakili pembaruan

id: number

ID item kerja yang akan diperbarui

project: string

ID proyek atau nama proyek

validateOnly: boolean

Tunjukkan apakah Anda hanya ingin memvalidasi perubahan tanpa menyimpan item kerja

bypassRules: boolean

Jangan terapkan aturan jenis item kerja pada pembaruan ini

suppressNotifications: boolean

Jangan menembakkan pemberitahuan apa pun untuk perubahan ini

expand: WorkItemExpand

Perluas parameter untuk atribut item kerja. Opsi yang mungkin adalah { None, Relations, Fields, Links, All }.

Mengembalikan

Promise<WorkItem>

updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)

Menambahkan/memperbarui jenis item kerja

function updateWorkItemTypeDefinition(updateModel: WorkItemTypeTemplateUpdateModel, project?: string): Promise<ProvisioningResult>

Parameter

updateModel: WorkItemTypeTemplateUpdateModel

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<ProvisioningResult>

Saran dan Komentar

Apakah halaman ini membantu?

Bagikan melalui

WorkItemTrackingRestClient class

Konstruktor

Properti

Metode

Detail Konstruktor

WorkItemTrackingRestClient(IVssRestClientOptions)

Parameter

Detail Properti

RESOURCE_AREA_ID

Nilai Properti

Detail Metode

createAttachment(any, string, string, string, string)

Parameter

Mengembalikan

createField(WorkItemField, string)

Parameter

Mengembalikan

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Parameter

Mengembalikan

createQuery(QueryHierarchyItem, string, string, boolean)

Parameter

Mengembalikan

createTemplate(WorkItemTemplate, string, string)

Parameter

Mengembalikan

createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)

Parameter

Mengembalikan

deleteClassificationNode(string, TreeStructureGroup, string, number)

Parameter

Mengembalikan

deleteField(string, string)

Parameter

Mengembalikan

deleteQuery(string, string)

Parameter

Mengembalikan

deleteTemplate(string, string, string)

Parameter

Mengembalikan

deleteWorkItem(number, string, boolean)

Parameter

Mengembalikan

destroyWorkItem(number, string)

Parameter

Mengembalikan

exportWorkItemTypeDefinition(string, string, boolean)

Parameter

Mengembalikan

getAccountMyWorkData(QueryOption)

Parameter

Mengembalikan

getAttachmentContent(string, string, string, boolean)

Parameter

Mengembalikan

getAttachmentZip(string, string, string, boolean)

Parameter

Mengembalikan

getClassificationNode(string, TreeStructureGroup, string, number)

Parameter

Mengembalikan

getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)

Parameter

Mengembalikan

getComment(number, number, string)

Parameter

Mengembalikan

getComments(number, string, number, number, CommentSortOrder)

Parameter

Mengembalikan

getDeletedWorkItem(number, string)

Parameter

Mengembalikan

getDeletedWorkItems(number[], string)

Parameter

Mengembalikan

getDeletedWorkItemShallowReferences(string)

Parameter