WorkItemTrackingRestClient class

Referentie

Pakket:: azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's

Extends: RestClientBase

Constructors

WorkItemTrackingRestClient(IVssRestClientOptions)

Eigenschappen

RESOURCE_AREA_ID

Methoden

createAttachment(any, string, string, string, string)	Uploadt een bijlage.
createField(WorkItemField, string)	Maak een nieuw veld.
createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Maak een nieuw classificatieknooppunt of werk een bestaand classificatieknooppunt bij.
createQuery(QueryHierarchyItem, string, string, boolean)	Hiermee maakt u een query of verplaatst u een query.
createTemplate(WorkItemTemplate, string, string)	Hiermee maakt u een sjabloon
createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)	Hiermee maakt u één werkitem.
deleteClassificationNode(string, TreeStructureGroup, string, number)	Een bestaand classificatieknooppunt verwijderen.
deleteField(string, string)	Hiermee verwijdert u het veld. Als u de verwijdering van een opgeslagen bestand ongedaan wilt maken, raadpleegt u DE API 'Veld bijwerken'.
deleteQuery(string, string)	Een query of map verwijderen. Hiermee verwijdert u elke machtigingswijziging voor de verwijderde query of map en alle onderliggende items ervan als deze een map is. Het is belangrijk te weten dat de verwijderde machtigingswijzigingen niet kunnen worden hersteld wanneer de query of map ongedaan wordt gemaakt.
deleteTemplate(string, string, string)	Hiermee verwijdert u de sjabloon met de opgegeven id
deleteWorkItem(number, string, boolean)	Hiermee verwijdert u het opgegeven werkitem en verzendt u dit naar de Prullenbak, zodat het indien nodig weer kan worden hersteld. Als de parameter destroy is ingesteld op waar, wordt het werkitem eventueel definitief vernietigd. WAARSCHUWING: Als de parameter destroy is ingesteld op true, worden werkitems die met deze opdracht zijn verwijderd, NIET naar de prullenbak verplaatst en is er geen manier om ze te herstellen na verwijdering. Het wordt aanbevolen deze parameter NIET te gebruiken. Als u dit doet, moet u deze parameter uiterst voorzichtig gebruiken.
destroyWorkItem(number, string)	Hiermee wordt het opgegeven werkitem definitief verwijderd uit de Prullenbak. Deze actie kan niet ongedaan worden gemaakt.
exportWorkItemTypeDefinition(string, string, boolean)	Type werkitem exporteren
getAccountMyWorkData(QueryOption)	ALLEEN INTERN: WORDT GEBRUIKT DOOR DE PAGINA MIJN WERK VAN ACCOUNT. Hiermee worden de details van werkitems Uitgevoerd, Gereed, Volgt en Activiteit geretourneerd.
getAttachmentContent(string, string, string, boolean)	Hiermee wordt een bijlage gedownload.
getAttachmentZip(string, string, string, boolean)	Hiermee wordt een bijlage gedownload.
getClassificationNode(string, TreeStructureGroup, string, number)	Hiermee haalt u het classificatieknooppunt voor een bepaald knooppuntpad op.
getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)	Hiermee haalt u de hoofdclassificatieknooppunten of een lijst met classificatieknooppunten op voor een bepaalde lijst met knooppunt-id's voor een bepaald project. Als de parameter ids wordt opgegeven, krijgt u een lijst met classificatieknooppunten voor deze id's. Anders krijgt u hoofdclassificatieknooppunten voor dit project.
getComment(number, number, string)	Hiermee haalt u een opmerking op voor een werkitem bij de opgegeven revisie.
getComments(number, string, number, number, CommentSortOrder)	Haalt het opgegeven aantal opmerkingen op voor een werkitem uit de opgegeven revisie.
getDeletedWorkItem(number, string)	Hiermee haalt u een verwijderd werkitem op uit de Prullenbak.
getDeletedWorkItems(number[], string)	Haalt de werkitems op uit de Prullenbak, waarvan de id's zijn opgegeven in de parameters
getDeletedWorkItemShallowReferences(string)	Hiermee haalt u een lijst op met de id's en de URL's van de verwijderde werkitems in de Prullenbak.
getField(string, string)	Hiermee haalt u informatie op over een specifiek veld.
getFields(string, GetFieldsExpand)	Retourneert informatie voor alle velden. De parameter project-id/-naam is optioneel.
getQueries(string, QueryExpand, number, boolean)	Hiermee haalt u de hoofdquery's en de onderliggende items op
getQueriesBatch(QueryBatchGetRequest, string)	Hiermee haalt u een lijst met query's op id's op (maximaal 1000)
getQuery(string, string, QueryExpand, number, boolean, boolean)	Haalt een afzonderlijke query en de onderliggende items op
getQueryResultCount(string, string, string, boolean, number)	Hiermee worden de resultaten van de query opgehaald op basis van de query-id.
getRecentActivityData()	Hiermee worden recente activiteiten van werkitems ophaalt
getRecentMentions()	ALLEEN INTERN: WORDT GEBRUIKT DOOR DE PAGINA MIJN WERK VAN ACCOUNT.
getRelationType(string)	Hiermee haalt u de definitie van het type werkitemrelatie op.
getRelationTypes()	Hiermee haalt u de relatietypen voor werkitems op.
getReportingLinksByLinkType(string, string[], string[], string, Date)	Koppelingen voor een batch met werkitems ophalen
getRevision(number, number, string, WorkItemExpand)	Retourneert een volledig gehydrateerd werkitem voor de aangevraagde revisie
getRevisions(number, string, number, number, WorkItemExpand)	Retourneert de lijst met revisies van volledig gehydrateerde werkitems, gepaginad.
getRootNodes(string, number)	Hiermee haalt u hoofdclassificatieknooppunten onder het project op.
getTemplate(string, string, string)	Hiermee haalt u de sjabloon met de opgegeven id op
getTemplates(string, string, string)	Sjabloon wordt ophaalt
getUpdate(number, number, string)	Retourneert één update voor een werkitem
getUpdates(number, string, number, number)	Retourneert de verschillen tussen revisies van werkitems
getWorkArtifactLinkTypes()	Haal de lijst op met uitgaande artefactkoppelingstypen voor het bijhouden van werkitems.
getWorkItem(number, string, string[], Date, WorkItemExpand)	Retourneert één werkitem.
getWorkItemIconJson(string, string, number)	Haal een werkitempictogram op met de beschrijvende naam en pictogramkleur.
getWorkItemIcons()	Een lijst met alle pictogrammen voor werkitems ophalen.
getWorkItemIconSvg(string, string, number)	Haal een werkitempictogram op met de beschrijvende naam en pictogramkleur.
getWorkItemIconXaml(string, string, number)	Haal een werkitempictogram op met de beschrijvende naam en pictogramkleur.
getWorkItemNextStatesOnCheckinAction(number[], string)	Retourneert de volgende status voor de opgegeven werkitem-id's.
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)	Retourneert een lijst met werkitems (maximaal 200)
getWorkItemsBatch(WorkItemBatchGetRequest, string)	Hiermee haalt u werkitems op voor een lijst met werkitem-id's (maximaal 200)
getWorkItemStateColors(string[])	ALLEEN INTERN: deze wordt gebruikt voor mijn accountwerkervaring. De statuskleur van het werkitemtype ophalen voor meerdere projecten
getWorkItemTemplate(string, string, string, Date, WorkItemExpand)	Retourneert één werkitem uit een sjabloon.
getWorkItemType(string, string)	Retourneert een definitie van het type werkitem.
getWorkItemTypeCategories(string)	Alle categorieën voor werkitemtypen ophalen.
getWorkItemTypeCategory(string, string)	Specifieke categorie voor werkitems ophalen op naam.
getWorkItemTypeColorAndIcons(string[])	ALLEEN INTERN: het wordt gebruikt voor kleur- en pictogramproviders. De wittypekleur voor meerdere projecten ophalen
getWorkItemTypeColors(string[])	ALLEEN INTERN: deze wordt gebruikt voor mijn accountwerkervaring. De wittypekleur voor meerdere projecten ophalen
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)	Een lijst met velden ophalen voor een type werkitem met gedetailleerde verwijzingen.
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)	Een veld ophalen voor een werkitemtype met gedetailleerde verwijzingen.
getWorkItemTypes(string)	Retourneert de lijst met typen werkitems
getWorkItemTypeStates(string, string)	Retourneert de statusnamen en kleuren voor een type werkitem.
queryById(string, string, string, boolean, number)	Hiermee worden de resultaten van de query opgehaald op basis van de query-id.
queryByWiql(Wiql, string, string, boolean, number)	Hiermee worden de resultaten van de query opgehaald op basis van de WIQL.
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)	Query's zijn gekoppeld aan een bepaalde lijst met artefact-URI's.
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)	Een batch met revisies van werkitems ophalen met de optie om verwijderde items op te halen
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)	Een batch met revisies van werkitems ophalen. Deze aanvraag kan worden gebruikt als de lijst met velden groot genoeg is om de URL over de lengtelimiet uit te voeren.
replaceTemplate(WorkItemTemplate, string, string, string)	Sjablooninhoud vervangen
restoreWorkItem(WorkItemDeleteUpdate, number, string)	Hiermee herstelt u het verwijderde werkitem uit de Prullenbak.
searchQueries(string, string, number, QueryExpand, boolean)	Doorzoekt alle query's waar de gebruiker toegang toe heeft in het huidige project
sendMail(SendMailBody, string)	RESTful-methode voor het verzenden van e-mail voor geselecteerde/opgevraagde werkitems.
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Een bestaand classificatieknooppunt bijwerken.
updateField(UpdateWorkItemField, string, string)	Een veld bijwerken.
updateQuery(QueryHierarchyItem, string, string, boolean)	Een query of map bijwerken. Hiermee kunt u query's en mappen bijwerken, hernoemen en verplaatsen.
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)	Updates één werkitem.
updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)	Een type werkitem toevoegen/bijwerken

Constructordetails

WorkItemTrackingRestClient(IVssRestClientOptions)

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

Parameters

options: IVssRestClientOptions

Eigenschapdetails

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Waarde van eigenschap

string

Methodedetails

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

Uploadt een bijlage.

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

Parameters

content: any

Inhoud die moet worden geüpload

project: string

Project-id of projectnaam

fileName: string

De naam van het bestand

uploadType: string

Uploadtype bijlage: Eenvoudig of Gesegmenteerd

areaPath: string

Pad van doelprojectgebied

Retouren

Promise<AttachmentReference>

createField(WorkItemField, string)

Maak een nieuw veld.

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

Parameters

workItemField: WorkItemField

Nieuwe velddefinitie

project: string

Project-id of projectnaam

Retouren

Promise<WorkItemField>

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Maak een nieuw classificatieknooppunt of werk een bestaand classificatieknooppunt bij.

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

Parameters

postedNode: WorkItemClassificationNode

Knooppunt om te maken of bij te werken.

project: string

Project-id of projectnaam

structureGroup: TreeStructureGroup

Structuurgroep van het classificatieknooppunt, -gebied of -iteratie.

path: string

Pad van het classificatieknooppunt.

Retouren

Promise<WorkItemClassificationNode>

createQuery(QueryHierarchyItem, string, string, boolean)

Hiermee maakt u een query of verplaatst u een query.

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

Parameters

postedQuery: QueryHierarchyItem

De query die moet worden gemaakt.

project: string

Project-id of projectnaam

query: string

De bovenliggende id of het pad waaronder de query moet worden gemaakt.

validateWiqlOnly: boolean

Als u alleen uw WIQL-query wilt valideren zonder er een te maken, stelt u deze in op true. De standaardinstelling is onwaar.

Retouren

Promise<QueryHierarchyItem>

createTemplate(WorkItemTemplate, string, string)

Hiermee maakt u een sjabloon

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

Parameters

template: WorkItemTemplate

Sjablooninhoud

project: string

Project-id of projectnaam

team: string

Team-id of teamnaam

Retouren

Promise<WorkItemTemplate>

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

Hiermee maakt u één werkitem.

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

Parameters

document: JsonPatchDocument

Het JSON Patch-document dat het werkitem vertegenwoordigt

project: string

Project-id of projectnaam

type: string

Het type werkitem van het werkitem dat moet worden gemaakt

validateOnly: boolean

Geef aan of u alleen de wijzigingen wilt valideren zonder het werkitem op te slaan

bypassRules: boolean

De regels voor het type werkitem niet afdwingen voor deze update

suppressNotifications: boolean

Geen meldingen voor deze wijziging activeren

expand: WorkItemExpand

De uitvouwparameters voor kenmerken van werkitems. Mogelijke opties zijn { Geen, Relaties, Velden, Koppelingen, Alle }.

Retouren

Promise<WorkItem>

deleteClassificationNode(string, TreeStructureGroup, string, number)

Een bestaand classificatieknooppunt verwijderen.

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

Parameters

project: string

Project-id of projectnaam

structureGroup: TreeStructureGroup

Structuurgroep van het classificatieknooppunt, -gebied of -iteratie.

path: string

Pad van het classificatieknooppunt.

reclassifyId: number

Id van het doelclassificatieknooppunt voor herclassificatie.

Retouren

Promise<void>

deleteField(string, string)

Hiermee verwijdert u het veld. Als u de verwijdering van een opgeslagen bestand ongedaan wilt maken, raadpleegt u DE API 'Veld bijwerken'.

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

Parameters

fieldNameOrRefName: string

Eenvoudige veldnaam of verwijzingsnaam

project: string

Project-id of projectnaam

Retouren

Promise<void>

deleteQuery(string, string)

Een query of map verwijderen. Hiermee verwijdert u elke machtigingswijziging voor de verwijderde query of map en alle onderliggende items ervan als deze een map is. Het is belangrijk te weten dat de verwijderde machtigingswijzigingen niet kunnen worden hersteld wanneer de query of map ongedaan wordt gemaakt.

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

Parameters

project: string

Project-id of projectnaam

query: string

Id of pad van de query of map die u wilt verwijderen.

Retouren

Promise<void>

deleteTemplate(string, string, string)

Hiermee verwijdert u de sjabloon met de opgegeven id

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

Parameters

project: string

Project-id of projectnaam

team: string

Team-id of teamnaam

templateId: string

Sjabloon-id

Retouren

Promise<void>

deleteWorkItem(number, string, boolean)

Hiermee verwijdert u het opgegeven werkitem en verzendt u dit naar de Prullenbak, zodat het indien nodig weer kan worden hersteld. Als de parameter destroy is ingesteld op waar, wordt het werkitem eventueel definitief vernietigd. WAARSCHUWING: Als de parameter destroy is ingesteld op true, worden werkitems die met deze opdracht zijn verwijderd, NIET naar de prullenbak verplaatst en is er geen manier om ze te herstellen na verwijdering. Het wordt aanbevolen deze parameter NIET te gebruiken. Als u dit doet, moet u deze parameter uiterst voorzichtig gebruiken.

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

Parameters

id: number

Id van het werkitem dat moet worden verwijderd

project: string

Project-id of projectnaam

destroy: boolean

Als de optionele parameter is ingesteld op true, wordt het werkitem definitief verwijderd. Let op: de vernietigingsactie is PERMANENT en kan niet ongedaan worden gemaakt.

Retouren

Promise<WorkItemDelete>

destroyWorkItem(number, string)

Hiermee wordt het opgegeven werkitem definitief verwijderd uit de Prullenbak. Deze actie kan niet ongedaan worden gemaakt.

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

Parameters

id: number

Id van het werkitem dat permanent moet worden vernietigd

project: string

Project-id of projectnaam

Retouren

Promise<void>

exportWorkItemTypeDefinition(string, string, boolean)

Type werkitem exporteren

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

Parameters

project: string

Project-id of projectnaam

type: string

exportGlobalLists: boolean

Retouren

Promise<WorkItemTypeTemplate>

getAccountMyWorkData(QueryOption)

ALLEEN INTERN: WORDT GEBRUIKT DOOR DE PAGINA MIJN WERK VAN ACCOUNT. Hiermee worden de details van werkitems Uitgevoerd, Gereed, Volgt en Activiteit geretourneerd.

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

Parameters

queryOption: QueryOption

Retouren

Promise<AccountMyWorkResult>

getAttachmentContent(string, string, string, boolean)

Hiermee wordt een bijlage gedownload.

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

Parameters

id: string

Bijlage-id

project: string

Project-id of projectnaam

fileName: string

Naam van het bestand

download: boolean

Als deze is ingesteld op <c>true</c> , altijd bijlage downloaden

Retouren

Promise<ArrayBuffer>

getAttachmentZip(string, string, string, boolean)

Hiermee wordt een bijlage gedownload.

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

Parameters

id: string

Bijlage-id

project: string

Project-id of projectnaam

fileName: string

Naam van het bestand

download: boolean

Als deze is ingesteld op <c>true</c> , altijd bijlage downloaden

Retouren

Promise<ArrayBuffer>

getClassificationNode(string, TreeStructureGroup, string, number)

Hiermee haalt u het classificatieknooppunt voor een bepaald knooppuntpad op.

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

Parameters

project: string

Project-id of projectnaam

structureGroup: TreeStructureGroup

Structuurgroep van het classificatieknooppunt, -gebied of -iteratie.

path: string

Pad van het classificatieknooppunt.

depth: number

Diepte van op te halen onderliggende items.

Retouren

Promise<WorkItemClassificationNode>

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

Hiermee haalt u de hoofdclassificatieknooppunten of een lijst met classificatieknooppunten op voor een bepaalde lijst met knooppunt-id's voor een bepaald project. Als de parameter ids wordt opgegeven, krijgt u een lijst met classificatieknooppunten voor deze id's. Anders krijgt u hoofdclassificatieknooppunten voor dit project.

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

Parameters

project: string

Project-id of projectnaam

ids: number[]

Id's van door komma's gescheiden classificatieknooppunten. Dit is niet vereist als u hoofdknooppunten wilt.

depth: number

Diepte van op te halen onderliggende items.

errorPolicy: ClassificationNodesErrorPolicy

Vlag voor het afhandelen van fouten bij het verkrijgen van sommige knooppunten. Mogelijke opties zijn Fail en Weglaten.

Retouren

Promise<WorkItemClassificationNode[]>

getComment(number, number, string)

Hiermee haalt u een opmerking op voor een werkitem bij de opgegeven revisie.

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

Parameters

id: number

Werkitem-id

revision: number

Revisie waarvoor de opmerking moet worden opgehaald

project: string

Project-id of projectnaam

Retouren

Promise<WorkItemComment>

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

Haalt het opgegeven aantal opmerkingen op voor een werkitem uit de opgegeven revisie.

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

Parameters

id: number

Werkitem-id

project: string

Project-id of projectnaam

fromRevision: number

Revisie waaruit opmerkingen moeten worden opgehaald (standaard is 1)

top: number

Het aantal opmerkingen dat moet worden geretourneerd (de standaardwaarde is 200)

order: CommentSortOrder

Oplopend of aflopend op revisie-id (standaard is oplopend)

Retouren

Promise<WorkItemComments>

getDeletedWorkItem(number, string)

Hiermee haalt u een verwijderd werkitem op uit de Prullenbak.

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

Parameters

id: number

Id van het werkitem dat moet worden geretourneerd

project: string

Project-id of projectnaam

Retouren

Promise<WorkItemDelete>

getDeletedWorkItems(number[], string)

Haalt de werkitems op uit de Prullenbak, waarvan de id's zijn opgegeven in de parameters

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

Parameters

ids: number[]

Door komma's gescheiden lijst met id's van de verwijderde werkitems die moeten worden geretourneerd

project: string

Project-id of projectnaam

Retouren

Promise<WorkItemDeleteReference[]>

getDeletedWorkItemShallowReferences(string)

Hiermee haalt u een lijst op met de id's en de URL's van de verwijderde werkitems in de Prullenbak.

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

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<WorkItemDeleteShallowReference[]>

getField(string, string)

Hiermee haalt u informatie op over een specifiek veld.

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

Parameters

fieldNameOrRefName: string

Eenvoudige veldnaam of verwijzingsnaam

project: string

Project-id of projectnaam

Retouren

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

Retourneert informatie voor alle velden. De parameter project-id/-naam is optioneel.

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

Parameters

project: string

Project-id of projectnaam

expand: GetFieldsExpand

Gebruik ExtensionFields om extensievelden op te nemen, anders worden deze uitgesloten. Tenzij de functievlag voor deze parameter is ingeschakeld, worden extensievelden altijd opgenomen.

Retouren

Promise<WorkItemField[]>

getQueries(string, QueryExpand, number, boolean)

Hiermee haalt u de hoofdquery's en de onderliggende items op

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

Parameters

project: string

Project-id of projectnaam

expand: QueryExpand

Neem de queryreeks (wiql), componenten, kolommen met queryresultaten en sorteeropties op in de resultaten.

depth: number

Retourneer onderliggende query's en mappen in de map met query's naar deze diepte.

includeDeleted: boolean

Verwijderde query's en mappen opnemen

Retouren

Promise<QueryHierarchyItem[]>

getQueriesBatch(QueryBatchGetRequest, string)

Hiermee haalt u een lijst met query's op id's op (maximaal 1000)

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

Parameters

queryGetRequest: QueryBatchGetRequest

project: string

Project-id of projectnaam

Retouren

Promise<QueryHierarchyItem[]>

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

Haalt een afzonderlijke query en de onderliggende items op

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

Parameters

project: string

Project-id of projectnaam

query: string

Id of pad van de query.

expand: QueryExpand

Neem de queryreeks (wiql), componenten, kolommen met queryresultaten en sorteeropties op in de resultaten.

depth: number

Retourneer onderliggende query's en mappen in de map met query's naar deze diepte.

includeDeleted: boolean

Verwijderde query's en mappen opnemen

useIsoDateFormat: boolean

DateTime-querycomponenten worden opgemaakt met een ISO 8601-compatibele indeling

Retouren

Promise<QueryHierarchyItem>

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

Hiermee worden de resultaten van de query opgehaald op basis van de query-id.

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

Parameters

id: string

De query-id.

project: string

Project-id of projectnaam

team: string

Team-id of teamnaam

timePrecision: boolean

Of tijdprecisie al dan niet moet worden gebruikt.

top: number

Het maximum aantal resultaten dat moet worden geretourneerd.

Retouren

Promise<number>

getRecentActivityData()

Hiermee worden recente activiteiten van werkitems ophaalt

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Retouren

Promise<AccountRecentActivityWorkItemModel2[]>

getRecentMentions()

ALLEEN INTERN: WORDT GEBRUIKT DOOR DE PAGINA MIJN WERK VAN ACCOUNT.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Retouren

Promise<AccountRecentMentionWorkItemModel[]>

getRelationType(string)

Hiermee haalt u de definitie van het type werkitemrelatie op.

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

Parameters

relation: string

De naam van de relatie

Retouren

Promise<WorkItemRelationType>

getRelationTypes()

Hiermee haalt u de relatietypen voor werkitems op.

function getRelationTypes(): Promise<WorkItemRelationType[]>

Retouren

Promise<WorkItemRelationType[]>

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

Koppelingen voor een batch met werkitems ophalen

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

Parameters

project: string

Project-id of projectnaam

linkTypes: string[]

Een lijst met typen om de resultaten te filteren op specifieke koppelingstypen. Laat deze parameter weg om werkitemkoppelingen van alle koppelingstypen op te halen.

types: string[]

Een lijst met typen om de resultaten te filteren op specifieke typen werkitems. Laat deze parameter weg om koppelingen naar werkitems van alle typen werkitems op te halen.

continuationToken: string

Hiermee geeft u het continuationToken op waaruit de batch moet worden gestart. Laat deze parameter weg om de eerste batch koppelingen op te halen.

startDateTime: Date

Datum/tijd die moet worden gebruikt als beginpunt voor koppelingswijzigingen. Alleen koppelingswijzigingen die na die datum/tijd zijn opgetreden, worden geretourneerd. Kan niet worden gebruikt in combinatie met de parameter 'watermark'.

Retouren

Promise<ReportingWorkItemLinksBatch>

getRevision(number, number, string, WorkItemExpand)

Retourneert een volledig gehydrateerd werkitem voor de aangevraagde revisie

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

Parameters

id: number

revisionNumber: number

project: string

Project-id of projectnaam

expand: WorkItemExpand

Retouren

Promise<WorkItem>

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

Retourneert de lijst met revisies van volledig gehydrateerde werkitems, gepaginad.

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

Parameters

id: number

project: string

Project-id of projectnaam

top: number

skip: number

expand: WorkItemExpand

Retouren

Promise<WorkItem[]>

getRootNodes(string, number)

Hiermee haalt u hoofdclassificatieknooppunten onder het project op.

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

Parameters

project: string

Project-id of projectnaam

depth: number

Diepte van op te halen onderliggende items.

Retouren

Promise<WorkItemClassificationNode[]>

getTemplate(string, string, string)

Hiermee haalt u de sjabloon met de opgegeven id op

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

Parameters

project: string

Project-id of projectnaam

team: string

Team-id of teamnaam

templateId: string

Sjabloon-id

Retouren

Promise<WorkItemTemplate>

getTemplates(string, string, string)

Sjabloon wordt ophaalt

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

Parameters

project: string

Project-id of projectnaam

team: string

Team-id of teamnaam

workitemtypename: string

Optioneel. Wanneer opgegeven retourneert sjablonen voor het opgegeven type werkitem.

Retouren

Promise<WorkItemTemplateReference[]>

getUpdate(number, number, string)

Retourneert één update voor een werkitem

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

Parameters

id: number

updateNumber: number

project: string

Project-id of projectnaam

Retouren

Promise<WorkItemUpdate>

getUpdates(number, string, number, number)

Retourneert de verschillen tussen revisies van werkitems

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

Parameters

id: number

project: string

Project-id of projectnaam

top: number

skip: number

Retouren

Promise<WorkItemUpdate[]>

getWorkArtifactLinkTypes()

Haal de lijst op met uitgaande artefactkoppelingstypen voor het bijhouden van werkitems.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

Retouren

Promise<WorkArtifactLink[]>

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

Retourneert één werkitem.

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

Parameters

id: number

De id van het werkitem

project: string

Project-id of projectnaam

fields: string[]

Door komma's gescheiden lijst met aangevraagde velden

asOf: Date

AsOf UTC-datum/tijdtekenreeks

expand: WorkItemExpand

De uitvouwparameters voor kenmerken van werkitems. Mogelijke opties zijn { Geen, Relaties, Velden, Koppelingen, Alle }.

Retouren

Promise<WorkItem>

getWorkItemIconJson(string, string, number)

Haal een werkitempictogram op met de beschrijvende naam en pictogramkleur.

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

Parameters

icon: string

De naam van het pictogram

color: string

De zescijferige hexkleur voor het pictogram

v: number

De versie van het pictogram (alleen gebruikt voor ongeldige cache)

Retouren

Promise<WorkItemIcon>

getWorkItemIcons()

Een lijst met alle pictogrammen voor werkitems ophalen.

function getWorkItemIcons(): Promise<WorkItemIcon[]>

Retouren

Promise<WorkItemIcon[]>

getWorkItemIconSvg(string, string, number)

Haal een werkitempictogram op met de beschrijvende naam en pictogramkleur.

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

Parameters

icon: string

De naam van het pictogram

color: string

De zescijferige hexkleur voor het pictogram

v: number

De versie van het pictogram (alleen gebruikt voor ongeldige cache)

Retouren

Promise<any>

getWorkItemIconXaml(string, string, number)

Haal een werkitempictogram op met de beschrijvende naam en pictogramkleur.

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

Parameters

icon: string

De naam van het pictogram

color: string

De zescijferige hexkleur voor het pictogram

v: number

De versie van het pictogram (alleen gebruikt voor ongeldige cache)

Retouren

Promise<any>

getWorkItemNextStatesOnCheckinAction(number[], string)

Retourneert de volgende status voor de opgegeven werkitem-id's.

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

Parameters

ids: number[]

lijst met werkitem-id's

action: string

mogelijke acties. Momenteel wordt alleen inchecken ondersteund

Retouren

Promise<WorkItemNextStateOnTransition[]>

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

Retourneert een lijst met werkitems (maximaal 200)

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

Parameters

ids: number[]

De door komma's gescheiden lijst met aangevraagde werkitem-id's. (Maximaal 200 id's toegestaan).

project: string

Project-id of projectnaam

fields: string[]

Door komma's gescheiden lijst met aangevraagde velden

asOf: Date

AsOf UTC-datum/tijdtekenreeks

expand: WorkItemExpand

De uitvouwparameters voor kenmerken van werkitems. Mogelijke opties zijn { Geen, Relaties, Velden, Koppelingen, Alle }.

errorPolicy: WorkItemErrorPolicy

De vlag voor het beheren van foutbeleid in een aanvraag voor bulksgewijs ophalen van werkitems. Mogelijke opties zijn {Fail, Wegit}.

Retouren

Promise<WorkItem[]>

getWorkItemsBatch(WorkItemBatchGetRequest, string)

Hiermee haalt u werkitems op voor een lijst met werkitem-id's (maximaal 200)

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

Parameters

workItemGetRequest: WorkItemBatchGetRequest

project: string

Project-id of projectnaam

Retouren

Promise<WorkItem[]>

getWorkItemStateColors(string[])

ALLEEN INTERN: deze wordt gebruikt voor mijn accountwerkervaring. De statuskleur van het werkitemtype ophalen voor meerdere projecten

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

Parameters

projectNames: string[]

Retouren

Promise<ProjectWorkItemStateColors[]>

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

Retourneert één werkitem uit een sjabloon.

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

Parameters

project: string

Project-id of projectnaam

type: string

De naam van het type werkitem

fields: string

Door komma's gescheiden lijst met aangevraagde velden

asOf: Date

AsOf UTC-datum/tijdtekenreeks

expand: WorkItemExpand

De uitvouwparameters voor kenmerken van werkitems. Mogelijke opties zijn { Geen, Relaties, Velden, Koppelingen, Alle }.

Retouren

Promise<WorkItem>

getWorkItemType(string, string)

Retourneert een definitie van het type werkitem.

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

Parameters

project: string

Project-id of projectnaam

type: string

Naam van werkitemtype

Retouren

Promise<WorkItemType>

getWorkItemTypeCategories(string)

Alle categorieën voor werkitemtypen ophalen.

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

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<WorkItemTypeCategory[]>

getWorkItemTypeCategory(string, string)

Specifieke categorie voor werkitems ophalen op naam.

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

Parameters

project: string

Project-id of projectnaam

category: string

De naam van de categorie

Retouren

Promise<WorkItemTypeCategory>

getWorkItemTypeColorAndIcons(string[])

ALLEEN INTERN: het wordt gebruikt voor kleur- en pictogramproviders. De wittypekleur voor meerdere projecten ophalen

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

Parameters

projectNames: string[]

Retouren

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

getWorkItemTypeColors(string[])

ALLEEN INTERN: deze wordt gebruikt voor mijn accountwerkervaring. De wittypekleur voor meerdere projecten ophalen

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

Parameters

projectNames: string[]

Retouren

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

getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)

Een lijst met velden ophalen voor een type werkitem met gedetailleerde verwijzingen.

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

Parameters

project: string

Project-id of projectnaam

type: string

Type werkitem.

expand: WorkItemTypeFieldsExpandLevel

Vouw het niveau voor het API-antwoord uit. Eigenschappen: om toegestane waarden, standaardwaarde, isRequired etc. op te nemen als onderdeel van het antwoord; Geen: om deze eigenschappen over te slaan.

Retouren

Promise<WorkItemTypeFieldWithReferences[]>

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

Een veld ophalen voor een werkitemtype met gedetailleerde verwijzingen.

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

Parameters

project: string

Project-id of projectnaam

type: string

Type werkitem.

field: string

expand: WorkItemTypeFieldsExpandLevel

Retouren

Promise<WorkItemTypeFieldWithReferences>

getWorkItemTypes(string)

Retourneert de lijst met typen werkitems

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

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<WorkItemType[]>

getWorkItemTypeStates(string, string)

Retourneert de statusnamen en kleuren voor een type werkitem.

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

Parameters

project: string

Project-id of projectnaam

type: string

De naam van de staat

Retouren

Promise<WorkItemStateColor[]>

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

Hiermee worden de resultaten van de query opgehaald op basis van de query-id.

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

Parameters

id: string

De query-id.

project: string

Project-id of projectnaam

team: string

Team-id of teamnaam

timePrecision: boolean

Of tijdprecisie al dan niet moet worden gebruikt.

top: number

Het maximum aantal resultaten dat moet worden geretourneerd.

Retouren

Promise<WorkItemQueryResult>

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

Hiermee worden de resultaten van de query opgehaald op basis van de WIQL.

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

Parameters

wiql: Wiql

De query die de WIQL bevat.

project: string

Project-id of projectnaam

team: string

Team-id of teamnaam

timePrecision: boolean

Of tijdprecisie al dan niet moet worden gebruikt.

top: number

Het maximum aantal resultaten dat moet worden geretourneerd.

Retouren

Promise<WorkItemQueryResult>

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

Query's zijn gekoppeld aan een bepaalde lijst met artefact-URI's.

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

Parameters

artifactUriQuery: ArtifactUriQuery

Definieert een lijst met artefact-URI voor het uitvoeren van query's op werkitems.

project: string

Project-id of projectnaam

Retouren

Promise<ArtifactUriQueryResult>

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

Een batch met revisies van werkitems ophalen met de optie om verwijderde items op te halen

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>

Parameters

project: string

Project-id of projectnaam

fields: string[]

Een lijst met velden die moeten worden geretourneerd in revisies van werkitems. Laat deze parameter weg om alle te rapporteren velden op te halen.

types: string[]

Een lijst met typen om de resultaten te filteren op specifieke typen werkitems. Laat deze parameter weg om revisies van werkitems van alle typen werkitems op te halen.

continuationToken: string

Hiermee geeft u het watermerk op waaruit de batch moet worden gestart. Laat deze parameter weg om de eerste batch revisies op te halen.

startDateTime: Date

Datum/tijd die moet worden gebruikt als beginpunt voor revisies. Alle revisies vinden plaats na deze datum/tijd. Kan niet worden gebruikt in combinatie met de parameter 'watermark'.

includeIdentityRef: boolean

Retourneert een identiteitsreferentie in plaats van een tekenreekswaarde voor identiteitsvelden.

includeDeleted: boolean

Geef op of het verwijderde item moet worden geretourneerd.

includeTagRef: boolean

Geef op of de tagobjecten moeten worden geretourneerd voor het veld System.Tags.

includeLatestOnly: boolean

Alleen de meest recente revisies van werkitems retourneren, waarbij alle historische revisies worden overgeslagen

expand: ReportingRevisionsExpand

Alle velden in revisies van werkitems retourneren, inclusief lange tekstvelden die niet standaard worden geretourneerd

includeDiscussionChangesOnly: boolean

Alleen de revisies van werkitems retourneren, waarbij alleen het geschiedenisveld is gewijzigd

maxPageSize: number

Het maximum aantal resultaten dat in deze batch moet worden geretourneerd

Retouren

Promise<ReportingWorkItemRevisionsBatch>

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

Een batch met revisies van werkitems ophalen. Deze aanvraag kan worden gebruikt als de lijst met velden groot genoeg is om de URL over de lengtelimiet uit te voeren.

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

Parameters

filter: ReportingWorkItemRevisionsFilter

Een object dat aanvraaginstellingen bevat: veldfilter, typefilter, identiteitsindeling

project: string

Project-id of projectnaam

continuationToken: string

Hiermee geeft u het watermerk op waaruit de batch moet worden gestart. Laat deze parameter weg om de eerste batch revisies op te halen.

startDateTime: Date

Datum/tijd die moet worden gebruikt als beginpunt voor revisies. Alle revisies vinden plaats na deze datum/tijd. Kan niet worden gebruikt in combinatie met de parameter 'watermark'.

expand: ReportingRevisionsExpand

Retouren

Promise<ReportingWorkItemRevisionsBatch>

replaceTemplate(WorkItemTemplate, string, string, string)

Sjablooninhoud vervangen

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

Parameters

templateContent: WorkItemTemplate

Sjablooninhoud die moet worden vervangen door

project: string

Project-id of projectnaam

team: string

Team-id of teamnaam

templateId: string

Sjabloon-id

Retouren

Promise<WorkItemTemplate>

restoreWorkItem(WorkItemDeleteUpdate, number, string)

Hiermee herstelt u het verwijderde werkitem uit de Prullenbak.

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

Parameters

payload: WorkItemDeleteUpdate

Paylod met instructies voor het bijwerken van de vlag IsDeleted naar false

id: number

Id van het werkitem dat moet worden hersteld

project: string

Project-id of projectnaam

Retouren

Promise<WorkItemDelete>

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

Doorzoekt alle query's waar de gebruiker toegang toe heeft in het huidige project

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

Parameters

project: string

Project-id of projectnaam

filter: string

De tekst waarmee de query's moeten worden gefilterd.

top: number

Het aantal query's dat moet worden geretourneerd (standaard 50 en maximum is 200).

expand: QueryExpand

includeDeleted: boolean

Verwijderde query's en mappen opnemen

Retouren

Promise<QueryHierarchyItemsResult>

sendMail(SendMailBody, string)

RESTful-methode voor het verzenden van e-mail voor geselecteerde/opgevraagde werkitems.

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

Parameters

body: SendMailBody

project: string

Project-id of projectnaam

Retouren

Promise<void>

updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Een bestaand classificatieknooppunt bijwerken.

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

Parameters

postedNode: WorkItemClassificationNode

Knooppunt om te maken of bij te werken.

project: string

Project-id of projectnaam

structureGroup: TreeStructureGroup

Structuurgroep van het classificatieknooppunt, -gebied of -iteratie.

path: string

Pad van het classificatieknooppunt.

Retouren

Promise<WorkItemClassificationNode>

updateField(UpdateWorkItemField, string, string)

Een veld bijwerken.

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

Parameters

payload: UpdateWorkItemField

Payload bevat de gewenste waarde van de eigenschappen van het veld

fieldNameOrRefName: string

Naam/verwijzingsnaam van het veld dat moet worden bijgewerkt

project: string

Project-id of projectnaam

Retouren

Promise<WorkItemField>

updateQuery(QueryHierarchyItem, string, string, boolean)

Een query of map bijwerken. Hiermee kunt u query's en mappen bijwerken, hernoemen en verplaatsen.

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

Parameters

queryUpdate: QueryHierarchyItem

De query die moet worden bijgewerkt.

project: string

Project-id of projectnaam

query: string

De id of het pad voor de query die moet worden bijgewerkt.

undeleteDescendants: boolean

De verwijdering van de onderliggende items van deze map ongedaan maken. Het is belangrijk om te weten dat hiermee niet de machtigingswijzigingen worden geretourneerd die eerder zijn toegepast op de onderliggende exemplaren.

Retouren

Promise<QueryHierarchyItem>

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

Updates één werkitem.

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

Parameters

document: JsonPatchDocument

Het JSON Patch-document dat de update vertegenwoordigt

id: number

De id van het werkitem dat moet worden bijgewerkt

project: string

Project-id of projectnaam

validateOnly: boolean

Geef aan of u alleen de wijzigingen wilt valideren zonder het werkitem op te slaan

bypassRules: boolean

De regels voor het type werkitem niet afdwingen voor deze update

suppressNotifications: boolean

Geen meldingen voor deze wijziging activeren

expand: WorkItemExpand

De uitvouwparameters voor kenmerken van werkitems. Mogelijke opties zijn { Geen, Relaties, Velden, Koppelingen, Alle }.

Retouren

Promise<WorkItem>

updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)

Een type werkitem toevoegen/bijwerken

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

Parameters

updateModel: WorkItemTypeTemplateUpdateModel

project: string

Project-id of projectnaam

Retouren

Promise<ProvisioningResult>

Delen via

WorkItemTrackingRestClient class

Constructors

Eigenschappen

Methoden

Constructordetails

WorkItemTrackingRestClient(IVssRestClientOptions)

Parameters

Eigenschapdetails

RESOURCE_AREA_ID

Waarde van eigenschap

Methodedetails

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

Parameters

Retouren

createField(WorkItemField, string)

Parameters

Retouren

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Parameters

Retouren

createQuery(QueryHierarchyItem, string, string, boolean)

Parameters

Retouren

createTemplate(WorkItemTemplate, string, string)

Parameters

Retouren

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

Parameters

Retouren

deleteClassificationNode(string, TreeStructureGroup, string, number)

Parameters

Retouren

deleteField(string, string)

Parameters

Retouren

deleteQuery(string, string)

Parameters

Retouren

deleteTemplate(string, string, string)

Parameters

Retouren

deleteWorkItem(number, string, boolean)

Parameters

Retouren

destroyWorkItem(number, string)

Parameters

Retouren

exportWorkItemTypeDefinition(string, string, boolean)

Parameters

Retouren

getAccountMyWorkData(QueryOption)

Parameters

Retouren

getAttachmentContent(string, string, string, boolean)

Parameters

Retouren

getAttachmentZip(string, string, string, boolean)

Parameters

Retouren

getClassificationNode(string, TreeStructureGroup, string, number)

Parameters

Retouren

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

Parameters

Retouren

getComment(number, number, string)

Parameters

Retouren

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

Parameters

Retouren

getDeletedWorkItem(number, string)

Parameters

Retouren

getDeletedWorkItems(number[], string)

Parameters

Retouren

getDeletedWorkItemShallowReferences(string)

Parameters