WorkItemTrackingRestClient class
Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke API VSS REST
- Extends
| create |
Mengunggah lampiran. |
| create |
Buat bidang baru. |
| create |
Buat baru atau perbarui simpul klasifikasi yang sudah ada. |
| create |
Membuat kueri, atau memindahkan kueri. |
| create |
Membuat templat |
| create |
Membuat satu item kerja. |
| delete |
Menghapus simpul klasifikasi yang ada. |
| delete |
Menghapus bidang . Untuk membatalkan penghapusan file, lihat API "Perbarui Bidang". |
| delete |
Menghapus 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. |
| delete |
Menghapus templat dengan id yang diberikan |
| delete |
Menghapus item kerja yang ditentukan dan mengirimkannya ke Keranjang Sampah, sehingga dapat dipulihkan kembali, jika diperlukan. Secara opsional, jika parameter penghancurkan telah diatur ke true, parameter tersebut akan menghancurkan item kerja secara permanen. PERINGATAN: Jika parameter penghancuran diatur ke true, item kerja yang dihapus oleh perintah ini TIDAK akan masuk ke keranjang sampah dan tidak ada cara untuk memulihkan/memulihkannya setelah penghapusan. Disarankan UNTUK TIDAK menggunakan parameter ini. Jika anda melakukannya, silakan gunakan parameter ini dengan sangat hati-hati. |
| destroy |
Menghancurkan item kerja yang ditentukan secara permanen dari Keranjang Sampah. Tindakan ini tidak dapat dibatalkan. |
| export |
Mengekspor jenis item kerja |
| get |
HANYA INTERNAL: DIGUNAKAN OLEH AKUN HALAMAN KERJA SAYA. Ini mengembalikan detail item kerja Melakukan, Selesai, Mengikuti, dan aktivitas. |
| get |
Mengunduh lampiran. |
| get |
Mengunduh lampiran. |
| get |
Mendapatkan simpul klasifikasi untuk jalur simpul tertentu. |
| get |
Mendapatkan simpul klasifikasi akar atau daftar node 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 node klasifikasi root untuk proyek ini. |
| get |
Mendapatkan komentar untuk item kerja di revisi yang ditentukan. |
| get |
Mendapatkan jumlah komentar yang ditentukan untuk item kerja dari revisi yang ditentukan. |
| get |
Mendapatkan item kerja yang dihapus dari Keranjang Sampah. |
| get |
Mendapatkan item kerja dari keranjang sampah, yang ID-nya telah ditentukan dalam parameter |
| get |
Mendapatkan daftar ID dan URL item kerja yang dihapus di Keranjang Sampah. |
| get |
Mendapatkan informasi tentang bidang tertentu. |
| get |
Mengembalikan informasi untuk semua bidang. Parameter ID/nama proyek bersifat opsional. |
| get |
Mendapatkan kueri akar dan anak-anaknya |
| get |
Mendapatkan daftar kueri menurut id (Maksimum 1000) |
| get |
Mengambil kueri individual dan turunannya |
| get |
Mendapatkan hasil kueri yang diberikan ID kueri. |
| get |
Mendapatkan aktivitas item kerja terbaru |
| get |
HANYA INTERNAL: DIGUNAKAN OLEH AKUN HALAMAN KERJA SAYA. |
| get |
Mendapatkan definisi jenis relasi item kerja. |
| get |
Mendapatkan jenis relasi item kerja. |
| get |
Mendapatkan batch tautan item kerja |
| get |
Mengembalikan item kerja yang sepenuhnya terhidrasi untuk revisi yang diminta |
| get |
Mengembalikan daftar revisi item kerja yang sepenuhnya terhidrasi, yang di-paged. |
| get |
Mendapatkan simpul klasifikasi root di bawah proyek. |
| get |
Mendapatkan templat dengan id yang ditentukan |
| get |
Mendapatkan templat |
| get |
Mengembalikan satu pembaruan untuk item kerja |
| get |
Mengembalikan delta di antara revisi item kerja |
| get |
Dapatkan daftar jenis tautan artefak keluar pelacakan item kerja. |
| get |
Mengembalikan satu item kerja. |
| get |
Dapatkan ikon item kerja dengan nama dan warna ikon yang mudah diingat. |
| get |
Dapatkan daftar semua ikon item kerja. |
| get |
Dapatkan ikon item kerja dengan nama dan warna ikon yang mudah diingat. |
| get |
Dapatkan ikon item kerja dengan nama dan warna ikon yang mudah diingat. |
| get |
Mengembalikan status berikutnya pada ID item kerja yang diberikan. |
| get |
Mengembalikan daftar item kerja (Maksimum 200) |
| get |
Mendapatkan item kerja untuk daftar id item kerja (Maksimum 200) |
| get |
HANYA INTERNAL: Ini akan digunakan untuk pengalaman kerja akun saya. Mendapatkan warna status jenis item kerja untuk beberapa proyek |
| get |
Mengembalikan satu item kerja dari templat. |
| get |
Mengembalikan definisi jenis item kerja. |
| get |
Mendapatkan semua kategori jenis item kerja. |
| get |
Dapatkan kategori jenis item kerja tertentu menurut nama. |
| get |
HANYA INTERNAL: Ini digunakan untuk penyedia warna dan ikon. Mendapatkan warna jenis kecerdasan untuk beberapa proyek |
| get |
HANYA INTERNAL: Ini akan digunakan untuk pengalaman kerja akun saya. Mendapatkan warna jenis kecerdasan untuk beberapa proyek |
| get |
Dapatkan daftar bidang untuk jenis item kerja dengan referensi terperinci. |
| get |
Dapatkan bidang untuk jenis item kerja dengan referensi terperinci. |
| get |
Mengembalikan daftar jenis item kerja |
| get |
Mengembalikan nama dan warna status untuk tipe item kerja. |
| query |
Mendapatkan hasil kueri yang diberikan ID kueri. |
| query |
Mendapatkan hasil kueri yang diberikan WIQL-nya. |
| query |
Kueri item kerja yang ditautkan ke daftar URI artefak tertentu. |
| read |
Dapatkan batch revisi item kerja dengan opsi menyertakan item yang dihapus |
| read |
Dapatkan batch revisi item kerja. Permintaan ini dapat digunakan jika daftar bidang Anda cukup besar sehingga dapat menjalankan URL melebihi batas panjang. |
| replace |
Mengganti konten templat |
| restore |
Memulihkan item kerja yang dihapus dari Keranjang Sampah. |
| search |
Mencari semua kueri yang dapat diakses pengguna dalam proyek saat ini |
| send |
Metode RESTful untuk mengirim email untuk item kerja yang dipilih/dikueri. |
| update |
Perbarui simpul klasifikasi yang ada. |
| update |
Memperbarui bidang. |
| update |
Memperbarui kueri atau folder. Ini memungkinkan Anda memperbarui, mengganti nama, dan memindahkan kueri dan folder. |
| update |
Updates satu item kerja. |
| update |
Menambahkan/memperbarui jenis item kerja |
new WorkItemTrackingRestClient(options: IVssRestClientOptions)Parameter
- options
- IVssRestClientOptions
static RESOURCE_AREA_ID: stringNilai Properti
string
Mengunggah 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 Dipotong
- areaPath
-
string
Jalur Area proyek target
Mengembalikan
Promise<AttachmentReference>
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>
Buat baru atau perbarui simpul klasifikasi yang sudah ada.
function createOrUpdateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>Parameter
- postedNode
- WorkItemClassificationNode
Simpul untuk membuat atau memperbarui.
- project
-
string
ID proyek atau nama proyek
- structureGroup
- TreeStructureGroup
Grup struktur simpul klasifikasi, area, atau perulangan.
- path
-
string
Jalur simpul klasifikasi.
Mengembalikan
Promise<WorkItemClassificationNode>
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 tempat kueri akan dibuat.
- validateWiqlOnly
-
boolean
Jika Anda hanya ingin memvalidasi kueri WIQL tanpa benar-benar membuatnya, atur ke true. Defaultnya adalah false.
Mengembalikan
Promise<QueryHierarchyItem>
Membuat templat
function createTemplate(template: WorkItemTemplate, project: string, team: string): Promise<WorkItemTemplate>Parameter
- template
- WorkItemTemplate
Konten templat
- project
-
string
ID proyek atau nama proyek
- team
-
string
ID tim atau nama tim
Mengembalikan
Promise<WorkItemTemplate>
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 Patch JSON yang mewakili item kerja
- project
-
string
ID proyek atau nama proyek
- type
-
string
Tipe item kerja dari item kerja yang akan dibuat
- validateOnly
-
boolean
Menunjukkan apakah Anda hanya ingin memvalidasi perubahan tanpa menyimpan item kerja
- bypassRules
-
boolean
Jangan menerapkan aturan tipe item kerja pada pembaruan ini
- suppressNotifications
-
boolean
Jangan aktifkan pemberitahuan apa pun untuk perubahan ini
- expand
- WorkItemExpand
Parameter perluas untuk atribut item kerja. Opsi yang mungkin adalah { None, Relations, Fields, Links, All }.
Mengembalikan
Promise<WorkItem>
Menghapus 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
Grup struktur simpul klasifikasi, area, atau perulangan.
- path
-
string
Jalur simpul klasifikasi.
- reclassifyId
-
number
Id simpul klasifikasi target untuk reklasifikasi.
Mengembalikan
Promise<void>
Menghapus bidang . Untuk membatalkan penghapusan file, lihat API "Perbarui Bidang".
function deleteField(fieldNameOrRefName: string, project?: string): Promise<void>Parameter
- fieldNameOrRefName
-
string
Nama atau nama referensi bidang sederhana
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<void>
Menghapus 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>
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>
Menghapus item kerja yang ditentukan dan mengirimkannya ke Keranjang Sampah, sehingga dapat dipulihkan kembali, jika diperlukan. Secara opsional, jika parameter penghancurkan telah diatur ke true, parameter tersebut akan menghancurkan item kerja secara permanen. PERINGATAN: Jika parameter penghancuran diatur ke true, item kerja yang dihapus oleh perintah ini TIDAK akan masuk ke keranjang sampah dan tidak ada cara untuk memulihkan/memulihkannya setelah penghapusan. Disarankan UNTUK TIDAK menggunakan parameter ini. Jika anda melakukannya, silakan 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 penghancurkan bersifat PERMANEN dan tidak dapat dibatalkan.
Mengembalikan
Promise<WorkItemDelete>
Menghancurkan item kerja yang ditentukan secara permanen dari Keranjang Sampah. 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>
Mengekspor 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>
HANYA INTERNAL: DIGUNAKAN OLEH AKUN HALAMAN KERJA SAYA. Ini mengembalikan detail item kerja Melakukan, Selesai, Mengikuti, dan aktivitas.
function getAccountMyWorkData(queryOption?: QueryOption): Promise<AccountMyWorkResult>Parameter
- queryOption
- QueryOption
Mengembalikan
Promise<AccountMyWorkResult>
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>
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>
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
Grup struktur simpul klasifikasi, area, atau perulangan.
- path
-
string
Jalur simpul klasifikasi.
- depth
-
number
Kedalaman anak-anak untuk diambil.
Mengembalikan
Promise<WorkItemClassificationNode>
Mendapatkan simpul klasifikasi akar atau daftar node 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 node klasifikasi root 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 klasifikasi bilangan bulat yang dipisahkan koma. Ini tidak diperlukan, jika Anda menginginkan simpul akar.
- depth
-
number
Kedalaman anak-anak untuk diambil.
- errorPolicy
- ClassificationNodesErrorPolicy
Benderai untuk menangani kesalahan dalam mendapatkan beberapa simpul. Opsi yang mungkin adalah Gagal dan Hilangkan.
Mengembalikan
Promise<WorkItemClassificationNode[]>
Mendapatkan komentar untuk item kerja di 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>
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 turun dengan id revisi (defaultnya adalah naik)
Mengembalikan
Promise<WorkItemComments>
Mendapatkan item kerja yang dihapus dari Keranjang Sampah.
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>
Mendapatkan item kerja dari keranjang 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 dihapus untuk dikembalikan
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<WorkItemDeleteReference[]>
Mendapatkan daftar ID dan URL item kerja yang dihapus di Keranjang Sampah.
function getDeletedWorkItemShallowReferences(project?: string): Promise<WorkItemDeleteShallowReference[]>Parameter
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<WorkItemDeleteShallowReference[]>
Mendapatkan informasi tentang bidang tertentu.
function getField(fieldNameOrRefName: string, project?: string): Promise<WorkItemField>Parameter
- fieldNameOrRefName
-
string
Nama atau nama referensi bidang sederhana
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<WorkItemField>
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[]>
Mendapatkan kueri akar dan anak-anaknya
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
Di folder kueri, kembalikan kueri dan folder anak ke kedalaman ini.
- includeDeleted
-
boolean
Sertakan kueri dan folder yang dihapus
Mengembalikan
Promise<QueryHierarchyItem[]>
Mendapatkan daftar kueri menurut id (Maksimum 1000)
function getQueriesBatch(queryGetRequest: QueryBatchGetRequest, project: string): Promise<QueryHierarchyItem[]>Parameter
- queryGetRequest
- QueryBatchGetRequest
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<QueryHierarchyItem[]>
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
Di folder kueri, kembalikan kueri dan folder anak 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>
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>
Mendapatkan aktivitas item kerja terbaru
function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>Mengembalikan
Promise<AccountRecentActivityWorkItemModel2[]>
HANYA INTERNAL: DIGUNAKAN OLEH AKUN HALAMAN KERJA SAYA.
function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>Mengembalikan
Promise<AccountRecentMentionWorkItemModel[]>
Mendapatkan definisi jenis relasi item kerja.
function getRelationType(relation: string): Promise<WorkItemRelationType>Parameter
- relation
-
string
Nama relasi
Mengembalikan
Promise<WorkItemRelationType>
Mendapatkan jenis relasi item kerja.
function getRelationTypes(): Promise<WorkItemRelationType[]>Mengembalikan
Promise<WorkItemRelationType[]>
Mendapatkan batch 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 batch 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 dikembalikan. Tidak dapat digunakan bersama dengan parameter 'marka air'.
Mengembalikan
Promise<ReportingWorkItemLinksBatch>
Mengembalikan item kerja yang sepenuhnya terhidrasi 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>
Mengembalikan daftar revisi item kerja yang sepenuhnya terhidrasi, yang di-paged.
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[]>
Mendapatkan simpul klasifikasi root 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 diambil.
Mengembalikan
Promise<WorkItemClassificationNode[]>
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>
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 Pekerjaan tertentu.
Mengembalikan
Promise<WorkItemTemplateReference[]>
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>
Mengembalikan delta di 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[]>
Dapatkan daftar jenis tautan artefak keluar pelacakan item kerja.
function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>Mengembalikan
Promise<WorkArtifactLink[]>
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
String waktu tanggal AsOf UTC
- expand
- WorkItemExpand
Parameter perluas untuk atribut item kerja. Opsi yang mungkin adalah { None, Relations, Fields, Links, All }.
Mengembalikan
Promise<WorkItem>
Dapatkan ikon item kerja dengan nama dan warna ikon yang mudah diingat.
function getWorkItemIconJson(icon: string, color?: string, v?: number): Promise<WorkItemIcon>Parameter
- icon
-
string
Nama ikon
- color
-
string
Warna heksa 6 digit untuk ikon
- v
-
number
Versi ikon (hanya digunakan untuk pembatalan pembatalan cache)
Mengembalikan
Promise<WorkItemIcon>
Dapatkan daftar semua ikon item kerja.
function getWorkItemIcons(): Promise<WorkItemIcon[]>Mengembalikan
Promise<WorkItemIcon[]>
Dapatkan ikon item kerja dengan nama dan warna ikon yang mudah diingat.
function getWorkItemIconSvg(icon: string, color?: string, v?: number): Promise<any>Parameter
- icon
-
string
Nama ikon
- color
-
string
Warna heksa 6 digit untuk ikon
- v
-
number
Versi ikon (hanya digunakan untuk pembatalan pembatalan cache)
Mengembalikan
Promise<any>
Dapatkan ikon item kerja dengan nama dan warna ikon yang mudah diingat.
function getWorkItemIconXaml(icon: string, color?: string, v?: number): Promise<any>Parameter
- icon
-
string
Nama ikon
- color
-
string
Warna heksa 6 digit untuk ikon
- v
-
number
Versi ikon (hanya digunakan untuk pembatalan pembatalan cache)
Mengembalikan
Promise<any>
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
kemungkinan tindakan. Saat ini hanya mendukung checkin
Mengembalikan
Promise<WorkItemNextStateOnTransition[]>
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 diminta yang dipisahkan koma. (Maksimum 200 id yang diizinkan).
- project
-
string
ID proyek atau nama proyek
- fields
-
string[]
Daftar bidang yang diminta yang dipisahkan koma
- asOf
-
Date
String waktu tanggal AsOf UTC
- expand
- WorkItemExpand
Parameter perluas untuk atribut item kerja. Opsi yang mungkin adalah { None, Relations, Fields, Links, All }.
- errorPolicy
- WorkItemErrorPolicy
Bendera untuk mengontrol kebijakan kesalahan dalam permintaan dapatkan item kerja secara massal. Opsi yang mungkin adalah {Fail, Omit}.
Mengembalikan
Promise<WorkItem[]>
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[]>
HANYA INTERNAL: Ini akan digunakan untuk pengalaman kerja akun saya. Mendapatkan warna status jenis item kerja untuk beberapa proyek
function getWorkItemStateColors(projectNames: string[]): Promise<ProjectWorkItemStateColors[]>Parameter
- projectNames
-
string[]
Mengembalikan
Promise<ProjectWorkItemStateColors[]>
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
String waktu tanggal AsOf UTC
- expand
- WorkItemExpand
Parameter perluas untuk atribut item kerja. Opsi yang mungkin adalah { None, Relations, Fields, Links, All }.
Mengembalikan
Promise<WorkItem>
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>
Mendapatkan semua kategori jenis item kerja.
function getWorkItemTypeCategories(project: string): Promise<WorkItemTypeCategory[]>Parameter
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<WorkItemTypeCategory[]>
Dapatkan kategori jenis item kerja tertentu menurut nama.
function getWorkItemTypeCategory(project: string, category: string): Promise<WorkItemTypeCategory>Parameter
- project
-
string
ID proyek atau nama proyek
- category
-
string
Nama kategori
Mengembalikan
Promise<WorkItemTypeCategory>
HANYA INTERNAL: Ini digunakan untuk penyedia warna dan ikon. Mendapatkan warna jenis kecerdasan untuk beberapa proyek
function getWorkItemTypeColorAndIcons(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>Parameter
- projectNames
-
string[]
Mengembalikan
Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>
HANYA INTERNAL: Ini akan digunakan untuk pengalaman kerja akun saya. Mendapatkan warna jenis kecerdasan untuk beberapa proyek
function getWorkItemTypeColors(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColor[] }[]>Parameter
- projectNames
-
string[]
Mengembalikan
Promise<{ key: string, value: WorkItemTypeColor[] }[]>
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.
Perluas tingkat untuk respons API. Properti: untuk menyertakan nilai yang diizinkan, nilai default, isRequired dll. sebagai bagian dari respons; Tidak ada: untuk melewati properti ini.
Mengembalikan
Promise<WorkItemTypeFieldWithReferences[]>
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
Perluas tingkat untuk respons API. Properti: untuk menyertakan nilai yang diizinkan, nilai default, isRequired dll. sebagai bagian dari respons; Tidak ada: untuk melewati properti ini.
Mengembalikan
Promise<WorkItemTypeFieldWithReferences>
Mengembalikan daftar jenis item kerja
function getWorkItemTypes(project: string): Promise<WorkItemType[]>Parameter
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<WorkItemType[]>
Mengembalikan nama dan warna status untuk tipe item kerja.
function getWorkItemTypeStates(project: string, type: string): Promise<WorkItemStateColor[]>Parameter
- project
-
string
ID proyek atau nama proyek
- type
-
string
Nama status
Mengembalikan
Promise<WorkItemStateColor[]>
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>
Mendapatkan hasil kueri yang diberikan 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>
Kueri 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 batch 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 marka air untuk memulai batch. Hilangkan parameter ini untuk mendapatkan batch revisi pertama.
- startDateTime
-
Date
Tanggal/waktu untuk digunakan sebagai titik awal untuk revisi, semua revisi akan terjadi setelah tanggal/waktu ini. Tidak dapat digunakan bersama dengan parameter 'marka air'.
- 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 tersebut, 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 batch revisi item kerja. Permintaan ini dapat digunakan jika daftar bidang Anda cukup besar sehingga dapat menjalankan URL melebihi batas panjang.
function readReportingRevisionsPost(filter: ReportingWorkItemRevisionsFilter, project?: string, continuationToken?: string, startDateTime?: Date, expand?: ReportingRevisionsExpand): Promise<ReportingWorkItemRevisionsBatch>Parameter
Objek yang berisi pengaturan permintaan: filter bidang, filter jenis, format identitas
- project
-
string
ID proyek atau nama proyek
- continuationToken
-
string
Menentukan marka air untuk memulai batch. Hilangkan parameter ini untuk mendapatkan batch revisi pertama.
- startDateTime
-
Date
Tanggal/waktu untuk digunakan sebagai titik awal untuk revisi, semua revisi akan terjadi setelah tanggal/waktu ini. Tidak dapat digunakan bersama dengan parameter 'marka air'.
- expand
- ReportingRevisionsExpand
Mengembalikan
Promise<ReportingWorkItemRevisionsBatch>
Mengganti konten templat
function replaceTemplate(templateContent: WorkItemTemplate, project: string, team: string, templateId: string): Promise<WorkItemTemplate>Parameter
- templateContent
- WorkItemTemplate
Konten templat untuk diganti dengan
- project
-
string
ID proyek atau nama proyek
- team
-
string
ID tim atau nama tim
- templateId
-
string
Id templat
Mengembalikan
Promise<WorkItemTemplate>
Memulihkan item kerja yang dihapus dari Keranjang Sampah.
function restoreWorkItem(payload: WorkItemDeleteUpdate, id: number, project?: string): Promise<WorkItemDelete>Parameter
- payload
- WorkItemDeleteUpdate
Paylod dengan instruksi untuk memperbarui bendera IsDeleted ke false
- id
-
number
ID item kerja yang akan dipulihkan
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<WorkItemDelete>
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 (Defaultnya adalah 50 dan maksimum adalah 200).
- expand
- QueryExpand
- includeDeleted
-
boolean
Sertakan kueri dan folder yang dihapus
Mengembalikan
Promise<QueryHierarchyItemsResult>
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>
Perbarui simpul klasifikasi yang ada.
function updateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>Parameter
- postedNode
- WorkItemClassificationNode
Simpul untuk membuat atau memperbarui.
- project
-
string
ID proyek atau nama proyek
- structureGroup
- TreeStructureGroup
Grup struktur simpul klasifikasi, area, atau perulangan.
- path
-
string
Jalur simpul klasifikasi.
Mengembalikan
Promise<WorkItemClassificationNode>
Memperbarui bidang.
function updateField(payload: UpdateWorkItemField, fieldNameOrRefName: string, project?: string): Promise<WorkItemField>Parameter
- payload
- UpdateWorkItemField
Payload berisi nilai properti bidang yang diinginkan
- fieldNameOrRefName
-
string
Nama/nama referensi bidang yang akan diperbarui
- project
-
string
ID proyek atau nama proyek
Mengembalikan
Promise<WorkItemField>
Memperbarui kueri atau folder. Ini memungkinkan Anda 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
Batal hapus turunan folder ini. Penting untuk dicatat bahwa ini tidak akan mengembalikan perubahan izin yang sebelumnya diterapkan pada turunan.
Mengembalikan
Promise<QueryHierarchyItem>
Updates 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 Patch JSON yang mewakili pembaruan
- id
-
number
Id item kerja yang akan diperbarui
- project
-
string
ID proyek atau nama proyek
- validateOnly
-
boolean
Menunjukkan apakah Anda hanya ingin memvalidasi perubahan tanpa menyimpan item kerja
- bypassRules
-
boolean
Jangan menerapkan aturan tipe item kerja pada pembaruan ini
- suppressNotifications
-
boolean
Jangan aktifkan pemberitahuan apa pun untuk perubahan ini
- expand
- WorkItemExpand
Parameter perluas untuk atribut item kerja. Opsi yang mungkin adalah { None, Relations, Fields, Links, All }.
Mengembalikan
Promise<WorkItem>
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>