WorkItemTrackingRestClient class

Pakiet:: azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Rozszerzenie: RestClientBase

Konstruktory

WorkItemTrackingRestClient(IVssRestClientOptions)

Właściwości

Metody

createAttachment(any, string, string, string, string)	Przekazuje załącznik.
createField(WorkItemField, string)	Utwórz nowe pole.
createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Utwórz nowy lub zaktualizuj istniejący węzeł klasyfikacji.
createQuery(QueryHierarchyItem, string, string, boolean)	Tworzy kwerendę lub przenosi zapytanie.
createTemplate(WorkItemTemplate, string, string)	Tworzy szablon
createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)	Tworzy pojedynczy element roboczy.
deleteClassificationNode(string, TreeStructureGroup, string, number)	Usuń istniejący węzeł klasyfikacji.
deleteField(string, string)	Usuwa pole. Aby cofnąć usunięcie pola, zobacz API "Aktualizuj pole".
deleteQuery(string, string)	Usuwanie zapytania lub folderu. Spowoduje to usunięcie wszelkich zmian uprawnień do usuniętego zapytania lub folderu oraz wszystkich jego elementów podrzędnych, jeśli jest to folder. Należy pamiętać, że usuniętych zmian uprawnień nie można odzyskać po przywróceniu zapytania lub folderu.
deleteTemplate(string, string, string)	Usuwa szablon o podanym identyfikatorze
deleteWorkItem(number, string, boolean)	Usuwa określony element roboczy i wysyła go do Kosza, aby w razie potrzeby można go było przywrócić. Opcjonalnie, jeśli parametr destroy został ustawiony na wartość true, trwale niszczy element roboczy. OSTRZEŻENIE: Jeśli parametr destroy jest ustawiony na true, elementy robocze usunięte przez to polecenie NIE trafią do kosza i nie ma możliwości ich przywrócenia/odzyskania po usunięciu. Zaleca się, aby NIE używać tego parametru. Jeśli tak, należy używać tego parametru z najwyższą ostrożnością.
destroyWorkItem(number, string)	Trwale niszczy określony element roboczy z Kosza. Tej czynności nie można cofnąć.
exportWorkItemTypeDefinition(string, string, boolean)	Eksportowanie typu elementu roboczego
getAccountMyWorkData(QueryOption)	TYLKO WEWNĘTRZNA: UŻYWANA PRZEZ STRONĘ KONTO MOJA PRACA. Spowoduje to zwrócenie szczegółów elementów roboczych Doing, Done, Following i activity.
getAttachmentContent(string, string, string, boolean)	Pobiera załącznik.
getAttachmentZip(string, string, string, boolean)	Pobiera załącznik.
getClassificationNode(string, TreeStructureGroup, string, number)	Pobiera węzeł klasyfikacji dla danej ścieżki węzła.
getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)	Pobiera główne węzły klasyfikacji lub listę węzłów klasyfikacji dla danej listy identyfikatorów węzłów dla danego projektu. W przypadku podania parametru ids zostanie wyświetlona lista węzłów klasyfikacyjnych dla tych identyfikatorów. W przeciwnym razie otrzymasz główne węzły klasyfikacji dla tego projektu.
getComment(number, number, string)	Pobiera komentarz dla elementu roboczego w określonej poprawce.
getComments(number, string, number, number, CommentSortOrder)	Pobiera określoną liczbę komentarzy dla elementu roboczego z określonej poprawki.
getDeletedWorkItem(number, string)	Pobiera usunięty element roboczy z Kosza.
getDeletedWorkItems(number[], string)	Pobiera elementy robocze z kosza, których identyfikatory zostały określone w parametrach
getDeletedWorkItemShallowReferences(string)	Pobiera listę identyfikatorów i adresów URL usuniętych elementów roboczych w Koszu.
getField(string, string)	Pobiera informacje o określonym polu.
getFields(string, GetFieldsExpand)	Zwraca informacje dla wszystkich pól. Parametr identyfikatora/nazwy projektu jest opcjonalny.
getQueries(string, QueryExpand, number, boolean)	Pobiera zapytania główne i ich elementy podrzędne
getQueriesBatch(QueryBatchGetRequest, string)	Pobiera listę zapytań według identyfikatorów (maksymalnie 1000)
getQuery(string, string, QueryExpand, number, boolean, boolean)	Pobiera pojedyncze zapytanie i jego elementy podrzędne
getQueryResultCount(string, string, string, boolean, number)	Pobiera wyniki zapytania na podstawie identyfikatora zapytania.
getRecentActivityData()	Pobiera ostatnie działania elementów roboczych
getRecentMentions()	TYLKO WEWNĘTRZNA: UŻYWANA PRZEZ STRONĘ KONTO MOJA PRACA.
getRelationType(string)	Pobiera definicję typu relacji elementu roboczego.
getRelationTypes()	Pobiera typy relacji elementów roboczych.
getReportingLinksByLinkType(string, string[], string[], string, Date)	Pobieranie partii linków do elementów roboczych
getRevision(number, number, string, WorkItemExpand)	Zwraca w pełni uwodniony element roboczy dla żądanej poprawki
getRevisions(number, string, number, number, WorkItemExpand)	Zwraca listę w pełni uwodnionych poprawek elementów roboczych, stronicowanych.
getRootNodes(string, number)	Pobiera główne węzły klasyfikacji w ramach projektu.
getTemplate(string, string, string)	Pobiera szablon o określonym identyfikatorze
getTemplates(string, string, string)	Pobiera szablon
getUpdate(number, number, string)	Zwraca pojedynczą aktualizację dla elementu roboczego
getUpdates(number, string, number, number)	Zwraca różnice między poprawkami elementów roboczych
getWorkArtifactLinkTypes()	Pobierz listę typów linków artefaktów wychodzących śledzenia elementów roboczych.
getWorkItem(number, string, string[], Date, WorkItemExpand)	Zwraca pojedynczy element roboczy.
getWorkItemIconJson(string, string, number)	Pobierz ikonę elementu roboczego pod względem przyjaznej nazwy i koloru ikony.
getWorkItemIcons()	Pobierz listę wszystkich ikon elementów roboczych.
getWorkItemIconSvg(string, string, number)	Pobierz ikonę elementu roboczego pod względem przyjaznej nazwy i koloru ikony.
getWorkItemIconXaml(string, string, number)	Pobierz ikonę elementu roboczego pod względem przyjaznej nazwy i koloru ikony.
getWorkItemNextStatesOnCheckinAction(number[], string)	Zwraca następny stan dla podanych identyfikatorów elementów roboczych.
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)	Zwraca listę elementów roboczych (maksymalnie 200)
getWorkItemsBatch(WorkItemBatchGetRequest, string)	Pobiera elementy robocze dla listy identyfikatorów elementów roboczych (maksymalnie 200)
getWorkItemStateColors(string[])	TYLKO WEWNĘTRZNA: Będzie używana do pracy na moim koncie. Pobieranie koloru stanu typu elementu roboczego dla wielu projektów
getWorkItemTemplate(string, string, string, Date, WorkItemExpand)	Zwraca pojedynczy element roboczy z szablonu.
getWorkItemType(string, string)	Zwraca definicję typu elementu roboczego.
getWorkItemTypeCategories(string)	Pobierz wszystkie kategorie typów elementów roboczych.
getWorkItemTypeCategory(string, string)	Pobierz określoną kategorię typu elementu roboczego według nazwy.
getWorkItemTypeColorAndIcons(string[])	TYLKO WEWNĘTRZNA: Jest używana dla dostawców kolorów i ikon. Uzyskaj kolor typu dowcipu dla wielu projektów
getWorkItemTypeColors(string[])	TYLKO WEWNĘTRZNA: Będzie używana do pracy na moim koncie. Uzyskaj kolor typu dowcipu dla wielu projektów
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)	Pobierz listę pól dla typu elementu roboczego ze szczegółowymi odwołaniami.
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)	Pobierz pole dla typu elementu roboczego ze szczegółowymi odwołaniami.
getWorkItemTypes(string)	Zwraca listę typów elementów roboczych
getWorkItemTypeStates(string, string)	Zwraca nazwy stanów i kolory dla typu elementu roboczego.
queryById(string, string, string, boolean, number)	Pobiera wyniki zapytania na podstawie identyfikatora zapytania.
queryByWiql(Wiql, string, string, boolean, number)	Pobiera wyniki zapytania, biorąc pod uwagę jego WIQL.
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)	Wykonuje zapytania dotyczące elementów roboczych połączonych z daną listą identyfikatorów URI artefaktów.
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)	Pobieranie partii poprawek elementów roboczych z opcją dołączania usuniętych elementów
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)	Pobierz partię poprawek elementów roboczych. To żądanie może być używane, jeśli lista pól jest na tyle duża, że adres URL może przekroczyć limit długości.
replaceTemplate(WorkItemTemplate, string, string, string)	Zastąp zawartość szablonu
restoreWorkItem(WorkItemDeleteUpdate, number, string)	Przywraca usunięty element roboczy z Kosza.
searchQueries(string, string, number, QueryExpand, boolean)	Przeszukuje wszystkie zapytania, do których użytkownik ma dostęp w bieżącym projekcie
sendMail(SendMailBody, string)	Metoda RESTful do wysyłania wiadomości e-mail dla wybranych/odpytywanych elementów roboczych.
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Zaktualizuj istniejący węzeł klasyfikacji.
updateField(UpdateWorkItemField, string, string)	Aktualizowanie pola.
updateQuery(QueryHierarchyItem, string, string, boolean)	Aktualizowanie zapytania lub folderu. Pozwala to na aktualizowanie, zmienianie nazw i przenoszenie zapytań i folderów.
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)	Aktualizuje pojedynczy element roboczy.
updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)	Dodawanie/aktualizowanie typu elementu roboczego

Szczegóły konstruktora

WorkItemTrackingRestClient(IVssRestClientOptions)

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

Szczegóły właściwości

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Wartość właściwości

string

Szczegóły metody

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

Przekazuje załącznik.

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

Parametry

content: any

Zawartość do przekazania

project: string

Identyfikator projektu lub nazwa projektu

fileName: string

Nazwa pliku

uploadType: string

Typ przesyłania załączników: Prosty lub Fragmentaryczny

areaPath: string

Ścieżka obszaru projektu docelowego

Zwraca

Promise<AttachmentReference>

createField(WorkItemField, string)

Utwórz nowe pole.

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

Parametry

workItemField: WorkItemField

Nowa definicja pola

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<WorkItemField>

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Utwórz nowy lub zaktualizuj istniejący węzeł klasyfikacji.

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

Parametry

postedNode: WorkItemClassificationNode

Węzeł do utworzenia lub zaktualizowania.

project: string

Identyfikator projektu lub nazwa projektu

structureGroup: TreeStructureGroup

Grupa struktury węzła klasyfikacji, obszaru lub iteracji.

path: string

Ścieżka węzła klasyfikacji.

Zwraca

Promise<WorkItemClassificationNode>

createQuery(QueryHierarchyItem, string, string, boolean)

Tworzy kwerendę lub przenosi zapytanie.

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

Parametry

postedQuery: QueryHierarchyItem

Zapytanie, które ma zostać utworzone.

project: string

Identyfikator projektu lub nazwa projektu

query: string

Identyfikator nadrzędny lub ścieżka, pod którą ma zostać utworzone zapytanie.

validateWiqlOnly: boolean

Jeśli chcesz tylko zweryfikować zapytanie WIQL bez jego tworzenia, ustaw je na wartość true. Wartość domyślna to „false”.

Zwraca

Promise<QueryHierarchyItem>

createTemplate(WorkItemTemplate, string, string)

Tworzy szablon

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

Parametry

template: WorkItemTemplate

Zawartość szablonu

project: string

Identyfikator projektu lub nazwa projektu

team: string

Identyfikator zespołu lub nazwa zespołu

Zwraca

Promise<WorkItemTemplate>

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

Tworzy pojedynczy element roboczy.

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

Parametry

document: JsonPatchDocument

Dokument poprawki JSON reprezentujący element roboczy

project: string

Identyfikator projektu lub nazwa projektu

type: string

Typ elementu roboczego elementu roboczego do utworzenia

validateOnly: boolean

Wskaż, czy chcesz tylko zweryfikować zmiany bez zapisywania elementu roboczego

bypassRules: boolean

Nie wymuszaj reguł typu elementu roboczego w tej aktualizacji

suppressNotifications: boolean

Nie uruchamiaj żadnych powiadomień o tej zmianie

expand: WorkItemExpand

Rozwiń parametry atrybutów elementu roboczego. Możliwe opcje to { Brak, Relacje, Pola, Łącza, Wszystkie }.

Zwraca

Promise<WorkItem>

deleteClassificationNode(string, TreeStructureGroup, string, number)

Usuń istniejący węzeł klasyfikacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

structureGroup: TreeStructureGroup

Grupa struktury węzła klasyfikacji, obszaru lub iteracji.

path: string

Ścieżka węzła klasyfikacji.

reclassifyId: number

Identyfikator docelowego węzła klasyfikacji do ponownej klasyfikacji.

Zwraca

Promise<void>

deleteField(string, string)

Usuwa pole. Aby cofnąć usunięcie pola, zobacz API "Aktualizuj pole".

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

Parametry

fieldNameOrRefName: string

Prosta nazwa pola lub nazwa odwołania

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

deleteQuery(string, string)

Usuwanie zapytania lub folderu. Spowoduje to usunięcie wszelkich zmian uprawnień do usuniętego zapytania lub folderu oraz wszystkich jego elementów podrzędnych, jeśli jest to folder. Należy pamiętać, że usuniętych zmian uprawnień nie można odzyskać po przywróceniu zapytania lub folderu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

query: string

Identyfikator lub ścieżka zapytania lub folderu do usunięcia.

Zwraca

Promise<void>

deleteTemplate(string, string, string)

Usuwa szablon o podanym identyfikatorze

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

team: string

Identyfikator zespołu lub nazwa zespołu

templateId: string

Identyfikator szablonu

Zwraca

Promise<void>

deleteWorkItem(number, string, boolean)

Usuwa określony element roboczy i wysyła go do Kosza, aby w razie potrzeby można go było przywrócić. Opcjonalnie, jeśli parametr destroy został ustawiony na wartość true, trwale niszczy element roboczy. OSTRZEŻENIE: Jeśli parametr destroy jest ustawiony na true, elementy robocze usunięte przez to polecenie NIE trafią do kosza i nie ma możliwości ich przywrócenia/odzyskania po usunięciu. Zaleca się, aby NIE używać tego parametru. Jeśli tak, należy używać tego parametru z najwyższą ostrożnością.

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

Parametry

id: number

Identyfikator elementu roboczego do usunięcia

project: string

Identyfikator projektu lub nazwa projektu

destroy: boolean

Parametr opcjonalny, jeśli jest ustawiony na wartość true, element roboczy zostanie trwale usunięty. Uwaga: akcja zniszczenia jest TRWAŁA i nie można jej cofnąć.

Zwraca

Promise<WorkItemDelete>

destroyWorkItem(number, string)

Trwale niszczy określony element roboczy z Kosza. Tej czynności nie można cofnąć.

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

Parametry

id: number

Identyfikator elementu roboczego, który ma zostać trwale zniszczony

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

exportWorkItemTypeDefinition(string, string, boolean)

Eksportowanie typu elementu roboczego

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

type: string

exportGlobalLists: boolean

Zwraca

Promise<WorkItemTypeTemplate>

getAccountMyWorkData(QueryOption)

TYLKO WEWNĘTRZNA: UŻYWANA PRZEZ STRONĘ KONTO MOJA PRACA. Spowoduje to zwrócenie szczegółów elementów roboczych Doing, Done, Following i activity.

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

Parametry

queryOption: QueryOption

Zwraca

Promise<AccountMyWorkResult>

getAttachmentContent(string, string, string, boolean)

Pobiera załącznik.

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

Parametry

id: string

Identyfikator załącznika

project: string

Identyfikator projektu lub nazwa projektu

fileName: string

Nazwa pliku

download: boolean

Jeśli ustawiono <wartość c>true</c> , zawsze pobierz załącznik

Zwraca

Promise<ArrayBuffer>

getAttachmentZip(string, string, string, boolean)

Pobiera załącznik.

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

Parametry

id: string

Identyfikator załącznika

project: string

Identyfikator projektu lub nazwa projektu

fileName: string

Nazwa pliku

download: boolean

Jeśli ustawiono <wartość c>true</c> , zawsze pobierz załącznik

Zwraca

Promise<ArrayBuffer>

getClassificationNode(string, TreeStructureGroup, string, number)

Pobiera węzeł klasyfikacji dla danej ścieżki węzła.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

structureGroup: TreeStructureGroup

Grupa struktury węzła klasyfikacji, obszaru lub iteracji.

path: string

Ścieżka węzła klasyfikacji.

depth: number

Głębokość dzieci do pobrania.

Zwraca

Promise<WorkItemClassificationNode>

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

Pobiera główne węzły klasyfikacji lub listę węzłów klasyfikacji dla danej listy identyfikatorów węzłów dla danego projektu. W przypadku podania parametru ids zostanie wyświetlona lista węzłów klasyfikacyjnych dla tych identyfikatorów. W przeciwnym razie otrzymasz główne węzły klasyfikacji dla tego projektu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

ids: number[]

Identyfikatory węzłów klasyfikacji liczb całkowitych oddzielonych przecinkami. Nie jest to wymagane, jeśli chcesz mieć węzły główne.

depth: number

Głębokość dzieci do pobrania.

errorPolicy: ClassificationNodesErrorPolicy

Flaga służąca do obsługi błędów podczas pobierania niektórych węzłów. Możliwe opcje to Niepowodzenie i Pomiń.

Zwraca

Promise<WorkItemClassificationNode[]>

getComment(number, number, string)

Pobiera komentarz dla elementu roboczego w określonej poprawce.

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

Parametry

id: number

Identyfikator elementu roboczego

revision: number

Wersja, dla której należy pobrać komentarz

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<WorkItemComment>

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

Pobiera określoną liczbę komentarzy dla elementu roboczego z określonej poprawki.

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

Parametry

id: number

Identyfikator elementu roboczego

project: string

Identyfikator projektu lub nazwa projektu

fromRevision: number

Wersja, z której mają być pobierane komentarze (domyślnie 1)

top: number

Liczba komentarzy do zwrócenia (domyślnie 200)

order: CommentSortOrder

Rosnąco lub malejąco według identyfikatora wersji (domyślnie rosnąco)

Zwraca

Promise<WorkItemComments>

getDeletedWorkItem(number, string)

Pobiera usunięty element roboczy z Kosza.

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

Parametry

id: number

Identyfikator elementu roboczego do zwrócenia

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<WorkItemDelete>

getDeletedWorkItems(number[], string)

Pobiera elementy robocze z kosza, których identyfikatory zostały określone w parametrach

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

Parametry

ids: number[]

Rozdzielona przecinkami lista identyfikatorów usuniętych elementów roboczych, które mają zostać zwrócone

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<WorkItemDeleteReference[]>

getDeletedWorkItemShallowReferences(string)

Pobiera listę identyfikatorów i adresów URL usuniętych elementów roboczych w Koszu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<WorkItemDeleteShallowReference[]>

getField(string, string)

Pobiera informacje o określonym polu.

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

Parametry

fieldNameOrRefName: string

Prosta nazwa pola lub nazwa odwołania

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

Zwraca informacje dla wszystkich pól. Parametr identyfikatora/nazwy projektu jest opcjonalny.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

expand: GetFieldsExpand

Użyj ExtensionFields, aby dołączyć pola rozszerzeń, w przeciwnym razie wyklucz je. Jeśli flaga funkcji dla tego parametru nie jest włączona, pola rozszerzenia są zawsze uwzględniane.

Zwraca

Promise<WorkItemField[]>

getQueries(string, QueryExpand, number, boolean)

Pobiera zapytania główne i ich elementy podrzędne

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

expand: QueryExpand

Uwzględnij ciąg zapytania (wiql), klauzule, kolumny wyników zapytania i opcje sortowania w wynikach.

depth: number

W folderze zapytań przywróć zapytania podrzędne i foldery do tej głębokości.

includeDeleted: boolean

Uwzględnij usunięte zapytania i foldery

Zwraca

Promise<QueryHierarchyItem[]>

getQueriesBatch(QueryBatchGetRequest, string)

Pobiera listę zapytań według identyfikatorów (maksymalnie 1000)

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

Parametry

queryGetRequest: QueryBatchGetRequest

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<QueryHierarchyItem[]>

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

Pobiera pojedyncze zapytanie i jego elementy podrzędne

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

query: string

Identyfikator lub ścieżka zapytania.

expand: QueryExpand

Uwzględnij ciąg zapytania (wiql), klauzule, kolumny wyników zapytania i opcje sortowania w wynikach.

depth: number

W folderze zapytań przywróć zapytania podrzędne i foldery do tej głębokości.

includeDeleted: boolean

Uwzględnij usunięte zapytania i foldery

useIsoDateFormat: boolean

Klauzule zapytania DateTime będą formatowane przy użyciu formatu zgodnego ze standardem ISO 8601

Zwraca

Promise<QueryHierarchyItem>

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

Pobiera wyniki zapytania na podstawie identyfikatora zapytania.

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

Parametry

id: string

Identyfikator zapytania.

project: string

Identyfikator projektu lub nazwa projektu

team: string

Identyfikator zespołu lub nazwa zespołu

timePrecision: boolean

Określa, czy używać precyzji czasu, czy nie.

top: number

Maksymalna liczba wyników do zwrócenia.

Zwraca

Promise<number>

getRecentActivityData()

Pobiera ostatnie działania elementów roboczych

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Zwraca

Promise<AccountRecentActivityWorkItemModel2[]>

getRecentMentions()

TYLKO WEWNĘTRZNA: UŻYWANA PRZEZ STRONĘ KONTO MOJA PRACA.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Zwraca

Promise<AccountRecentMentionWorkItemModel[]>

getRelationType(string)

Pobiera definicję typu relacji elementu roboczego.

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

Parametry

relation: string

Nazwa relacji

Zwraca

Promise<WorkItemRelationType>

getRelationTypes()

Pobiera typy relacji elementów roboczych.

function getRelationTypes(): Promise<WorkItemRelationType[]>

Zwraca

Promise<WorkItemRelationType[]>

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

Pobieranie partii linków do elementów roboczych

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

linkTypes: string[]

Lista typów do filtrowania wyników do określonych typów linków. Pomiń ten parametr, aby uzyskać linki elementów roboczych wszystkich typów linków.

types: string[]

Lista typów do filtrowania wyników pod kątem określonych typów elementów roboczych. Pomiń ten parametr, aby uzyskać linki do elementów roboczych wszystkich typów elementów roboczych.

continuationToken: string

Określa parametr continuationToken, od którego ma zostać uruchomiona partia. Pomiń ten parametr, aby uzyskać pierwszą partię linków.

startDateTime: Date

Data/godzina, która ma być używana jako punkt wyjścia dla zmian linków. Zwracane będą tylko zmiany linków, które nastąpiły po tej dacie/godzinie. Nie można używać w połączeniu z parametrem "watermark".

Zwraca

Promise<ReportingWorkItemLinksBatch>

getRevision(number, number, string, WorkItemExpand)

Zwraca w pełni uwodniony element roboczy dla żądanej poprawki

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

Parametry

id: number

revisionNumber: number

project: string

Identyfikator projektu lub nazwa projektu

expand: WorkItemExpand

Zwraca

Promise<WorkItem>

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

Zwraca listę w pełni uwodnionych poprawek elementów roboczych, stronicowanych.

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

Parametry

id: number

project: string

Identyfikator projektu lub nazwa projektu

top: number

skip: number

expand: WorkItemExpand

Zwraca

Promise<WorkItem[]>

getRootNodes(string, number)

Pobiera główne węzły klasyfikacji w ramach projektu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

depth: number

Głębokość dzieci do pobrania.

Zwraca

Promise<WorkItemClassificationNode[]>

getTemplate(string, string, string)

Pobiera szablon o określonym identyfikatorze

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

team: string

Identyfikator zespołu lub nazwa zespołu

templateId: string

Identyfikator szablonu

Zwraca

Promise<WorkItemTemplate>

getTemplates(string, string, string)

Pobiera szablon

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

team: string

Identyfikator zespołu lub nazwa zespołu

workitemtypename: string

Opcjonalnie, gdy określono zwraca szablony dla danego typu elementu roboczego.

Zwraca

Promise<WorkItemTemplateReference[]>

getUpdate(number, number, string)

Zwraca pojedynczą aktualizację dla elementu roboczego

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

Parametry

id: number

updateNumber: number

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<WorkItemUpdate>

getUpdates(number, string, number, number)

Zwraca różnice między poprawkami elementów roboczych

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

Parametry

id: number

project: string

Identyfikator projektu lub nazwa projektu

top: number

skip: number

Zwraca

Promise<WorkItemUpdate[]>

getWorkArtifactLinkTypes()

Pobierz listę typów linków artefaktów wychodzących śledzenia elementów roboczych.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

Zwraca

Promise<WorkArtifactLink[]>

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

Zwraca pojedynczy element roboczy.

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

Parametry

id: number

Identyfikator elementu roboczego

project: string

Identyfikator projektu lub nazwa projektu

fields: string[]

Rozdzielana przecinkami lista żądanych pól

asOf: Date

AsOf UTC ciąg daty i godziny

expand: WorkItemExpand

Rozwiń parametry atrybutów elementu roboczego. Możliwe opcje to { Brak, Relacje, Pola, Łącza, Wszystkie }.

Zwraca

Promise<WorkItem>

getWorkItemIconJson(string, string, number)

Pobierz ikonę elementu roboczego pod względem przyjaznej nazwy i koloru ikony.

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

Parametry

icon: string

Nazwa ikony

color: string

6-cyfrowy szesnastkowy kolor ikony

v: number

Wersja ikony (używana tylko do unieważniania pamięci podręcznej)

Zwraca

Promise<WorkItemIcon>

getWorkItemIcons()

Pobierz listę wszystkich ikon elementów roboczych.

function getWorkItemIcons(): Promise<WorkItemIcon[]>

Zwraca

Promise<WorkItemIcon[]>

getWorkItemIconSvg(string, string, number)

Pobierz ikonę elementu roboczego pod względem przyjaznej nazwy i koloru ikony.

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

Parametry

icon: string

Nazwa ikony

color: string

6-cyfrowy szesnastkowy kolor ikony

v: number

Wersja ikony (używana tylko do unieważniania pamięci podręcznej)

Zwraca

Promise<any>

getWorkItemIconXaml(string, string, number)

Pobierz ikonę elementu roboczego pod względem przyjaznej nazwy i koloru ikony.

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

Parametry

icon: string

Nazwa ikony

color: string

6-cyfrowy szesnastkowy kolor ikony

v: number

Wersja ikony (używana tylko do unieważniania pamięci podręcznej)

Zwraca

Promise<any>

getWorkItemNextStatesOnCheckinAction(number[], string)

Zwraca następny stan dla podanych identyfikatorów elementów roboczych.

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

Parametry

ids: number[]

Lista identyfikatorów elementów roboczych

action: string

Możliwe działania. Obecnie obsługuje tylko meldowanie

Zwraca

Promise<WorkItemNextStateOnTransition[]>

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

Zwraca listę elementów roboczych (maksymalnie 200)

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

Parametry

ids: number[]

Rozdzielona przecinkami lista żądanych identyfikatorów elementów roboczych. (Maksymalnie dozwolone 200 identyfikatorów).

project: string

Identyfikator projektu lub nazwa projektu

fields: string[]

Rozdzielana przecinkami lista żądanych pól

asOf: Date

AsOf UTC ciąg daty i godziny

expand: WorkItemExpand

Rozwiń parametry atrybutów elementu roboczego. Możliwe opcje to { Brak, Relacje, Pola, Łącza, Wszystkie }.

errorPolicy: WorkItemErrorPolicy

Flaga służąca do kontrolowania zasad błędów w zbiorczym żądaniu pobierania elementów roboczych. Możliwe opcje to {Fail, Miit}.

Zwraca

Promise<WorkItem[]>

getWorkItemsBatch(WorkItemBatchGetRequest, string)

Pobiera elementy robocze dla listy identyfikatorów elementów roboczych (maksymalnie 200)

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

Parametry

workItemGetRequest: WorkItemBatchGetRequest

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<WorkItem[]>

getWorkItemStateColors(string[])

TYLKO WEWNĘTRZNA: Będzie używana do pracy na moim koncie. Pobieranie koloru stanu typu elementu roboczego dla wielu projektów

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

Parametry

projectNames: string[]

Zwraca

Promise<ProjectWorkItemStateColors[]>

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

Zwraca pojedynczy element roboczy z szablonu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

type: string

Nazwa typu elementu roboczego

fields: string

Rozdzielana przecinkami lista żądanych pól

asOf: Date

AsOf UTC ciąg daty i godziny

expand: WorkItemExpand

Rozwiń parametry atrybutów elementu roboczego. Możliwe opcje to { Brak, Relacje, Pola, Łącza, Wszystkie }.

Zwraca

Promise<WorkItem>

getWorkItemType(string, string)

Zwraca definicję typu elementu roboczego.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

type: string

Nazwa typu elementu roboczego

Zwraca

Promise<WorkItemType>

getWorkItemTypeCategories(string)

Pobierz wszystkie kategorie typów elementów roboczych.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<WorkItemTypeCategory[]>

getWorkItemTypeCategory(string, string)

Pobierz określoną kategorię typu elementu roboczego według nazwy.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

category: string

Nazwa kategorii

Zwraca

Promise<WorkItemTypeCategory>

getWorkItemTypeColorAndIcons(string[])

TYLKO WEWNĘTRZNA: Jest używana dla dostawców kolorów i ikon. Uzyskaj kolor typu dowcipu dla wielu projektów

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

Parametry

projectNames: string[]

Zwraca

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

getWorkItemTypeColors(string[])

TYLKO WEWNĘTRZNA: Będzie używana do pracy na moim koncie. Uzyskaj kolor typu dowcipu dla wielu projektów

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

Parametry

projectNames: string[]

Zwraca

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

getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)

Pobierz listę pól dla typu elementu roboczego ze szczegółowymi odwołaniami.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

type: string

Typ elementu roboczego.

expand: WorkItemTypeFieldsExpandLevel

Rozwiń poziom odpowiedzi interfejsu API. Właściwości: w celu uwzględnienia allowedvalues, wartości domyślnej, isRequired itp. jako części odpowiedzi; Brak: aby pominąć te właściwości.

Zwraca

Promise<WorkItemTypeFieldWithReferences[]>

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

Pobierz pole dla typu elementu roboczego ze szczegółowymi odwołaniami.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

type: string

Typ elementu roboczego.

field: string

expand: WorkItemTypeFieldsExpandLevel

Rozwiń poziom odpowiedzi interfejsu API. Właściwości: w celu uwzględnienia allowedvalues, wartości domyślnej, isRequired itp. jako części odpowiedzi; Brak: aby pominąć te właściwości.

Zwraca

Promise<WorkItemTypeFieldWithReferences>

getWorkItemTypes(string)

Zwraca listę typów elementów roboczych

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<WorkItemType[]>

getWorkItemTypeStates(string, string)

Zwraca nazwy stanów i kolory dla typu elementu roboczego.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

type: string

Nazwa stanu

Zwraca

Promise<WorkItemStateColor[]>

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

Pobiera wyniki zapytania na podstawie identyfikatora zapytania.

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

Parametry

id: string

Identyfikator zapytania.

project: string

Identyfikator projektu lub nazwa projektu

team: string

Identyfikator zespołu lub nazwa zespołu

timePrecision: boolean

Określa, czy używać precyzji czasu, czy nie.

top: number

Maksymalna liczba wyników do zwrócenia.

Zwraca

Promise<WorkItemQueryResult>

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

Pobiera wyniki zapytania, biorąc pod uwagę jego WIQL.

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

Parametry

wiql: Wiql

Zapytanie zawierające WIQL.

project: string

Identyfikator projektu lub nazwa projektu

team: string

Identyfikator zespołu lub nazwa zespołu

timePrecision: boolean

Określa, czy używać precyzji czasu, czy nie.

top: number

Maksymalna liczba wyników do zwrócenia.

Zwraca

Promise<WorkItemQueryResult>

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

Wykonuje zapytania dotyczące elementów roboczych połączonych z daną listą identyfikatorów URI artefaktów.

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

Parametry

artifactUriQuery: ArtifactUriQuery

Definiuje listę identyfikatorów URI artefaktów do wykonywania zapytań dotyczących elementów roboczych.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ArtifactUriQueryResult>

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

Pobieranie partii poprawek elementów roboczych z opcją dołączania usuniętych elementów

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>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

fields: string[]

Lista pól, które mają być zwracane w poprawkach elementu roboczego. Pomiń ten parametr, aby pobrać wszystkie pola z możliwością raportowania.

types: string[]

Lista typów do filtrowania wyników pod kątem określonych typów elementów roboczych. Pomiń ten parametr, aby pobrać poprawki elementów roboczych wszystkich typów elementów roboczych.

continuationToken: string

Określa znak wodny, od którego ma rozpocząć się partia. Pomiń ten parametr, aby uzyskać pierwszą partię poprawek.

startDateTime: Date

Data/godzina Do użycia jako punkt początkowy dla poprawek, wszystkie zmiany będą miały miejsce po tej dacie/godzinie. Nie można używać w połączeniu z parametrem "watermark".

includeIdentityRef: boolean

Zwraca odwołanie tożsamości zamiast wartości ciągu dla pól tożsamości.

includeDeleted: boolean

Określ, czy usunięty element ma zostać zwrócony.

includeTagRef: boolean

Określ, czy obiekty tagów powinny być zwracane dla pola System.Tags.

includeLatestOnly: boolean

Zwracanie tylko najnowszych wersji elementów roboczych, pomijając wszystkie poprawki historyczne

expand: ReportingRevisionsExpand

Zwracanie wszystkich pól w poprawkach elementów roboczych, w tym długich pól tekstowych, które nie są zwracane domyślnie

includeDiscussionChangesOnly: boolean

Zwróć tylko te poprawki elementów roboczych, w których zmieniono tylko pole historii

maxPageSize: number

Maksymalna liczba wyników do zwrócenia w tej partii

Zwraca

Promise<ReportingWorkItemRevisionsBatch>

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

Pobierz partię poprawek elementów roboczych. To żądanie może być używane, jeśli lista pól jest na tyle duża, że adres URL może przekroczyć limit długości.

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

Parametry

filter: ReportingWorkItemRevisionsFilter

Obiekt, który zawiera ustawienia żądania: filtr pola, filtr typu, format tożsamości

project: string

Identyfikator projektu lub nazwa projektu

continuationToken: string

Określa znak wodny, od którego ma rozpocząć się partia. Pomiń ten parametr, aby uzyskać pierwszą partię poprawek.

startDateTime: Date

Data/godzina Do użycia jako punkt początkowy dla poprawek, wszystkie zmiany będą miały miejsce po tej dacie/godzinie. Nie można używać w połączeniu z parametrem "watermark".

expand: ReportingRevisionsExpand

Zwraca

Promise<ReportingWorkItemRevisionsBatch>

replaceTemplate(WorkItemTemplate, string, string, string)

Zastąp zawartość szablonu

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

Parametry

templateContent: WorkItemTemplate

Zawartość szablonu do zastąpienia przez

project: string

Identyfikator projektu lub nazwa projektu

team: string

Identyfikator zespołu lub nazwa zespołu

templateId: string

Identyfikator szablonu

Zwraca

Promise<WorkItemTemplate>

restoreWorkItem(WorkItemDeleteUpdate, number, string)

Przywraca usunięty element roboczy z Kosza.

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

Parametry

payload: WorkItemDeleteUpdate

Paylod z instrukcjami aktualizowania flagi IsDeleted na false

id: number

Identyfikator elementu roboczego, który ma zostać przywrócony

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<WorkItemDelete>

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

Przeszukuje wszystkie zapytania, do których użytkownik ma dostęp w bieżącym projekcie

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

filter: string

Tekst, według którego mają być filtrowane zapytania.

top: number

Liczba zapytań do zwrócenia (wartość domyślna to 50, a maksymalna to 200).

expand: QueryExpand

includeDeleted: boolean

Uwzględnij usunięte zapytania i foldery

Zwraca

Promise<QueryHierarchyItemsResult>

sendMail(SendMailBody, string)

Metoda RESTful do wysyłania wiadomości e-mail dla wybranych/odpytywanych elementów roboczych.

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

Parametry

body: SendMailBody

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Zaktualizuj istniejący węzeł klasyfikacji.

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

Parametry

postedNode: WorkItemClassificationNode

Węzeł do utworzenia lub zaktualizowania.

project: string

Identyfikator projektu lub nazwa projektu

structureGroup: TreeStructureGroup

Grupa struktury węzła klasyfikacji, obszaru lub iteracji.

path: string

Ścieżka węzła klasyfikacji.

Zwraca

Promise<WorkItemClassificationNode>

updateField(UpdateWorkItemField, string, string)

Aktualizowanie pola.

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

Parametry

payload: UpdateWorkItemField

Payload zawiera żądaną wartość właściwości pola

fieldNameOrRefName: string

Nazwa/nazwa referencji pola, które ma zostać zaktualizowane

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<WorkItemField>

updateQuery(QueryHierarchyItem, string, string, boolean)

Aktualizowanie zapytania lub folderu. Pozwala to na aktualizowanie, zmienianie nazw i przenoszenie zapytań i folderów.

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

Parametry

queryUpdate: QueryHierarchyItem

Kwerenda do zaktualizowania.

project: string

Identyfikator projektu lub nazwa projektu

query: string

Identyfikator lub ścieżka zapytania do zaktualizowania.

undeleteDescendants: boolean

Cofnij usunięcie elementów podrzędnych tego folderu. Należy zauważyć, że nie spowoduje to przywrócenia zmian uprawnień, które zostały wcześniej zastosowane do potomków.

Zwraca

Promise<QueryHierarchyItem>

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

Aktualizuje pojedynczy element roboczy.

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

Parametry

document: JsonPatchDocument

Dokument poprawki JSON reprezentujący aktualizację

id: number

Identyfikator elementu roboczego do zaktualizowania

project: string

Identyfikator projektu lub nazwa projektu

validateOnly: boolean

Wskaż, czy chcesz tylko zweryfikować zmiany bez zapisywania elementu roboczego

bypassRules: boolean

Nie wymuszaj reguł typu elementu roboczego w tej aktualizacji

suppressNotifications: boolean

Nie uruchamiaj żadnych powiadomień o tej zmianie

expand: WorkItemExpand

Rozwiń parametry atrybutów elementu roboczego. Możliwe opcje to { Brak, Relacje, Pola, Łącza, Wszystkie }.

Zwraca

Promise<WorkItem>

updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)

Dodawanie/aktualizowanie typu elementu roboczego

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

Parametry

updateModel: WorkItemTypeTemplateUpdateModel

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ProvisioningResult>

Sprzężenie zwrotne

Czy ta strona była pomocna?

Udostępnij za pomocą

WorkItemTrackingRestClient class

Konstruktory

Właściwości

Metody

Szczegóły konstruktora

WorkItemTrackingRestClient(IVssRestClientOptions)

Parametry

Szczegóły właściwości

RESOURCE_AREA_ID

Wartość właściwości

Szczegóły metody

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

Parametry

Zwraca

createField(WorkItemField, string)

Parametry

Zwraca

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Parametry

Zwraca

createQuery(QueryHierarchyItem, string, string, boolean)

Parametry

Zwraca

createTemplate(WorkItemTemplate, string, string)

Parametry

Zwraca

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

Parametry

Zwraca

deleteClassificationNode(string, TreeStructureGroup, string, number)

Parametry

Zwraca

deleteField(string, string)

Parametry

Zwraca

deleteQuery(string, string)

Parametry

Zwraca

deleteTemplate(string, string, string)

Parametry

Zwraca

deleteWorkItem(number, string, boolean)

Parametry

Zwraca

destroyWorkItem(number, string)

Parametry

Zwraca

exportWorkItemTypeDefinition(string, string, boolean)

Parametry

Zwraca

getAccountMyWorkData(QueryOption)

Parametry

Zwraca

getAttachmentContent(string, string, string, boolean)

Parametry

Zwraca

getAttachmentZip(string, string, string, boolean)

Parametry

Zwraca

getClassificationNode(string, TreeStructureGroup, string, number)

Parametry

Zwraca

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

Parametry

Zwraca

getComment(number, number, string)

Parametry

Zwraca

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

Parametry

Zwraca

getDeletedWorkItem(number, string)

Parametry

Zwraca

getDeletedWorkItems(number[], string)

Parametry

Zwraca

getDeletedWorkItemShallowReferences(string)

Parametry