WorkItemTrackingRestClient class

Paket:: azure-devops-extension-api

VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf

Extends: RestClientBase

Oluşturucular

WorkItemTrackingRestClient(IVssRestClientOptions)

Özellikler

Yöntemler

createAttachment(any, string, string, string, string)	Eki karşıya yükler.
createField(WorkItemField, string)	Yeni bir alan oluşturun.
createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Yeni bir sınıflandırma düğümü oluşturun veya mevcut bir sınıflandırma düğümünü güncelleştirin.
createQuery(QueryHierarchyItem, string, string, boolean)	Sorgu oluşturur veya sorguyu taşır.
createTemplate(WorkItemTemplate, string, string)	Şablon oluşturur
createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)	Tek bir iş öğesi oluşturur.
deleteClassificationNode(string, TreeStructureGroup, string, number)	Var olan bir sınıflandırma düğümünü silin.
deleteField(string, string)	Alanı siler. Dosyalanmış bir dosyayı geri almak için bkz. "Alanı Güncelleştirme" API'si.
deleteQuery(string, string)	Sorguyu veya klasörü silin. Bu, silinen sorgu veya klasördeki tüm izin değişikliklerini ve klasör ise alt öğelerinden herhangi birini siler. Silinen izin değişikliklerinin, sorgu veya klasör silindikten sonra kurtarılamayacağını unutmayın.
deleteTemplate(string, string, string)	Verilen kimlikle şablonu siler
deleteWorkItem(number, string, boolean)	Belirtilen iş öğesini siler ve gerekirse geri yüklenebilmesi için Geri Dönüşüm Kutusu'na gönderir. İsteğe bağlı olarak, destroy parametresi true olarak ayarlandıysa, iş öğesini kalıcı olarak yok eder. UYARI: Destroy parametresi true olarak ayarlanırsa, bu komutla silinen iş öğeleri geri dönüşüm kutusuna GİDERİlMEYECEK ve silme işleminden sonra bunları geri yükleme/kurtarmanın hiçbir yolu yoktur. Bu parametrenin kullanılmaması önerilir. Bunu yaparsanız, lütfen bu parametreyi çok dikkatli kullanın.
destroyWorkItem(number, string)	Belirtilen iş öğesini Geri Dönüşüm Kutusu'ndan kalıcı olarak yok eder. Bu eylem geri alınamaz.
exportWorkItemTypeDefinition(string, string, boolean)	İş öğesi türünü dışarı aktarma
getAccountMyWorkData(QueryOption)	YALNıZCA DAHILI: İŞ SAYFAM HESABı TARAFıNDAN KULLANıLıR. Bu işlem, Yapılıyor, Bitti, Takip Ediyor ve etkinlik iş öğeleri ayrıntılarını döndürür.
getAttachmentContent(string, string, string, boolean)	Eki indirir.
getAttachmentZip(string, string, string, boolean)	Eki indirir.
getClassificationNode(string, TreeStructureGroup, string, number)	Belirli bir düğüm yolu için sınıflandırma düğümünü alır.
getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)	Belirli bir proje için belirli bir düğüm kimlik listesi için kök sınıflandırma düğümlerini veya sınıflandırma düğümlerinin listesini alır. Ids parametresinin sağlanması durumunda bu kimlikler için sınıflandırma düğümlerinin listesini alırsınız. Aksi takdirde bu proje için kök sınıflandırma düğümleri alırsınız.
getComment(number, number, string)	Belirtilen düzeltmede bir iş öğesi için açıklama alır.
getComments(number, string, number, number, CommentSortOrder)	Belirtilen düzeltmeden bir iş öğesi için belirtilen sayıda açıklama alır.
getDeletedWorkItem(number, string)	Geri Dönüşüm Kutusu'ndan silinen bir iş öğesini alır.
getDeletedWorkItems(number[], string)	Parametrelerde kimlikleri belirtilmiş olan geri dönüşüm kutusundan iş öğelerini alır
getDeletedWorkItemShallowReferences(string)	Geri Dönüşüm Kutusu'nda silinen iş öğelerinin kimliklerinin ve URL'lerinin listesini alır.
getField(string, string)	Belirli bir alanla ilgili bilgileri alır.
getFields(string, GetFieldsExpand)	Tüm alanlar için bilgileri döndürür. Proje kimliği/adı parametresi isteğe bağlıdır.
getQueries(string, QueryExpand, number, boolean)	Kök sorguları ve alt öğelerini alır
getQueriesBatch(QueryBatchGetRequest, string)	Kimliklere göre sorguların listesini alır (En fazla 1000)
getQuery(string, string, QueryExpand, number, boolean, boolean)	Tek bir sorguyu ve alt öğelerini alır
getQueryResultCount(string, string, string, boolean, number)	Sorgu kimliğine göre sorgunun sonuçlarını alır.
getRecentActivityData()	Son iş öğesi etkinliklerini alır
getRecentMentions()	YALNıZCA DAHILI: İŞ SAYFAM HESABı TARAFıNDAN KULLANıLıR.
getRelationType(string)	İş öğesi ilişki türü tanımını alır.
getRelationTypes()	İş öğesi ilişki türlerini alır.
getReportingLinksByLinkType(string, string[], string[], string, Date)	İş öğesi bağlantılarını toplu alma
getRevision(number, number, string, WorkItemExpand)	İstenen düzeltme için tam olarak nemlendirilmiş bir iş öğesi döndürür
getRevisions(number, string, number, number, WorkItemExpand)	Sayfalanmış, tam olarak nemlendirilmiş iş öğesi düzeltmelerinin listesini döndürür.
getRootNodes(string, number)	Projenin altındaki kök sınıflandırma düğümlerini alır.
getTemplate(string, string, string)	Belirtilen kimlikle şablonu alır
getTemplates(string, string, string)	Şablonu alır
getUpdate(number, number, string)	İş öğesi için tek bir güncelleştirme döndürür
getUpdates(number, string, number, number)	İş öğesi düzeltmeleri arasındaki değişimleri verir
getWorkArtifactLinkTypes()	Giden yapıt bağlantı türlerini izleyen iş öğesi listesini alın.
getWorkItem(number, string, string[], Date, WorkItemExpand)	Tek bir iş öğesi döndürür.
getWorkItemIconJson(string, string, number)	Kolay ad ve simge rengi verilen bir iş öğesi simgesi alın.
getWorkItemIcons()	Tüm iş öğesi simgelerinin listesini alın.
getWorkItemIconSvg(string, string, number)	Kolay ad ve simge rengi verilen bir iş öğesi simgesi alın.
getWorkItemIconXaml(string, string, number)	Kolay ad ve simge rengi verilen bir iş öğesi simgesi alın.
getWorkItemNextStatesOnCheckinAction(number[], string)	Verilen iş öğesi kimliklerinde sonraki durumu döndürür.
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)	İş öğelerinin listesini döndürür (En fazla 200)
getWorkItemsBatch(WorkItemBatchGetRequest, string)	İş öğesi kimlikleri listesi için iş öğelerini alır (En fazla 200)
getWorkItemStateColors(string[])	YALNIZCA İçERİ: Hesabım iş deneyimi için kullanılacaktır. Birden çok proje için iş öğesi türü durum rengini alma
getWorkItemTemplate(string, string, string, Date, WorkItemExpand)	Şablondan tek bir iş öğesi döndürür.
getWorkItemType(string, string)	İş öğesi türü tanımını döndürür.
getWorkItemTypeCategories(string)	Tüm iş öğesi türü kategorilerini alın.
getWorkItemTypeCategory(string, string)	Ada göre belirli iş öğesi türü kategorisini alın.
getWorkItemTypeColorAndIcons(string[])	YALNIZCA İç: Renk ve simge sağlayıcıları için kullanılır. Birden çok proje için wit türü rengini alma
getWorkItemTypeColors(string[])	YALNIZCA İçERİ: Hesabım iş deneyimi için kullanılacaktır. Birden çok proje için wit türü rengini alma
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)	Ayrıntılı başvurular içeren bir iş öğesi türü için alanların listesini alın.
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)	Ayrıntılı başvurular içeren bir iş öğesi türü için alan alın.
getWorkItemTypes(string)	İş öğesi türlerinin listesini döndürür
getWorkItemTypeStates(string, string)	bir iş öğesi türünün durum adlarını ve renklerini döndürür.
queryById(string, string, string, boolean, number)	Sorgu kimliğine göre sorgunun sonuçlarını alır.
queryByWiql(Wiql, string, string, boolean, number)	WIQL'i göz önüne alındığında sorgunun sonuçlarını alır.
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)	Belirli bir yapıt URI'sine bağlı iş öğelerini sorgular.
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)	Silinmiş öğeleri ekleme seçeneğiyle bir grup iş öğesi düzeltmesi alma
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)	Bir grup iş öğesi düzeltmesi alın. Alan listeniz URL'yi uzunluk sınırı üzerinden çalıştırabilecek kadar büyükse bu istek kullanılabilir.
replaceTemplate(WorkItemTemplate, string, string, string)	Şablon içeriğini değiştirme
restoreWorkItem(WorkItemDeleteUpdate, number, string)	Silinen iş öğesini Geri Dönüşüm Kutusu'ndan geri yükler.
searchQueries(string, string, number, QueryExpand, boolean)	Kullanıcının geçerli projede erişimi olan tüm sorguları arar
sendMail(SendMailBody, string)	Seçili/sorgulanan iş öğeleri için posta göndermek için RESTful yöntemi.
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Mevcut bir sınıflandırma düğümünü güncelleştirin.
updateField(UpdateWorkItemField, string, string)	Bir alanı güncelleştirin.
updateQuery(QueryHierarchyItem, string, string, boolean)	Sorguyu veya klasörü güncelleştirin. Bu, sorguları ve klasörleri güncelleştirmenize, yeniden adlandırmanıza ve taşımanıza olanak tanır.
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)	Tek bir iş öğesini güncelleştirir.
updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)	İş öğesi türü ekleme/güncelleştirme

Oluşturucu Ayrıntıları

WorkItemTrackingRestClient(IVssRestClientOptions)

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

Parametreler

options: IVssRestClientOptions

Özellik Ayrıntıları

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Özellik Değeri

string

Yöntem Ayrıntıları

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

Eki karşıya yükler.

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

Parametreler

content: any

Karşıya yüklenecek içerik

project: string

Proje kimliği veya proje adı

fileName: string

Dosyanın adı

uploadType: string

Ek karşıya yükleme türü: Basit veya Öbekli

areaPath: string

Hedef proje Alan Yolu

Döndürülenler

Promise<AttachmentReference>

createField(WorkItemField, string)

Yeni bir alan oluşturun.

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

Parametreler

workItemField: WorkItemField

Yeni alan tanımı

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<WorkItemField>

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Yeni bir sınıflandırma düğümü oluşturun veya mevcut bir sınıflandırma düğümünü güncelleştirin.

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

Parametreler

postedNode: WorkItemClassificationNode

Oluşturulacak veya güncelleştirilecek düğüm.

project: string

Proje kimliği veya proje adı

structureGroup: TreeStructureGroup

Sınıflandırma düğümünün, alanın veya yinelemenin yapı grubu.

path: string

Sınıflandırma düğümünün yolu.

Döndürülenler

Promise<WorkItemClassificationNode>

createQuery(QueryHierarchyItem, string, string, boolean)

Sorgu oluşturur veya sorguyu taşır.

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

Parametreler

postedQuery: QueryHierarchyItem

Oluşturulacak sorgu.

project: string

Proje kimliği veya proje adı

query: string

Sorgunun oluşturulacağı üst kimlik veya yol.

validateWiqlOnly: boolean

WIQL sorgunuzu gerçekten oluşturmadan doğrulamak istiyorsanız, bunu true olarak ayarlayın. Varsayılan değer false'tur.

Döndürülenler

Promise<QueryHierarchyItem>

createTemplate(WorkItemTemplate, string, string)

Şablon oluşturur

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

Parametreler

template: WorkItemTemplate

Şablon içeriği

project: string

Proje kimliği veya proje adı

team: string

Ekip kimliği veya ekip adı

Döndürülenler

Promise<WorkItemTemplate>

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

Tek bir iş öğesi oluşturur.

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

Parametreler

document: JsonPatchDocument

İş öğesini temsil eden JSON Düzeltme Eki belgesi

project: string

Proje kimliği veya proje adı

type: string

Oluşturulacak iş öğesinin iş öğesi türü

validateOnly: boolean

İş öğesini kaydetmeden yalnızca değişiklikleri doğrulamak isteyip istemediğinizi belirtin

bypassRules: boolean

Bu güncelleştirmede iş öğesi türü kurallarını zorunlu kılma

suppressNotifications: boolean

Bu değişiklik için hiçbir bildirim tetiklemayın

expand: WorkItemExpand

İş öğesi öznitelikleri için genişletme parametreleri. Olası seçenekler şunlardır: { Yok, İlişkiler, Alanlar, Bağlantılar, Tümü }.

Döndürülenler

Promise<WorkItem>

deleteClassificationNode(string, TreeStructureGroup, string, number)

Var olan bir sınıflandırma düğümünü silin.

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

Parametreler

project: string

Proje kimliği veya proje adı

structureGroup: TreeStructureGroup

Sınıflandırma düğümünün, alanın veya yinelemenin yapı grubu.

path: string

Sınıflandırma düğümünün yolu.

reclassifyId: number

Yeniden sınıflandırma için hedef sınıflandırma düğümünün kimliği.

Döndürülenler

Promise<void>

deleteField(string, string)

Alanı siler. Dosyalanmış bir dosyayı geri almak için bkz. "Alanı Güncelleştirme" API'si.

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

Parametreler

fieldNameOrRefName: string

Alan basit adı veya başvuru adı

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<void>

deleteQuery(string, string)

Sorguyu veya klasörü silin. Bu, silinen sorgu veya klasördeki tüm izin değişikliklerini ve klasör ise alt öğelerinden herhangi birini siler. Silinen izin değişikliklerinin, sorgu veya klasör silindikten sonra kurtarılamayacağını unutmayın.

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

Parametreler

project: string

Proje kimliği veya proje adı

query: string

Silinecek sorgunun veya klasörün kimliği veya yolu.

Döndürülenler

Promise<void>

deleteTemplate(string, string, string)

Verilen kimlikle şablonu siler

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

Parametreler

project: string

Proje kimliği veya proje adı

team: string

Ekip kimliği veya ekip adı

templateId: string

Şablon kimliği

Döndürülenler

Promise<void>

deleteWorkItem(number, string, boolean)

Belirtilen iş öğesini siler ve gerekirse geri yüklenebilmesi için Geri Dönüşüm Kutusu'na gönderir. İsteğe bağlı olarak, destroy parametresi true olarak ayarlandıysa, iş öğesini kalıcı olarak yok eder. UYARI: Destroy parametresi true olarak ayarlanırsa, bu komutla silinen iş öğeleri geri dönüşüm kutusuna GİDERİlMEYECEK ve silme işleminden sonra bunları geri yükleme/kurtarmanın hiçbir yolu yoktur. Bu parametrenin kullanılmaması önerilir. Bunu yaparsanız, lütfen bu parametreyi çok dikkatli kullanın.

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

Parametreler

id: number

Silinecek iş öğesinin kimliği

project: string

Proje kimliği veya proje adı

destroy: boolean

İsteğe bağlı parametresi true olarak ayarlanırsa, iş öğesi kalıcı olarak silinir. Lütfen unutmayın: Yok etme eylemi KALICIdır ve geri alınamaz.

Döndürülenler

Promise<WorkItemDelete>

destroyWorkItem(number, string)

Belirtilen iş öğesini Geri Dönüşüm Kutusu'ndan kalıcı olarak yok eder. Bu eylem geri alınamaz.

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

Parametreler

id: number

Kalıcı olarak yok edilecek iş öğesinin kimliği

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<void>

exportWorkItemTypeDefinition(string, string, boolean)

İş öğesi türünü dışarı aktarma

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

Parametreler

project: string

Proje kimliği veya proje adı

type: string

exportGlobalLists: boolean

Döndürülenler

Promise<WorkItemTypeTemplate>

getAccountMyWorkData(QueryOption)

YALNıZCA DAHILI: İŞ SAYFAM HESABı TARAFıNDAN KULLANıLıR. Bu işlem, Yapılıyor, Bitti, Takip Ediyor ve etkinlik iş öğeleri ayrıntılarını döndürür.

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

Parametreler

queryOption: QueryOption

Döndürülenler

Promise<AccountMyWorkResult>

getAttachmentContent(string, string, string, boolean)

Eki indirir.

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

Parametreler

id: string

Ek Kimliği

project: string

Proje kimliği veya proje adı

fileName: string

Dosyanın adı

download: boolean

<c>true</c olarak ayarlanırsa> her zaman eki indirin

Döndürülenler

Promise<ArrayBuffer>

getAttachmentZip(string, string, string, boolean)

Eki indirir.

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

Parametreler

id: string

Ek Kimliği

project: string

Proje kimliği veya proje adı

fileName: string

Dosyanın adı

download: boolean

<c>true</c olarak ayarlanırsa> her zaman eki indirin

Döndürülenler

Promise<ArrayBuffer>

getClassificationNode(string, TreeStructureGroup, string, number)

Belirli bir düğüm yolu için sınıflandırma düğümünü alır.

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

Parametreler

project: string

Proje kimliği veya proje adı

structureGroup: TreeStructureGroup

Sınıflandırma düğümünün, alanın veya yinelemenin yapı grubu.

path: string

Sınıflandırma düğümünün yolu.

depth: number

Getirilecek çocukların derinliği.

Döndürülenler

Promise<WorkItemClassificationNode>

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

Belirli bir proje için belirli bir düğüm kimlik listesi için kök sınıflandırma düğümlerini veya sınıflandırma düğümlerinin listesini alır. Ids parametresinin sağlanması durumunda bu kimlikler için sınıflandırma düğümlerinin listesini alırsınız. Aksi takdirde bu proje için kök sınıflandırma düğümleri alırsınız.

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

Parametreler

project: string

Proje kimliği veya proje adı

ids: number[]

Virgülle ayrılmış tamsayı sınıflandırma düğümleri kimlikleri. Kök düğümler istiyorsanız bu gerekli değildir.

depth: number

Getirilecek çocukların derinliği.

errorPolicy: ClassificationNodesErrorPolicy

Bazı düğümleri alma hatalarını işlemek için bayrak ekleyin. Olası seçenekler Başarısız ve Atla'dır.

Döndürülenler

Promise<WorkItemClassificationNode[]>

getComment(number, number, string)

Belirtilen düzeltmede bir iş öğesi için açıklama alır.

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

Parametreler

id: number

İş öğesi kimliği

revision: number

Açıklamanın alınması gereken düzeltme

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<WorkItemComment>

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

Belirtilen düzeltmeden bir iş öğesi için belirtilen sayıda açıklama alır.

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

Parametreler

id: number

İş öğesi kimliği

project: string

Proje kimliği veya proje adı

fromRevision: number

Açıklamaların getirileceği düzeltme (varsayılan değer 1'dir)

top: number

Döndürülecek açıklama sayısı (varsayılan değer 200'dür)

order: CommentSortOrder

Düzeltme kimliğine göre artan veya azalan (varsayılan değer artandır)

Döndürülenler

Promise<WorkItemComments>

getDeletedWorkItem(number, string)

Geri Dönüşüm Kutusu'ndan silinen bir iş öğesini alır.

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

Parametreler

id: number

Döndürülecek iş öğesinin kimliği

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<WorkItemDelete>

getDeletedWorkItems(number[], string)

Parametrelerde kimlikleri belirtilmiş olan geri dönüşüm kutusundan iş öğelerini alır

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

Parametreler

ids: number[]

Döndürülecek silinmiş iş öğelerinin virgülle ayrılmış kimlik listesi

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<WorkItemDeleteReference[]>

getDeletedWorkItemShallowReferences(string)

Geri Dönüşüm Kutusu'nda silinen iş öğelerinin kimliklerinin ve URL'lerinin listesini alır.

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

Parametreler

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<WorkItemDeleteShallowReference[]>

getField(string, string)

Belirli bir alanla ilgili bilgileri alır.

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

Parametreler

fieldNameOrRefName: string

Alan basit adı veya başvuru adı

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

Tüm alanlar için bilgileri döndürür. Proje kimliği/adı parametresi isteğe bağlıdır.

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

Parametreler

project: string

Proje kimliği veya proje adı

expand: GetFieldsExpand

Uzantı alanlarını dahil etmek için ExtensionFields kullanın, aksi takdirde bunları hariç tutun. Bu parametrenin özellik bayrağı etkinleştirilmediği sürece uzantı alanları her zaman eklenir.

Döndürülenler

Promise<WorkItemField[]>

getQueries(string, QueryExpand, number, boolean)

Kök sorguları ve alt öğelerini alır

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

Parametreler

project: string

Proje kimliği veya proje adı

expand: QueryExpand

Sonuçlara sorgu dizesini (wiql), yan tümceleri, sorgu sonucu sütunlarını ve sıralama seçeneklerini ekleyin.

depth: number

Sorgular klasöründe alt sorguları ve klasörleri bu derinliğe döndür.

includeDeleted: boolean

Silinen sorguları ve klasörleri dahil et

Döndürülenler

Promise<QueryHierarchyItem[]>

getQueriesBatch(QueryBatchGetRequest, string)

Kimliklere göre sorguların listesini alır (En fazla 1000)

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

Parametreler

queryGetRequest: QueryBatchGetRequest

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<QueryHierarchyItem[]>

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

Tek bir sorguyu ve alt öğelerini alır

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

Parametreler

project: string

Proje kimliği veya proje adı

query: string

Sorgunun kimliği veya yolu.

expand: QueryExpand

Sonuçlara sorgu dizesini (wiql), yan tümceleri, sorgu sonucu sütunlarını ve sıralama seçeneklerini ekleyin.

depth: number

Sorgular klasöründe alt sorguları ve klasörleri bu derinliğe döndür.

includeDeleted: boolean

Silinen sorguları ve klasörleri dahil et

useIsoDateFormat: boolean

DateTime sorgu yan tümceleri ISO 8601 uyumlu biçim kullanılarak biçimlendirilecek

Döndürülenler

Promise<QueryHierarchyItem>

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

Sorgu kimliğine göre sorgunun sonuçlarını alır.

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

Parametreler

id: string

Sorgu kimliği.

project: string

Proje kimliği veya proje adı

team: string

Ekip kimliği veya ekip adı

timePrecision: boolean

Zaman duyarlığı kullanılıp kullanılmaması.

top: number

Döndürülecek en fazla sonuç sayısı.

Döndürülenler

Promise<number>

getRecentActivityData()

Son iş öğesi etkinliklerini alır

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Döndürülenler

Promise<AccountRecentActivityWorkItemModel2[]>

getRecentMentions()

YALNıZCA DAHILI: İŞ SAYFAM HESABı TARAFıNDAN KULLANıLıR.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Döndürülenler

Promise<AccountRecentMentionWorkItemModel[]>

getRelationType(string)

İş öğesi ilişki türü tanımını alır.

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

Parametreler

relation: string

İlişki adı

Döndürülenler

Promise<WorkItemRelationType>

getRelationTypes()

İş öğesi ilişki türlerini alır.

function getRelationTypes(): Promise<WorkItemRelationType[]>

Döndürülenler

Promise<WorkItemRelationType[]>

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

İş öğesi bağlantılarını toplu alma

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

Parametreler

project: string

Proje kimliği veya proje adı

linkTypes: string[]

Sonuçları belirli bağlantı türlerine göre filtrelemek için türlerin listesi. Tüm bağlantı türlerinin iş öğesi bağlantılarını almak için bu parametreyi atla.

types: string[]

Sonuçları belirli iş öğesi türlerine göre filtrelemek için türlerin listesi. Tüm iş öğesi türlerinin iş öğesi bağlantılarını almak için bu parametreyi atla.

continuationToken: string

Toplu işlemi başlatacak continuationToken öğesini belirtir. İlk bağlantı toplu işlemini almak için bu parametreyi atla.

startDateTime: Date

Bağlantı değişiklikleri için başlangıç noktası olarak kullanılacak tarih/saat. Yalnızca bu tarih/saatten sonra gerçekleşen bağlantı değişiklikleri döndürülür. 'watermark' parametresiyle birlikte kullanılamaz.

Döndürülenler

Promise<ReportingWorkItemLinksBatch>

getRevision(number, number, string, WorkItemExpand)

İstenen düzeltme için tam olarak nemlendirilmiş bir iş öğesi döndürür

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

Parametreler

id: number

revisionNumber: number

project: string

Proje kimliği veya proje adı

expand: WorkItemExpand

Döndürülenler

Promise<WorkItem>

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

Sayfalanmış, tam olarak nemlendirilmiş iş öğesi düzeltmelerinin listesini döndürür.

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

Parametreler

id: number

project: string

Proje kimliği veya proje adı

top: number

skip: number

expand: WorkItemExpand

Döndürülenler

Promise<WorkItem[]>

getRootNodes(string, number)

Projenin altındaki kök sınıflandırma düğümlerini alır.

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

Parametreler

project: string

Proje kimliği veya proje adı

depth: number

Getirilecek çocukların derinliği.

Döndürülenler

Promise<WorkItemClassificationNode[]>

getTemplate(string, string, string)

Belirtilen kimlikle şablonu alır

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

Parametreler

project: string

Proje kimliği veya proje adı

team: string

Ekip kimliği veya ekip adı

templateId: string

Şablon Kimliği

Döndürülenler

Promise<WorkItemTemplate>

getTemplates(string, string, string)

Şablonu alır

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

Parametreler

project: string

Proje kimliği veya proje adı

team: string

Ekip kimliği veya ekip adı

workitemtypename: string

İsteğe bağlı, Belirtildiğinde verilen İş öğesi türü için şablonları döndürür.

Döndürülenler

Promise<WorkItemTemplateReference[]>

getUpdate(number, number, string)

İş öğesi için tek bir güncelleştirme döndürür

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

Parametreler

id: number

updateNumber: number

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<WorkItemUpdate>

getUpdates(number, string, number, number)

İş öğesi düzeltmeleri arasındaki değişimleri verir

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

Parametreler

id: number

project: string

Proje kimliği veya proje adı

top: number

skip: number

Döndürülenler

Promise<WorkItemUpdate[]>

getWorkArtifactLinkTypes()

Giden yapıt bağlantı türlerini izleyen iş öğesi listesini alın.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

Döndürülenler

Promise<WorkArtifactLink[]>

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

Tek bir iş öğesi döndürür.

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

Parametreler

id: number

İş öğesi kimliği

project: string

Proje kimliği veya proje adı

fields: string[]

İstenen alanların virgülle ayrılmış listesi

asOf: Date

AsOf UTC tarih saat dizesi

expand: WorkItemExpand

İş öğesi öznitelikleri için genişletme parametreleri. Olası seçenekler şunlardır: { Yok, İlişkiler, Alanlar, Bağlantılar, Tümü }.

Döndürülenler

Promise<WorkItem>

getWorkItemIconJson(string, string, number)

Kolay ad ve simge rengi verilen bir iş öğesi simgesi alın.

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

Parametreler

icon: string

Simgenin adı

color: string

Simgenin 6 basamaklı onaltılık rengi

v: number

Simgenin sürümü (yalnızca önbellek geçersiz kılınması için kullanılır)

Döndürülenler

Promise<WorkItemIcon>

getWorkItemIcons()

Tüm iş öğesi simgelerinin listesini alın.

function getWorkItemIcons(): Promise<WorkItemIcon[]>

Döndürülenler

Promise<WorkItemIcon[]>

getWorkItemIconSvg(string, string, number)

Kolay ad ve simge rengi verilen bir iş öğesi simgesi alın.

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

Parametreler

icon: string

Simgenin adı

color: string

Simgenin 6 basamaklı onaltılık rengi

v: number

Simgenin sürümü (yalnızca önbellek geçersiz kılınması için kullanılır)

Döndürülenler

Promise<any>

getWorkItemIconXaml(string, string, number)

Kolay ad ve simge rengi verilen bir iş öğesi simgesi alın.

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

Parametreler

icon: string

Simgenin adı

color: string

Simgenin 6 basamaklı onaltılık rengi

v: number

Simgenin sürümü (yalnızca önbellek geçersiz kılınması için kullanılır)

Döndürülenler

Promise<any>

getWorkItemNextStatesOnCheckinAction(number[], string)

Verilen iş öğesi kimliklerinde sonraki durumu döndürür.

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

Parametreler

ids: number[]

iş öğesi kimliklerinin listesi

action: string

olası eylemler. Şu anda yalnızca iadeyi destekler

Döndürülenler

Promise<WorkItemNextStateOnTransition[]>

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

İş öğelerinin listesini döndürür (En fazla 200)

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

Parametreler

ids: number[]

İstenen iş öğesi kimliklerinin virgülle ayrılmış listesi. (İzin verilen en fazla 200 kimlik).

project: string

Proje kimliği veya proje adı

fields: string[]

İstenen alanların virgülle ayrılmış listesi

asOf: Date

AsOf UTC tarih saat dizesi

expand: WorkItemExpand

İş öğesi öznitelikleri için genişletme parametreleri. Olası seçenekler şunlardır: { Yok, İlişkiler, Alanlar, Bağlantılar, Tümü }.

errorPolicy: WorkItemErrorPolicy

Toplu olarak iş öğeleri alma isteğinde hata ilkesini denetleme bayrağı. Olası seçenekler şunlardır: {Başarısız, Atla}.

Döndürülenler

Promise<WorkItem[]>

getWorkItemsBatch(WorkItemBatchGetRequest, string)

İş öğesi kimlikleri listesi için iş öğelerini alır (En fazla 200)

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

Parametreler

workItemGetRequest: WorkItemBatchGetRequest

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<WorkItem[]>

getWorkItemStateColors(string[])

YALNIZCA İçERİ: Hesabım iş deneyimi için kullanılacaktır. Birden çok proje için iş öğesi türü durum rengini alma

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

Parametreler

projectNames: string[]

Döndürülenler

Promise<ProjectWorkItemStateColors[]>

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

Şablondan tek bir iş öğesi döndürür.

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

Parametreler

project: string

Proje kimliği veya proje adı

type: string

İş öğesi türü adı

fields: string

İstenen alanların virgülle ayrılmış listesi

asOf: Date

AsOf UTC tarih saat dizesi

expand: WorkItemExpand

İş öğesi öznitelikleri için genişletme parametreleri. Olası seçenekler şunlardır: { Yok, İlişkiler, Alanlar, Bağlantılar, Tümü }.

Döndürülenler

Promise<WorkItem>

getWorkItemType(string, string)

İş öğesi türü tanımını döndürür.

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

Parametreler

project: string

Proje kimliği veya proje adı

type: string

İş öğesi türü adı

Döndürülenler

Promise<WorkItemType>

getWorkItemTypeCategories(string)

Tüm iş öğesi türü kategorilerini alın.

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

Parametreler

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<WorkItemTypeCategory[]>

getWorkItemTypeCategory(string, string)

Ada göre belirli iş öğesi türü kategorisini alın.

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

Parametreler

project: string

Proje kimliği veya proje adı

category: string

Kategori adı

Döndürülenler

Promise<WorkItemTypeCategory>

getWorkItemTypeColorAndIcons(string[])

YALNIZCA İç: Renk ve simge sağlayıcıları için kullanılır. Birden çok proje için wit türü rengini alma

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

Parametreler

projectNames: string[]

Döndürülenler

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

getWorkItemTypeColors(string[])

YALNIZCA İçERİ: Hesabım iş deneyimi için kullanılacaktır. Birden çok proje için wit türü rengini alma

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

Parametreler

projectNames: string[]

Döndürülenler

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

getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)

Ayrıntılı başvurular içeren bir iş öğesi türü için alanların listesini alın.

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

Parametreler

project: string

Proje kimliği veya proje adı

type: string

İş öğesi türü.

expand: WorkItemTypeFieldsExpandLevel

API yanıtı için düzeyi genişletin. Özellikler: yanıtın bir parçası olarak allowedvalues, default value, isRequired vb. eklemek için; Yok: bu özellikleri atlamak için.

Döndürülenler

Promise<WorkItemTypeFieldWithReferences[]>

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

Ayrıntılı başvurular içeren bir iş öğesi türü için alan alın.

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

Parametreler

project: string

Proje kimliği veya proje adı

type: string

İş öğesi türü.

field: string

expand: WorkItemTypeFieldsExpandLevel

API yanıtı için düzeyi genişletin. Özellikler: yanıtın bir parçası olarak allowedvalues, default value, isRequired vb. eklemek için; Yok: bu özellikleri atlamak için.

Döndürülenler

Promise<WorkItemTypeFieldWithReferences>

getWorkItemTypes(string)

İş öğesi türlerinin listesini döndürür

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

Parametreler

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<WorkItemType[]>

getWorkItemTypeStates(string, string)

bir iş öğesi türünün durum adlarını ve renklerini döndürür.

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

Parametreler

project: string

Proje kimliği veya proje adı

type: string

Durum adı

Döndürülenler

Promise<WorkItemStateColor[]>

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

Sorgu kimliğine göre sorgunun sonuçlarını alır.

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

Parametreler

id: string

Sorgu kimliği.

project: string

Proje kimliği veya proje adı

team: string

Ekip kimliği veya ekip adı

timePrecision: boolean

Zaman duyarlığı kullanılıp kullanılmaması.

top: number

Döndürülecek en fazla sonuç sayısı.

Döndürülenler

Promise<WorkItemQueryResult>

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

WIQL'i göz önüne alındığında sorgunun sonuçlarını alır.

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

Parametreler

wiql: Wiql

WIQL'i içeren sorgu.

project: string

Proje kimliği veya proje adı

team: string

Ekip kimliği veya ekip adı

timePrecision: boolean

Zaman duyarlığı kullanılıp kullanılmaması.

top: number

Döndürülecek en fazla sonuç sayısı.

Döndürülenler

Promise<WorkItemQueryResult>

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

Belirli bir yapıt URI'sine bağlı iş öğelerini sorgular.

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

Parametreler

artifactUriQuery: ArtifactUriQuery

İş öğelerini sorgulamak için yapıt URI'sinin listesini tanımlar.

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<ArtifactUriQueryResult>

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

Silinmiş öğeleri ekleme seçeneğiyle bir grup iş öğesi düzeltmesi alma

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>

Parametreler

project: string

Proje kimliği veya proje adı

fields: string[]

İş öğesi düzeltmelerinde döndürülecek alanların listesi. Raporlanabilir tüm alanları almak için bu parametreyi atla.

types: string[]

Sonuçları belirli iş öğesi türlerine göre filtrelemek için türlerin listesi. Tüm iş öğesi türlerinin iş öğesi düzeltmelerini almak için bu parametreyi atla.

continuationToken: string

Toplu işlemi başlatacak filigranı belirtir. İlk düzeltme toplu işlemini almak için bu parametreyi atla.

startDateTime: Date

Düzeltmeler için başlangıç noktası olarak kullanılacak tarih/saat, tüm düzeltmeler bu tarih/saatten sonra gerçekleşir. 'watermark' parametresiyle birlikte kullanılamaz.

includeIdentityRef: boolean

Kimlik alanları için dize değeri yerine kimlik başvurusu döndürür.

includeDeleted: boolean

Silinen öğenin döndürülmesi gerekip gerekmediğini belirtin.

includeTagRef: boolean

System.Tags alanı için etiket nesnelerinin döndürülmesi gerekip gerekmediğini belirtin.

includeLatestOnly: boolean

Tüm geçmiş düzeltmeleri atlayarak yalnızca iş öğelerinin en son düzeltmelerini döndür

expand: ReportingRevisionsExpand

Varsayılan olarak döndürülmeyen uzun metin alanları da dahil olmak üzere iş öğesi düzeltmelerindeki tüm alanları döndürür

includeDiscussionChangesOnly: boolean

Yalnızca geçmiş alanının değiştirildiği iş öğelerinin düzeltmelerini döndür

maxPageSize: number

Bu toplu işte döndürülecek en fazla sonuç sayısı

Döndürülenler

Promise<ReportingWorkItemRevisionsBatch>

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

Bir grup iş öğesi düzeltmesi alın. Alan listeniz URL'yi uzunluk sınırı üzerinden çalıştırabilecek kadar büyükse bu istek kullanılabilir.

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

Parametreler

filter: ReportingWorkItemRevisionsFilter

İstek ayarlarını içeren bir nesne: alan filtresi, tür filtresi, kimlik biçimi

project: string

Proje kimliği veya proje adı

continuationToken: string

Toplu işlemi başlatacak filigranı belirtir. İlk düzeltme toplu işlemini almak için bu parametreyi atla.

startDateTime: Date

Düzeltmeler için başlangıç noktası olarak kullanılacak tarih/saat, tüm düzeltmeler bu tarih/saatten sonra gerçekleşir. 'watermark' parametresiyle birlikte kullanılamaz.

expand: ReportingRevisionsExpand

Döndürülenler

Promise<ReportingWorkItemRevisionsBatch>

replaceTemplate(WorkItemTemplate, string, string, string)

Şablon içeriğini değiştirme

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

Parametreler

templateContent: WorkItemTemplate

Değiştirilmeye değer şablon içeriği

project: string

Proje kimliği veya proje adı

team: string

Ekip kimliği veya ekip adı

templateId: string

Şablon kimliği

Döndürülenler

Promise<WorkItemTemplate>

restoreWorkItem(WorkItemDeleteUpdate, number, string)

Silinen iş öğesini Geri Dönüşüm Kutusu'ndan geri yükler.

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

Parametreler

payload: WorkItemDeleteUpdate

IsDeleted bayrağını false olarak güncelleştirme yönergeleriyle Paylod

id: number

Geri yüklenecek iş öğesinin kimliği

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<WorkItemDelete>

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

Kullanıcının geçerli projede erişimi olan tüm sorguları arar

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

Parametreler

project: string

Proje kimliği veya proje adı

filter: string

Sorguların filtreleneceği metin.

top: number

Döndürülecek sorgu sayısı (Varsayılan değer 50 ve en fazla 200'dür).

expand: QueryExpand

includeDeleted: boolean

Silinen sorguları ve klasörleri dahil et

Döndürülenler

Promise<QueryHierarchyItemsResult>

sendMail(SendMailBody, string)

Seçili/sorgulanan iş öğeleri için posta göndermek için RESTful yöntemi.

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

Parametreler

body: SendMailBody

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<void>

updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Mevcut bir sınıflandırma düğümünü güncelleştirin.

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

Parametreler

postedNode: WorkItemClassificationNode

Oluşturulacak veya güncelleştirilecek düğüm.

project: string

Proje kimliği veya proje adı

structureGroup: TreeStructureGroup

Sınıflandırma düğümünün, alanın veya yinelemenin yapı grubu.

path: string

Sınıflandırma düğümünün yolu.

Döndürülenler

Promise<WorkItemClassificationNode>

updateField(UpdateWorkItemField, string, string)

Bir alanı güncelleştirin.

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

Parametreler

payload: UpdateWorkItemField

Payload, alanın özelliklerinin istenen değerini içerir

fieldNameOrRefName: string

Güncelleştirilecek alanın adı/başvuru adı

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<WorkItemField>

updateQuery(QueryHierarchyItem, string, string, boolean)

Sorguyu veya klasörü güncelleştirin. Bu, sorguları ve klasörleri güncelleştirmenize, yeniden adlandırmanıza ve taşımanıza olanak tanır.

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

Parametreler

queryUpdate: QueryHierarchyItem

Güncelleştirilecek sorgu.

project: string

Proje kimliği veya proje adı

query: string

Güncelleştirilecek sorgunun kimliği veya yolu.

undeleteDescendants: boolean

Bu klasörün alt öğelerinin gerisini kaldırın. Bunun, daha önce alt öğelere uygulanmış olan izin değişikliklerini geri getirmeyeceğini unutmayın.

Döndürülenler

Promise<QueryHierarchyItem>

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

Tek bir iş öğesini güncelleştirir.

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

Parametreler

document: JsonPatchDocument

Güncelleştirmeyi temsil eden JSON Düzeltme Eki belgesi

id: number

Güncelleştirilecek iş öğesinin kimliği

project: string

Proje kimliği veya proje adı

validateOnly: boolean

İş öğesini kaydetmeden yalnızca değişiklikleri doğrulamak isteyip istemediğinizi belirtin

bypassRules: boolean

Bu güncelleştirmede iş öğesi türü kurallarını zorunlu kılma

suppressNotifications: boolean

Bu değişiklik için hiçbir bildirim tetiklemayın

expand: WorkItemExpand

İş öğesi öznitelikleri için genişletme parametreleri. Olası seçenekler şunlardır: { Yok, İlişkiler, Alanlar, Bağlantılar, Tümü }.

Döndürülenler

Promise<WorkItem>

updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)

İş öğesi türü ekleme/güncelleştirme

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

Parametreler

updateModel: WorkItemTypeTemplateUpdateModel

project: string

Proje kimliği veya proje adı

Döndürülenler

Promise<ProvisioningResult>

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?

Aracılığıyla paylaş

WorkItemTrackingRestClient class

Oluşturucular

Özellikler

Yöntemler

Oluşturucu Ayrıntıları

WorkItemTrackingRestClient(IVssRestClientOptions)

Parametreler

Özellik Ayrıntıları

RESOURCE_AREA_ID

Özellik Değeri

Yöntem Ayrıntıları

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

Parametreler

Döndürülenler

createField(WorkItemField, string)

Parametreler

Döndürülenler

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Parametreler

Döndürülenler

createQuery(QueryHierarchyItem, string, string, boolean)

Parametreler

Döndürülenler

createTemplate(WorkItemTemplate, string, string)

Parametreler

Döndürülenler

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

Parametreler

Döndürülenler

deleteClassificationNode(string, TreeStructureGroup, string, number)

Parametreler

Döndürülenler

deleteField(string, string)

Parametreler

Döndürülenler

deleteQuery(string, string)

Parametreler

Döndürülenler

deleteTemplate(string, string, string)

Parametreler

Döndürülenler

deleteWorkItem(number, string, boolean)

Parametreler

Döndürülenler

destroyWorkItem(number, string)

Parametreler

Döndürülenler

exportWorkItemTypeDefinition(string, string, boolean)

Parametreler

Döndürülenler

getAccountMyWorkData(QueryOption)

Parametreler

Döndürülenler

getAttachmentContent(string, string, string, boolean)

Parametreler

Döndürülenler

getAttachmentZip(string, string, string, boolean)

Parametreler

Döndürülenler

getClassificationNode(string, TreeStructureGroup, string, number)

Parametreler

Döndürülenler

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

Parametreler

Döndürülenler

getComment(number, number, string)

Parametreler

Döndürülenler

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

Parametreler

Döndürülenler

getDeletedWorkItem(number, string)

Parametreler

Döndürülenler

getDeletedWorkItems(number[], string)

Parametreler

Döndürülenler

getDeletedWorkItemShallowReferences(string)

Parametreler