WorkItemTrackingRestClient class
Basisklasse, die verwendet (von abgeleitet) werden soll, um Anforderungen an VSS-REST-APIs zu senden
- Extends
Konstruktoren
| Work |
Eigenschaften
| RESOURCE_AREA_ID |
Methoden
| create |
Lädt eine Anlage hoch. |
| create |
Erstellen Sie ein neues Feld. |
| create |
Erstellen Sie einen neuen, oder aktualisieren Sie einen vorhandenen Klassifizierungsknoten. |
| create |
Erstellt eine Abfrage oder verschiebt eine Abfrage. |
| create |
Erstellt eine Vorlage |
| create |
Erstellt ein einzelnes Arbeitselement. |
| delete |
Löschen Sie einen vorhandenen Klassifizierungsknoten. |
| delete |
Löscht das Feld. Informationen zum Wiederherstellen eines abgelegten Vorgangs finden Sie unter "Feld aktualisieren"-API. |
| delete |
Löschen Sie eine Abfrage oder einen Ordner. Dadurch werden alle Berechtigungsänderungen für die gelöschte Abfrage oder den gelöschten Ordner und alle untergeordneten Elemente gelöscht, wenn es sich um einen Ordner handelt. Es ist wichtig zu beachten, dass die gelöschten Berechtigungsänderungen nicht wiederhergestellt werden können, wenn sie die Abfrage oder den Ordner wiederherstellen. |
| delete |
Löscht die Vorlage mit der angegebenen ID. |
| delete |
Löscht das angegebene Arbeitselement und sendet es an den Papierkorb, damit es bei Bedarf wiederhergestellt werden kann. Wenn der Destroy-Parameter auf true festgelegt wurde, wird das Arbeitselement optional dauerhaft zerstört. WARNUNG: Wenn der Destroy-Parameter auf true festgelegt ist, werden mit diesem Befehl gelöschte Arbeitselemente NICHT in den Papierkorb verschoben, und es gibt keine Möglichkeit, sie nach dem Löschen wiederherzustellen/wiederherzustellen. Es wird empfohlen, diesen Parameter NICHT zu verwenden. Wenn Sie dies tun, verwenden Sie diesen Parameter mit äußerster Vorsicht. |
| destroy |
Zerstört das angegebene Arbeitselement dauerhaft aus dem Papierkorb. Diese Aktion kann nicht rückgängig werden. |
| export |
Exportieren des Arbeitselementtyps |
| get |
NUR INTERN: WIRD VOM KONTO MEINE ARBEITSSEITE VERWENDET. Dadurch werden Die Arbeitselemente "Doing", "Done", "Follows" und "Activity" zurückgegeben. |
| get |
Lädt eine Anlage herunter. |
| get |
Lädt eine Anlage herunter. |
| get |
Ruft den Klassifizierungsknoten für einen angegebenen Knotenpfad ab. |
| get |
Ruft Stammklassifizierungsknoten oder Liste von Klassifizierungsknoten für eine bestimmte Liste von Knoten-IDs für ein bestimmtes Projekt ab. Falls der Ids-Parameter angegeben wird, erhalten Sie eine Liste der Klassifizierungsknoten für diese IDs. Andernfalls erhalten Sie Stammklassifizierungsknoten für dieses Projekt. |
| get |
Ruft einen Kommentar für ein Arbeitselement bei der angegebenen Revision ab. |
| get |
Ruft die angegebene Anzahl von Kommentaren für ein Arbeitselement aus der angegebenen Revision ab. |
| get |
Ruft ein gelöschtes Arbeitselement aus dem Papierkorb ab. |
| get |
Ruft die Arbeitselemente aus dem Papierkorb ab, deren IDs in den Parametern angegeben wurden |
| get |
Ruft eine Liste der IDs und der URLs der gelöschten Arbeitselemente im Papierkorb ab. |
| get |
Ruft Informationen zu einem bestimmten Feld ab. |
| get |
Gibt Informationen für alle Felder zurück. Der Projekt-ID/Name-Parameter ist optional. |
| get |
Ruft die Stammabfragen und ihre untergeordneten Elemente ab. |
| get |
Ruft eine Liste von Abfragen nach IDs ab (Maximal 1000) |
| get |
Ruft eine einzelne Abfrage und ihre untergeordneten Elemente ab. |
| get |
Ruft die Ergebnisse der Abfrage unter Berücksichtigung der Abfrage-ID ab. |
| get |
Ruft die zuletzt verwendeten Arbeitselementaktivitäten ab. |
| get |
NUR INTERN: WIRD VOM KONTO MEINE ARBEITSSEITE VERWENDET. |
| get |
Ruft die Definition des Arbeitselementbeziehungstyps ab. |
| get |
Ruft die Arbeitselementbeziehungstypen ab. |
| get |
Abrufen eines Batches von Arbeitselementlinks |
| get |
Gibt ein vollständig aktiviertes Arbeitselement für die angeforderte Revision zurück. |
| get |
Gibt die Liste der vollständig aktivierten Überarbeitungen von Arbeitselementen (paged) zurück. |
| get |
Ruft Stammklassifizierungsknoten unter dem Projekt ab. |
| get |
Ruft die Vorlage mit der angegebenen ID ab. |
| get |
Ruft eine Vorlage ab. |
| get |
Gibt ein einzelnes Update für ein Arbeitselement zurück. |
| get |
Gibt die Deltas zwischen Überarbeitungen von Arbeitselementen zurück. |
| get |
Rufen Sie die Liste der Nachverfolgung ausgehender Artefaktlinktypen für Arbeitselemente ab. |
| get |
Gibt ein einzelnes Arbeitselement zurück. |
| get |
Rufen Sie ein Arbeitselementsymbol unter Angabe des Anzeigenamens und der Symbolfarbe ab. |
| get |
Ruft eine Liste aller Arbeitselementsymbole ab. |
| get |
Rufen Sie ein Arbeitselementsymbol unter Angabe des Anzeigenamens und der Symbolfarbe ab. |
| get |
Rufen Sie ein Arbeitselementsymbol unter Angabe des Anzeigenamens und der Symbolfarbe ab. |
| get |
Gibt den nächsten Zustand für die angegebenen Arbeitselement-IDs zurück. |
| get |
Gibt eine Liste von Arbeitselementen zurück (maximal 200) |
| get |
Ruft Arbeitselemente für eine Liste von Arbeitselement-IDs ab (Maximal 200) |
| get |
NUR INTERN: Es wird für die Arbeitserfahrung "Mein Konto" verwendet. Abrufen der Zustandsfarbe des Arbeitselementtyps für mehrere Projekte |
| get |
Gibt ein einzelnes Arbeitselement aus einer Vorlage zurück. |
| get |
Gibt eine Arbeitselementtypdefinition zurück. |
| get |
Ruft alle Kategorien des Arbeitselementtyps ab. |
| get |
Rufen Sie eine bestimmte Arbeitselementtypkategorie nach Name ab. |
| get |
NUR INTERN: Es wird für Farb- und Symbolanbieter verwendet. Abrufen der Wit-Typfarbe für mehrere Projekte |
| get |
NUR INTERN: Es wird für die Arbeitserfahrung "Mein Konto" verwendet. Abrufen der Wit-Typfarbe für mehrere Projekte |
| get |
Ruft eine Liste von Feldern für einen Arbeitselementtyp mit detaillierten Verweisen ab. |
| get |
Ruft ein Feld für einen Arbeitselementtyp mit detaillierten Verweisen ab. |
| get |
Gibt die Liste der Arbeitselementtypen zurück. |
| get |
Gibt die Zustandsnamen und Farben für einen Arbeitselementtyp zurück. |
| query |
Ruft die Ergebnisse der Abfrage unter Berücksichtigung der Abfrage-ID ab. |
| query |
Ruft die Ergebnisse der Abfrage ab, die ihrem WIQL gegeben ist. |
| query |
Fragt Arbeitselemente ab, die mit einer bestimmten Liste von Artefakt-URI verknüpft sind. |
| read |
Abrufen eines Batches von Überarbeitungen von Arbeitselementen mit der Option zum Einschließen gelöschter Elemente |
| read |
Ruft einen Batch von Überarbeitungen von Arbeitselementen ab. Diese Anforderung kann verwendet werden, wenn Ihre Liste von Feldern groß genug ist, damit die URL über die Längenbegrenzung ausgeführt werden kann. |
| replace |
Ersetzen von Vorlageninhalten |
| restore |
Stellt das gelöschte Arbeitselement aus dem Papierkorb wieder her. |
| search |
Durchsucht alle Abfragen, auf die der Benutzer im aktuellen Projekt Zugriff hat |
| send |
RESTful-Methode zum Senden von E-Mails für ausgewählte/abgefragte Arbeitselemente. |
| update |
Aktualisieren sie einen vorhandenen Klassifizierungsknoten. |
| update |
Aktualisieren sie ein Feld. |
| update |
Aktualisieren sie eine Abfrage oder einen Ordner. Dadurch können Sie Abfragen und Ordner aktualisieren, umbenennen und verschieben. |
| update |
Updates ein einzelnes Arbeitselement. |
| update |
Hinzufügen/Aktualisieren eines Arbeitselementtyps |
Details zum Konstruktor
WorkItemTrackingRestClient(IVssRestClientOptions)
new WorkItemTrackingRestClient(options: IVssRestClientOptions)Parameter
- options
- IVssRestClientOptions
Details zur Eigenschaft
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringEigenschaftswert
string
Details zur Methode
createAttachment(any, string, string, string, string)
Lädt eine Anlage hoch.
function createAttachment(content: any, project?: string, fileName?: string, uploadType?: string, areaPath?: string): Promise<AttachmentReference>Parameter
- content
-
any
Hochzuladende Inhalte
- project
-
string
Projekt-ID oder Projektname
- fileName
-
string
Der Name der Datei
- uploadType
-
string
Anlageuploadtyp: Einfach oder blockiert
- areaPath
-
string
Zielprojektbereichspfad
Gibt zurück
Promise<AttachmentReference>
createField(WorkItemField, string)
Erstellen Sie ein neues Feld.
function createField(workItemField: WorkItemField, project?: string): Promise<WorkItemField>Parameter
- workItemField
- WorkItemField
Neue Felddefinition
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WorkItemField>
createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)
Erstellen Sie einen neuen, oder aktualisieren Sie einen vorhandenen Klassifizierungsknoten.
function createOrUpdateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>Parameter
- postedNode
- WorkItemClassificationNode
Zu erstellende oder zu aktualisierende Knoten.
- project
-
string
Projekt-ID oder Projektname
- structureGroup
- TreeStructureGroup
Strukturgruppe des Klassifizierungsknotens, Bereichs oder Iteration.
- path
-
string
Pfad des Klassifizierungsknotens.
Gibt zurück
Promise<WorkItemClassificationNode>
createQuery(QueryHierarchyItem, string, string, boolean)
Erstellt eine Abfrage oder verschiebt eine Abfrage.
function createQuery(postedQuery: QueryHierarchyItem, project: string, query: string, validateWiqlOnly?: boolean): Promise<QueryHierarchyItem>Parameter
- postedQuery
- QueryHierarchyItem
Die zu erstellende Abfrage.
- project
-
string
Projekt-ID oder Projektname
- query
-
string
Die übergeordnete ID oder der Pfad, unter dem die Abfrage erstellt werden soll.
- validateWiqlOnly
-
boolean
Wenn Sie Ihre WIQL-Abfrage nur überprüfen möchten, ohne sie tatsächlich zu erstellen, legen Sie sie auf true fest. Der Standardwert ist "false".
Gibt zurück
Promise<QueryHierarchyItem>
createTemplate(WorkItemTemplate, string, string)
Erstellt eine Vorlage
function createTemplate(template: WorkItemTemplate, project: string, team: string): Promise<WorkItemTemplate>Parameter
- template
- WorkItemTemplate
Vorlageninhalt
- project
-
string
Projekt-ID oder Projektname
- team
-
string
Team-ID oder Teamname
Gibt zurück
Promise<WorkItemTemplate>
createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)
Erstellt ein einzelnes Arbeitselement.
function createWorkItem(document: JsonPatchDocument, project: string, type: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemExpand): Promise<WorkItem>Parameter
- document
- JsonPatchDocument
Das JSON Patch-Dokument, das das Arbeitselement darstellt
- project
-
string
Projekt-ID oder Projektname
- type
-
string
Der Arbeitselementtyp des zu erstellenden Arbeitselements
- validateOnly
-
boolean
Geben Sie an, ob Sie nur die Änderungen überprüfen möchten, ohne das Arbeitselement zu speichern.
- bypassRules
-
boolean
Erzwingen Sie die Arbeitselementtypregeln für dieses Update nicht.
- suppressNotifications
-
boolean
Keine Benachrichtigungen für diese Änderung auslösen
- expand
- WorkItemExpand
Die Erweiterungsparameter für Arbeitselementattribute. Mögliche Optionen sind { None, Relations, Fields, Links, All }.
Gibt zurück
Promise<WorkItem>
deleteClassificationNode(string, TreeStructureGroup, string, number)
Löschen Sie einen vorhandenen Klassifizierungsknoten.
function deleteClassificationNode(project: string, structureGroup: TreeStructureGroup, path?: string, reclassifyId?: number): Promise<void>Parameter
- project
-
string
Projekt-ID oder Projektname
- structureGroup
- TreeStructureGroup
Strukturgruppe des Klassifizierungsknotens, Bereichs oder Iteration.
- path
-
string
Pfad des Klassifizierungsknotens.
- reclassifyId
-
number
ID des Zielklassifizierungsknotens für die Neuklassifizierung.
Gibt zurück
Promise<void>
deleteField(string, string)
Löscht das Feld. Informationen zum Wiederherstellen eines abgelegten Vorgangs finden Sie unter "Feld aktualisieren"-API.
function deleteField(fieldNameOrRefName: string, project?: string): Promise<void>Parameter
- fieldNameOrRefName
-
string
Feldname oder Verweisname
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<void>
deleteQuery(string, string)
Löschen Sie eine Abfrage oder einen Ordner. Dadurch werden alle Berechtigungsänderungen für die gelöschte Abfrage oder den gelöschten Ordner und alle untergeordneten Elemente gelöscht, wenn es sich um einen Ordner handelt. Es ist wichtig zu beachten, dass die gelöschten Berechtigungsänderungen nicht wiederhergestellt werden können, wenn sie die Abfrage oder den Ordner wiederherstellen.
function deleteQuery(project: string, query: string): Promise<void>Parameter
- project
-
string
Projekt-ID oder Projektname
- query
-
string
ID oder Pfad der zu löschenden Abfrage oder des zu löschenden Ordners.
Gibt zurück
Promise<void>
deleteTemplate(string, string, string)
Löscht die Vorlage mit der angegebenen ID.
function deleteTemplate(project: string, team: string, templateId: string): Promise<void>Parameter
- project
-
string
Projekt-ID oder Projektname
- team
-
string
Team-ID oder Teamname
- templateId
-
string
Vorlagen-ID
Gibt zurück
Promise<void>
deleteWorkItem(number, string, boolean)
Löscht das angegebene Arbeitselement und sendet es an den Papierkorb, damit es bei Bedarf wiederhergestellt werden kann. Wenn der Destroy-Parameter auf true festgelegt wurde, wird das Arbeitselement optional dauerhaft zerstört. WARNUNG: Wenn der Destroy-Parameter auf true festgelegt ist, werden mit diesem Befehl gelöschte Arbeitselemente NICHT in den Papierkorb verschoben, und es gibt keine Möglichkeit, sie nach dem Löschen wiederherzustellen/wiederherzustellen. Es wird empfohlen, diesen Parameter NICHT zu verwenden. Wenn Sie dies tun, verwenden Sie diesen Parameter mit äußerster Vorsicht.
function deleteWorkItem(id: number, project?: string, destroy?: boolean): Promise<WorkItemDelete>Parameter
- id
-
number
ID des zu löschenden Arbeitselements
- project
-
string
Projekt-ID oder Projektname
- destroy
-
boolean
Optionaler Parameter: Wenn auf true festgelegt ist, wird das Arbeitselement endgültig gelöscht. Bitte beachten Sie: Die Zerstörungsaktion ist DAUERHAFT und kann nicht rückgängig machen werden.
Gibt zurück
Promise<WorkItemDelete>
destroyWorkItem(number, string)
Zerstört das angegebene Arbeitselement dauerhaft aus dem Papierkorb. Diese Aktion kann nicht rückgängig werden.
function destroyWorkItem(id: number, project?: string): Promise<void>Parameter
- id
-
number
ID des dauerhaft zu vernichtenden Arbeitselements
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<void>
exportWorkItemTypeDefinition(string, string, boolean)
Exportieren des Arbeitselementtyps
function exportWorkItemTypeDefinition(project?: string, type?: string, exportGlobalLists?: boolean): Promise<WorkItemTypeTemplate>Parameter
- project
-
string
Projekt-ID oder Projektname
- type
-
string
- exportGlobalLists
-
boolean
Gibt zurück
Promise<WorkItemTypeTemplate>
getAccountMyWorkData(QueryOption)
NUR INTERN: WIRD VOM KONTO MEINE ARBEITSSEITE VERWENDET. Dadurch werden Die Arbeitselemente "Doing", "Done", "Follows" und "Activity" zurückgegeben.
function getAccountMyWorkData(queryOption?: QueryOption): Promise<AccountMyWorkResult>Parameter
- queryOption
- QueryOption
Gibt zurück
Promise<AccountMyWorkResult>
getAttachmentContent(string, string, string, boolean)
Lädt eine Anlage herunter.
function getAttachmentContent(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>Parameter
- id
-
string
Anlage-ID
- project
-
string
Projekt-ID oder Projektname
- fileName
-
string
Der Name der Datei.
- download
-
boolean
Wenn sie auf <c>true</c> festgelegt ist, laden Sie die Anlage immer herunter.
Gibt zurück
Promise<ArrayBuffer>
getAttachmentZip(string, string, string, boolean)
Lädt eine Anlage herunter.
function getAttachmentZip(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>Parameter
- id
-
string
Anlage-ID
- project
-
string
Projekt-ID oder Projektname
- fileName
-
string
Der Name der Datei.
- download
-
boolean
Wenn sie auf <c>true</c> festgelegt ist, laden Sie die Anlage immer herunter.
Gibt zurück
Promise<ArrayBuffer>
getClassificationNode(string, TreeStructureGroup, string, number)
Ruft den Klassifizierungsknoten für einen angegebenen Knotenpfad ab.
function getClassificationNode(project: string, structureGroup: TreeStructureGroup, path?: string, depth?: number): Promise<WorkItemClassificationNode>Parameter
- project
-
string
Projekt-ID oder Projektname
- structureGroup
- TreeStructureGroup
Strukturgruppe des Klassifizierungsknotens, Bereichs oder Iteration.
- path
-
string
Pfad des Klassifizierungsknotens.
- depth
-
number
Tiefe der abzurufenden untergeordneten Elemente.
Gibt zurück
Promise<WorkItemClassificationNode>
getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)
Ruft Stammklassifizierungsknoten oder Liste von Klassifizierungsknoten für eine bestimmte Liste von Knoten-IDs für ein bestimmtes Projekt ab. Falls der Ids-Parameter angegeben wird, erhalten Sie eine Liste der Klassifizierungsknoten für diese IDs. Andernfalls erhalten Sie Stammklassifizierungsknoten für dieses Projekt.
function getClassificationNodes(project: string, ids: number[], depth?: number, errorPolicy?: ClassificationNodesErrorPolicy): Promise<WorkItemClassificationNode[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- ids
-
number[]
Durch Kommas getrennte ganzzahlige Klassifizierungsknoten-IDs. Dies ist nicht erforderlich, wenn Sie Stammknoten möchten.
- depth
-
number
Tiefe der abzurufenden untergeordneten Elemente.
- errorPolicy
- ClassificationNodesErrorPolicy
Kennzeichnen, um Fehler beim Abrufen einiger Knoten zu behandeln. Mögliche Optionen sind Fail und Omit.
Gibt zurück
Promise<WorkItemClassificationNode[]>
getComment(number, number, string)
Ruft einen Kommentar für ein Arbeitselement bei der angegebenen Revision ab.
function getComment(id: number, revision: number, project?: string): Promise<WorkItemComment>Parameter
- id
-
number
Arbeitselement-ID
- revision
-
number
Revision, für die der Kommentar abgerufen werden muss
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WorkItemComment>
getComments(number, string, number, number, CommentSortOrder)
Ruft die angegebene Anzahl von Kommentaren für ein Arbeitselement aus der angegebenen Revision ab.
function getComments(id: number, project?: string, fromRevision?: number, top?: number, order?: CommentSortOrder): Promise<WorkItemComments>Parameter
- id
-
number
Arbeitselement-ID
- project
-
string
Projekt-ID oder Projektname
- fromRevision
-
number
Revision, aus der Kommentare abgerufen werden sollen (Standard ist 1).
- top
-
number
Die Anzahl der kommentare, die zurückgegeben werden sollen (Standardwert ist 200).
- order
- CommentSortOrder
Aufsteigend oder absteigend nach Revisions-ID (Standard ist aufsteigend)
Gibt zurück
Promise<WorkItemComments>
getDeletedWorkItem(number, string)
Ruft ein gelöschtes Arbeitselement aus dem Papierkorb ab.
function getDeletedWorkItem(id: number, project?: string): Promise<WorkItemDelete>Parameter
- id
-
number
ID des zurückzugebenden Arbeitselements
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WorkItemDelete>
getDeletedWorkItems(number[], string)
Ruft die Arbeitselemente aus dem Papierkorb ab, deren IDs in den Parametern angegeben wurden
function getDeletedWorkItems(ids: number[], project?: string): Promise<WorkItemDeleteReference[]>Parameter
- ids
-
number[]
Durch Trennzeichen getrennte Liste der IDs der gelöschten Arbeitselemente, die zurückgegeben werden sollen
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WorkItemDeleteReference[]>
getDeletedWorkItemShallowReferences(string)
Ruft eine Liste der IDs und der URLs der gelöschten Arbeitselemente im Papierkorb ab.
function getDeletedWorkItemShallowReferences(project?: string): Promise<WorkItemDeleteShallowReference[]>Parameter
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WorkItemDeleteShallowReference[]>
getField(string, string)
Ruft Informationen zu einem bestimmten Feld ab.
function getField(fieldNameOrRefName: string, project?: string): Promise<WorkItemField>Parameter
- fieldNameOrRefName
-
string
Feldname oder Verweisname
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WorkItemField>
getFields(string, GetFieldsExpand)
Gibt Informationen für alle Felder zurück. Der Projekt-ID/Name-Parameter ist optional.
function getFields(project?: string, expand?: GetFieldsExpand): Promise<WorkItemField[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- expand
- GetFieldsExpand
Verwenden Sie ExtensionFields, um Erweiterungsfelder einzuschließen, andernfalls ausschließen. Sofern das Featureflag für diesen Parameter nicht aktiviert ist, sind Erweiterungsfelder immer enthalten.
Gibt zurück
Promise<WorkItemField[]>
getQueries(string, QueryExpand, number, boolean)
Ruft die Stammabfragen und ihre untergeordneten Elemente ab.
function getQueries(project: string, expand?: QueryExpand, depth?: number, includeDeleted?: boolean): Promise<QueryHierarchyItem[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- expand
- QueryExpand
Schließen Sie die Abfragezeichenfolge (wiql), Klauseln, Abfrageergebnisspalten und Sortieroptionen in die Ergebnisse ein.
- depth
-
number
Geben Sie im Ordner abfragen untergeordnete Abfragen und Ordner in diese Tiefe zurück.
- includeDeleted
-
boolean
Einschließen gelöschter Abfragen und Ordner
Gibt zurück
Promise<QueryHierarchyItem[]>
getQueriesBatch(QueryBatchGetRequest, string)
Ruft eine Liste von Abfragen nach IDs ab (Maximal 1000)
function getQueriesBatch(queryGetRequest: QueryBatchGetRequest, project: string): Promise<QueryHierarchyItem[]>Parameter
- queryGetRequest
- QueryBatchGetRequest
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<QueryHierarchyItem[]>
getQuery(string, string, QueryExpand, number, boolean, boolean)
Ruft eine einzelne Abfrage und ihre untergeordneten Elemente ab.
function getQuery(project: string, query: string, expand?: QueryExpand, depth?: number, includeDeleted?: boolean, useIsoDateFormat?: boolean): Promise<QueryHierarchyItem>Parameter
- project
-
string
Projekt-ID oder Projektname
- query
-
string
ID oder Pfad der Abfrage.
- expand
- QueryExpand
Schließen Sie die Abfragezeichenfolge (wiql), Klauseln, Abfrageergebnisspalten und Sortieroptionen in die Ergebnisse ein.
- depth
-
number
Geben Sie im Ordner abfragen untergeordnete Abfragen und Ordner in diese Tiefe zurück.
- includeDeleted
-
boolean
Einschließen gelöschter Abfragen und Ordner
- useIsoDateFormat
-
boolean
DateTime-Abfrageklauseln werden mit einem ISO 8601-konformen Format formatiert.
Gibt zurück
Promise<QueryHierarchyItem>
getQueryResultCount(string, string, string, boolean, number)
Ruft die Ergebnisse der Abfrage unter Berücksichtigung der Abfrage-ID ab.
function getQueryResultCount(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<number>Parameter
- id
-
string
Die Abfrage-ID.
- project
-
string
Projekt-ID oder Projektname
- team
-
string
Team-ID oder Teamname
- timePrecision
-
boolean
Gibt an, ob die Zeitgenauigkeit verwendet werden soll.
- top
-
number
Die maximale Anzahl der zurückzugebenden Ergebnisse.
Gibt zurück
Promise<number>
getRecentActivityData()
Ruft die zuletzt verwendeten Arbeitselementaktivitäten ab.
function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>Gibt zurück
Promise<AccountRecentActivityWorkItemModel2[]>
getRecentMentions()
NUR INTERN: WIRD VOM KONTO MEINE ARBEITSSEITE VERWENDET.
function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>Gibt zurück
Promise<AccountRecentMentionWorkItemModel[]>
getRelationType(string)
Ruft die Definition des Arbeitselementbeziehungstyps ab.
function getRelationType(relation: string): Promise<WorkItemRelationType>Parameter
- relation
-
string
Der Beziehungsname
Gibt zurück
Promise<WorkItemRelationType>
getRelationTypes()
Ruft die Arbeitselementbeziehungstypen ab.
function getRelationTypes(): Promise<WorkItemRelationType[]>Gibt zurück
Promise<WorkItemRelationType[]>
getReportingLinksByLinkType(string, string[], string[], string, Date)
Abrufen eines Batches von Arbeitselementlinks
function getReportingLinksByLinkType(project?: string, linkTypes?: string[], types?: string[], continuationToken?: string, startDateTime?: Date): Promise<ReportingWorkItemLinksBatch>Parameter
- project
-
string
Projekt-ID oder Projektname
- linkTypes
-
string[]
Eine Liste von Typen zum Filtern der Ergebnisse nach bestimmten Linktypen. Lassen Sie diesen Parameter aus, um Arbeitselementlinks aller Linktypen abzurufen.
- types
-
string[]
Eine Liste von Typen zum Filtern der Ergebnisse nach bestimmten Arbeitselementtypen. Lassen Sie diesen Parameter aus, um Arbeitselementlinks aller Arbeitselementtypen abzurufen.
- continuationToken
-
string
Gibt das continuationToken an, mit dem der Batch gestartet werden soll. Lassen Sie diesen Parameter aus, um den ersten Batch von Links abzurufen.
- startDateTime
-
Date
Datum/Uhrzeit, die als Ausgangspunkt für Linkänderungen verwendet werden soll. Nur Linkänderungen, die nach diesem Datum/dieser Uhrzeit aufgetreten sind, werden zurückgegeben. Kann nicht in Verbindung mit dem Parameter "Watermark" verwendet werden.
Gibt zurück
Promise<ReportingWorkItemLinksBatch>
getRevision(number, number, string, WorkItemExpand)
Gibt ein vollständig aktiviertes Arbeitselement für die angeforderte Revision zurück.
function getRevision(id: number, revisionNumber: number, project?: string, expand?: WorkItemExpand): Promise<WorkItem>Parameter
- id
-
number
- revisionNumber
-
number
- project
-
string
Projekt-ID oder Projektname
- expand
- WorkItemExpand
Gibt zurück
Promise<WorkItem>
getRevisions(number, string, number, number, WorkItemExpand)
Gibt die Liste der vollständig aktivierten Überarbeitungen von Arbeitselementen (paged) zurück.
function getRevisions(id: number, project?: string, top?: number, skip?: number, expand?: WorkItemExpand): Promise<WorkItem[]>Parameter
- id
-
number
- project
-
string
Projekt-ID oder Projektname
- top
-
number
- skip
-
number
- expand
- WorkItemExpand
Gibt zurück
Promise<WorkItem[]>
getRootNodes(string, number)
Ruft Stammklassifizierungsknoten unter dem Projekt ab.
function getRootNodes(project: string, depth?: number): Promise<WorkItemClassificationNode[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- depth
-
number
Tiefe der abzurufenden untergeordneten Elemente.
Gibt zurück
Promise<WorkItemClassificationNode[]>
getTemplate(string, string, string)
Ruft die Vorlage mit der angegebenen ID ab.
function getTemplate(project: string, team: string, templateId: string): Promise<WorkItemTemplate>Parameter
- project
-
string
Projekt-ID oder Projektname
- team
-
string
Team-ID oder Teamname
- templateId
-
string
Vorlagen-ID
Gibt zurück
Promise<WorkItemTemplate>
getTemplates(string, string, string)
Ruft eine Vorlage ab.
function getTemplates(project: string, team: string, workitemtypename?: string): Promise<WorkItemTemplateReference[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- team
-
string
Team-ID oder Teamname
- workitemtypename
-
string
Optional: Wenn angegeben gibt Vorlagen für den angegebenen Arbeitselementtyp zurück.
Gibt zurück
Promise<WorkItemTemplateReference[]>
getUpdate(number, number, string)
Gibt ein einzelnes Update für ein Arbeitselement zurück.
function getUpdate(id: number, updateNumber: number, project?: string): Promise<WorkItemUpdate>Parameter
- id
-
number
- updateNumber
-
number
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WorkItemUpdate>
getUpdates(number, string, number, number)
Gibt die Deltas zwischen Überarbeitungen von Arbeitselementen zurück.
function getUpdates(id: number, project?: string, top?: number, skip?: number): Promise<WorkItemUpdate[]>Parameter
- id
-
number
- project
-
string
Projekt-ID oder Projektname
- top
-
number
- skip
-
number
Gibt zurück
Promise<WorkItemUpdate[]>
getWorkArtifactLinkTypes()
Rufen Sie die Liste der Nachverfolgung ausgehender Artefaktlinktypen für Arbeitselemente ab.
function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>Gibt zurück
Promise<WorkArtifactLink[]>
getWorkItem(number, string, string[], Date, WorkItemExpand)
Gibt ein einzelnes Arbeitselement zurück.
function getWorkItem(id: number, project?: string, fields?: string[], asOf?: Date, expand?: WorkItemExpand): Promise<WorkItem>Parameter
- id
-
number
Die Arbeitselement-ID
- project
-
string
Projekt-ID oder Projektname
- fields
-
string[]
Durch Trennzeichen getrennte Liste der angeforderten Felder
- asOf
-
Date
AsOf-Datums-Uhrzeitzeichenfolge
- expand
- WorkItemExpand
Die Erweiterungsparameter für Arbeitselementattribute. Mögliche Optionen sind { None, Relations, Fields, Links, All }.
Gibt zurück
Promise<WorkItem>
getWorkItemIconJson(string, string, number)
Rufen Sie ein Arbeitselementsymbol unter Angabe des Anzeigenamens und der Symbolfarbe ab.
function getWorkItemIconJson(icon: string, color?: string, v?: number): Promise<WorkItemIcon>Parameter
- icon
-
string
Der Name des Symbols
- color
-
string
Die sechsstellige Hexadezimalfarbe für das Symbol
- v
-
number
Die Version des Symbols (wird nur für cache invalidation verwendet)
Gibt zurück
Promise<WorkItemIcon>
getWorkItemIcons()
Ruft eine Liste aller Arbeitselementsymbole ab.
function getWorkItemIcons(): Promise<WorkItemIcon[]>Gibt zurück
Promise<WorkItemIcon[]>
getWorkItemIconSvg(string, string, number)
Rufen Sie ein Arbeitselementsymbol unter Angabe des Anzeigenamens und der Symbolfarbe ab.
function getWorkItemIconSvg(icon: string, color?: string, v?: number): Promise<any>Parameter
- icon
-
string
Der Name des Symbols
- color
-
string
Die sechsstellige Hexadezimalfarbe für das Symbol
- v
-
number
Die Version des Symbols (wird nur für cache invalidation verwendet)
Gibt zurück
Promise<any>
getWorkItemIconXaml(string, string, number)
Rufen Sie ein Arbeitselementsymbol unter Angabe des Anzeigenamens und der Symbolfarbe ab.
function getWorkItemIconXaml(icon: string, color?: string, v?: number): Promise<any>Parameter
- icon
-
string
Der Name des Symbols
- color
-
string
Die sechsstellige Hexadezimalfarbe für das Symbol
- v
-
number
Die Version des Symbols (wird nur für cache invalidation verwendet)
Gibt zurück
Promise<any>
getWorkItemNextStatesOnCheckinAction(number[], string)
Gibt den nächsten Zustand für die angegebenen Arbeitselement-IDs zurück.
function getWorkItemNextStatesOnCheckinAction(ids: number[], action?: string): Promise<WorkItemNextStateOnTransition[]>Parameter
- ids
-
number[]
Liste der Arbeitselement-IDs
- action
-
string
mögliche Aktionen. Derzeit wird nur das Einchecken unterstützt.
Gibt zurück
Promise<WorkItemNextStateOnTransition[]>
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)
Gibt eine Liste von Arbeitselementen zurück (maximal 200)
function getWorkItems(ids: number[], project?: string, fields?: string[], asOf?: Date, expand?: WorkItemExpand, errorPolicy?: WorkItemErrorPolicy): Promise<WorkItem[]>Parameter
- ids
-
number[]
Die durch Trennzeichen getrennte Liste der angeforderten Arbeitselement-IDs. (Maximal 200 zulässige IDs)
- project
-
string
Projekt-ID oder Projektname
- fields
-
string[]
Durch Trennzeichen getrennte Liste der angeforderten Felder
- asOf
-
Date
AsOf-Datums-Uhrzeitzeichenfolge
- expand
- WorkItemExpand
Die Erweiterungsparameter für Arbeitselementattribute. Mögliche Optionen sind { None, Relations, Fields, Links, All }.
- errorPolicy
- WorkItemErrorPolicy
Das Flag zum Steuern der Fehlerrichtlinie in einer Massenanforderung zum Abrufen von Arbeitselementen. Mögliche Optionen sind {Fail, Omit}.
Gibt zurück
Promise<WorkItem[]>
getWorkItemsBatch(WorkItemBatchGetRequest, string)
Ruft Arbeitselemente für eine Liste von Arbeitselement-IDs ab (Maximal 200)
function getWorkItemsBatch(workItemGetRequest: WorkItemBatchGetRequest, project?: string): Promise<WorkItem[]>Parameter
- workItemGetRequest
- WorkItemBatchGetRequest
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WorkItem[]>
getWorkItemStateColors(string[])
NUR INTERN: Es wird für die Arbeitserfahrung "Mein Konto" verwendet. Abrufen der Zustandsfarbe des Arbeitselementtyps für mehrere Projekte
function getWorkItemStateColors(projectNames: string[]): Promise<ProjectWorkItemStateColors[]>Parameter
- projectNames
-
string[]
Gibt zurück
Promise<ProjectWorkItemStateColors[]>
getWorkItemTemplate(string, string, string, Date, WorkItemExpand)
Gibt ein einzelnes Arbeitselement aus einer Vorlage zurück.
function getWorkItemTemplate(project: string, type: string, fields?: string, asOf?: Date, expand?: WorkItemExpand): Promise<WorkItem>Parameter
- project
-
string
Projekt-ID oder Projektname
- type
-
string
Der Name des Arbeitselementtyps
- fields
-
string
Durch Trennzeichen getrennte Liste der angeforderten Felder
- asOf
-
Date
AsOf-Datums-Uhrzeitzeichenfolge
- expand
- WorkItemExpand
Die Erweiterungsparameter für Arbeitselementattribute. Mögliche Optionen sind { None, Relations, Fields, Links, All }.
Gibt zurück
Promise<WorkItem>
getWorkItemType(string, string)
Gibt eine Arbeitselementtypdefinition zurück.
function getWorkItemType(project: string, type: string): Promise<WorkItemType>Parameter
- project
-
string
Projekt-ID oder Projektname
- type
-
string
Name des Arbeitselementtyps
Gibt zurück
Promise<WorkItemType>
getWorkItemTypeCategories(string)
Ruft alle Kategorien des Arbeitselementtyps ab.
function getWorkItemTypeCategories(project: string): Promise<WorkItemTypeCategory[]>Parameter
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WorkItemTypeCategory[]>
getWorkItemTypeCategory(string, string)
Rufen Sie eine bestimmte Arbeitselementtypkategorie nach Name ab.
function getWorkItemTypeCategory(project: string, category: string): Promise<WorkItemTypeCategory>Parameter
- project
-
string
Projekt-ID oder Projektname
- category
-
string
Der Kategoriename
Gibt zurück
Promise<WorkItemTypeCategory>
getWorkItemTypeColorAndIcons(string[])
NUR INTERN: Es wird für Farb- und Symbolanbieter verwendet. Abrufen der Wit-Typfarbe für mehrere Projekte
function getWorkItemTypeColorAndIcons(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>Parameter
- projectNames
-
string[]
Gibt zurück
Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>
getWorkItemTypeColors(string[])
NUR INTERN: Es wird für die Arbeitserfahrung "Mein Konto" verwendet. Abrufen der Wit-Typfarbe für mehrere Projekte
function getWorkItemTypeColors(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColor[] }[]>Parameter
- projectNames
-
string[]
Gibt zurück
Promise<{ key: string, value: WorkItemTypeColor[] }[]>
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)
Ruft eine Liste von Feldern für einen Arbeitselementtyp mit detaillierten Verweisen ab.
function getWorkItemTypeFieldsWithReferences(project: string, type: string, expand?: WorkItemTypeFieldsExpandLevel): Promise<WorkItemTypeFieldWithReferences[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- type
-
string
Arbeitselementtyp.
Erweitern Sie die Ebene für die API-Antwort. Eigenschaften: Um allowedvalues, standardwert, isRequired usw. als Teil der Antwort einzuschließen; Keine: , um diese Eigenschaften zu überspringen.
Gibt zurück
Promise<WorkItemTypeFieldWithReferences[]>
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)
Ruft ein Feld für einen Arbeitselementtyp mit detaillierten Verweisen ab.
function getWorkItemTypeFieldWithReferences(project: string, type: string, field: string, expand?: WorkItemTypeFieldsExpandLevel): Promise<WorkItemTypeFieldWithReferences>Parameter
- project
-
string
Projekt-ID oder Projektname
- type
-
string
Arbeitselementtyp.
- field
-
string
Erweitern Sie die Ebene für die API-Antwort. Eigenschaften: Um allowedvalues, standardwert, isRequired usw. als Teil der Antwort einzuschließen; Keine: , um diese Eigenschaften zu überspringen.
Gibt zurück
Promise<WorkItemTypeFieldWithReferences>
getWorkItemTypes(string)
Gibt die Liste der Arbeitselementtypen zurück.
function getWorkItemTypes(project: string): Promise<WorkItemType[]>Parameter
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WorkItemType[]>
getWorkItemTypeStates(string, string)
Gibt die Zustandsnamen und Farben für einen Arbeitselementtyp zurück.
function getWorkItemTypeStates(project: string, type: string): Promise<WorkItemStateColor[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- type
-
string
Der Statusname
Gibt zurück
Promise<WorkItemStateColor[]>
queryById(string, string, string, boolean, number)
Ruft die Ergebnisse der Abfrage unter Berücksichtigung der Abfrage-ID ab.
function queryById(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemQueryResult>Parameter
- id
-
string
Die Abfrage-ID.
- project
-
string
Projekt-ID oder Projektname
- team
-
string
Team-ID oder Teamname
- timePrecision
-
boolean
Gibt an, ob die Zeitgenauigkeit verwendet werden soll.
- top
-
number
Die maximale Anzahl der zurückzugebenden Ergebnisse.
Gibt zurück
Promise<WorkItemQueryResult>
queryByWiql(Wiql, string, string, boolean, number)
Ruft die Ergebnisse der Abfrage ab, die ihrem WIQL gegeben ist.
function queryByWiql(wiql: Wiql, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemQueryResult>Parameter
- wiql
- Wiql
Die Abfrage, die die WIQL enthält.
- project
-
string
Projekt-ID oder Projektname
- team
-
string
Team-ID oder Teamname
- timePrecision
-
boolean
Gibt an, ob die Zeitgenauigkeit verwendet werden soll.
- top
-
number
Die maximale Anzahl der zurückzugebenden Ergebnisse.
Gibt zurück
Promise<WorkItemQueryResult>
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)
Fragt Arbeitselemente ab, die mit einer bestimmten Liste von Artefakt-URI verknüpft sind.
function queryWorkItemsForArtifactUris(artifactUriQuery: ArtifactUriQuery, project?: string): Promise<ArtifactUriQueryResult>Parameter
- artifactUriQuery
- ArtifactUriQuery
Definiert eine Liste von Artefakt-URI zum Abfragen von Arbeitselementen.
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<ArtifactUriQueryResult>
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)
Abrufen eines Batches von Überarbeitungen von Arbeitselementen mit der Option zum Einschließen gelöschter Elemente
function readReportingRevisionsGet(project?: string, fields?: string[], types?: string[], continuationToken?: string, startDateTime?: Date, includeIdentityRef?: boolean, includeDeleted?: boolean, includeTagRef?: boolean, includeLatestOnly?: boolean, expand?: ReportingRevisionsExpand, includeDiscussionChangesOnly?: boolean, maxPageSize?: number): Promise<ReportingWorkItemRevisionsBatch>Parameter
- project
-
string
Projekt-ID oder Projektname
- fields
-
string[]
Eine Liste von Feldern, die in Überarbeitungen von Arbeitselementen zurückgegeben werden sollen. Lassen Sie diesen Parameter aus, um alle berichtsfähigen Felder abzurufen.
- types
-
string[]
Eine Liste von Typen zum Filtern der Ergebnisse nach bestimmten Arbeitselementtypen. Lassen Sie diesen Parameter aus, um Überarbeitungen von Arbeitselementen aller Arbeitselementtypen abzurufen.
- continuationToken
-
string
Gibt das Wasserzeichen an, aus dem der Batch gestartet werden soll. Lassen Sie diesen Parameter aus, um den ersten Batch von Revisionen abzurufen.
- startDateTime
-
Date
Datum/Uhrzeit, das als Ausgangspunkt für Revisionen verwendet werden soll, alle Revisionen erfolgen nach diesem Datum/dieser Uhrzeit. Kann nicht in Verbindung mit dem Parameter "Watermark" verwendet werden.
- includeIdentityRef
-
boolean
Gibt einen Identitätsverweis anstelle eines Zeichenfolgenwerts für Identitätsfelder zurück.
- includeDeleted
-
boolean
Geben Sie an, ob das gelöschte Element zurückgegeben werden soll.
- includeTagRef
-
boolean
Geben Sie an, ob die Tagobjekte für das System.Tags-Feld zurückgegeben werden sollen.
- includeLatestOnly
-
boolean
Gibt nur die neuesten Überarbeitungen von Arbeitselementen zurück, wobei alle verlaufsbezogenen Revisionen übersprungen werden.
- expand
- ReportingRevisionsExpand
Zurückgeben aller Felder in Überarbeitungen von Arbeitselementen, einschließlich langer Textfelder, die standardmäßig nicht zurückgegeben werden
- includeDiscussionChangesOnly
-
boolean
Gibt nur die Überarbeitungen von Arbeitselementen zurück, bei denen nur das Verlaufsfeld geändert wurde.
- maxPageSize
-
number
Die maximale Anzahl von Ergebnissen, die in diesem Batch zurückgegeben werden sollen
Gibt zurück
Promise<ReportingWorkItemRevisionsBatch>
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)
Ruft einen Batch von Überarbeitungen von Arbeitselementen ab. Diese Anforderung kann verwendet werden, wenn Ihre Liste von Feldern groß genug ist, damit die URL über die Längenbegrenzung ausgeführt werden kann.
function readReportingRevisionsPost(filter: ReportingWorkItemRevisionsFilter, project?: string, continuationToken?: string, startDateTime?: Date, expand?: ReportingRevisionsExpand): Promise<ReportingWorkItemRevisionsBatch>Parameter
Ein Objekt, das Anforderungseinstellungen enthält: Feldfilter, Typfilter, Identitätsformat
- project
-
string
Projekt-ID oder Projektname
- continuationToken
-
string
Gibt das Wasserzeichen an, aus dem der Batch gestartet werden soll. Lassen Sie diesen Parameter aus, um den ersten Batch von Revisionen abzurufen.
- startDateTime
-
Date
Datum/Uhrzeit, das als Ausgangspunkt für Revisionen verwendet werden soll, alle Revisionen erfolgen nach diesem Datum/dieser Uhrzeit. Kann nicht in Verbindung mit dem Parameter "Watermark" verwendet werden.
- expand
- ReportingRevisionsExpand
Gibt zurück
Promise<ReportingWorkItemRevisionsBatch>
replaceTemplate(WorkItemTemplate, string, string, string)
Ersetzen von Vorlageninhalten
function replaceTemplate(templateContent: WorkItemTemplate, project: string, team: string, templateId: string): Promise<WorkItemTemplate>Parameter
- templateContent
- WorkItemTemplate
Zu ersetzende Vorlageninhalte
- project
-
string
Projekt-ID oder Projektname
- team
-
string
Team-ID oder Teamname
- templateId
-
string
Vorlagen-ID
Gibt zurück
Promise<WorkItemTemplate>
restoreWorkItem(WorkItemDeleteUpdate, number, string)
Stellt das gelöschte Arbeitselement aus dem Papierkorb wieder her.
function restoreWorkItem(payload: WorkItemDeleteUpdate, id: number, project?: string): Promise<WorkItemDelete>Parameter
- payload
- WorkItemDeleteUpdate
Paylod mit Anweisungen zum Aktualisieren des IsDeleted-Flags auf false
- id
-
number
ID des wiederherzustellenden Arbeitselements
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WorkItemDelete>
searchQueries(string, string, number, QueryExpand, boolean)
Durchsucht alle Abfragen, auf die der Benutzer im aktuellen Projekt Zugriff hat
function searchQueries(project: string, filter: string, top?: number, expand?: QueryExpand, includeDeleted?: boolean): Promise<QueryHierarchyItemsResult>Parameter
- project
-
string
Projekt-ID oder Projektname
- filter
-
string
Der Text, mit dem die Abfragen gefiltert werden sollen.
- top
-
number
Die Anzahl der zurückzugebenden Abfragen (Der Standardwert ist 50 und der Höchstwert ist 200).
- expand
- QueryExpand
- includeDeleted
-
boolean
Einschließen gelöschter Abfragen und Ordner
Gibt zurück
Promise<QueryHierarchyItemsResult>
sendMail(SendMailBody, string)
RESTful-Methode zum Senden von E-Mails für ausgewählte/abgefragte Arbeitselemente.
function sendMail(body: SendMailBody, project?: string): Promise<void>Parameter
- body
- SendMailBody
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<void>
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)
Aktualisieren sie einen vorhandenen Klassifizierungsknoten.
function updateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>Parameter
- postedNode
- WorkItemClassificationNode
Zu erstellende oder zu aktualisierende Knoten.
- project
-
string
Projekt-ID oder Projektname
- structureGroup
- TreeStructureGroup
Strukturgruppe des Klassifizierungsknotens, des Bereichs oder der Iteration.
- path
-
string
Pfad des Klassifizierungsknotens.
Gibt zurück
Promise<WorkItemClassificationNode>
updateField(UpdateWorkItemField, string, string)
Aktualisieren sie ein Feld.
function updateField(payload: UpdateWorkItemField, fieldNameOrRefName: string, project?: string): Promise<WorkItemField>Parameter
- payload
- UpdateWorkItemField
Nutzlast enthält den gewünschten Wert der Eigenschaften des Felds.
- fieldNameOrRefName
-
string
Name/Verweisname des zu aktualisierenden Felds
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WorkItemField>
updateQuery(QueryHierarchyItem, string, string, boolean)
Aktualisieren sie eine Abfrage oder einen Ordner. Dadurch können Sie Abfragen und Ordner aktualisieren, umbenennen und verschieben.
function updateQuery(queryUpdate: QueryHierarchyItem, project: string, query: string, undeleteDescendants?: boolean): Promise<QueryHierarchyItem>Parameter
- queryUpdate
- QueryHierarchyItem
Die zu aktualisierende Abfrage.
- project
-
string
Projekt-ID oder Projektname
- query
-
string
Die ID oder der Pfad für die zu aktualisierende Abfrage.
- undeleteDescendants
-
boolean
Wiederherstellen der untergeordneten Elemente dieses Ordners. Es ist wichtig zu beachten, dass dadurch nicht die Berechtigungsänderungen zurückgesetzt werden, die zuvor auf die Nachfolger angewendet wurden.
Gibt zurück
Promise<QueryHierarchyItem>
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)
Updates ein einzelnes Arbeitselement.
function updateWorkItem(document: JsonPatchDocument, id: number, project?: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemExpand): Promise<WorkItem>Parameter
- document
- JsonPatchDocument
Das JSON Patch-Dokument, das das Update darstellt
- id
-
number
Die ID des zu aktualisierenden Arbeitselements
- project
-
string
Projekt-ID oder Projektname
- validateOnly
-
boolean
Geben Sie an, ob Sie die Änderungen nur überprüfen möchten, ohne das Arbeitselement zu speichern.
- bypassRules
-
boolean
Erzwingen Sie die Arbeitselementtypregeln für dieses Update nicht.
- suppressNotifications
-
boolean
Keine Benachrichtigungen für diese Änderung auslösen
- expand
- WorkItemExpand
Die Erweiterungsparameter für Arbeitselementattribute. Mögliche Optionen sind { None, Relations, Fields, Links, All }.
Gibt zurück
Promise<WorkItem>
updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)
Hinzufügen/Aktualisieren eines Arbeitselementtyps
function updateWorkItemTypeDefinition(updateModel: WorkItemTypeTemplateUpdateModel, project?: string): Promise<ProvisioningResult>Parameter
- updateModel
- WorkItemTypeTemplateUpdateModel
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<ProvisioningResult>
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für