-
Notifications
You must be signed in to change notification settings - Fork 10
/
WorkItemTrackingRestClient.yml
2081 lines (2081 loc) · 76.1 KB
/
WorkItemTrackingRestClient.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
### YamlMime:TSType
name: WorkItemTrackingRestClient
uid: azure-devops-extension-api.WorkItemTrackingRestClient
package: azure-devops-extension-api
summary: >-
Base class that should be used (derived from) to make requests to VSS REST
apis
fullName: WorkItemTrackingRestClient
remarks: ''
isDeprecated: false
type: class
constructors:
- name: WorkItemTrackingRestClient(IVssRestClientOptions)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.constructor
package: azure-devops-extension-api
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'new WorkItemTrackingRestClient(options: IVssRestClientOptions)'
parameters:
- id: options
type: <xref uid="azure-devops-extension-api.IVssRestClientOptions" />
description: ''
properties:
- name: RESOURCE_AREA_ID
uid: azure-devops-extension-api.WorkItemTrackingRestClient.RESOURCE_AREA_ID
package: azure-devops-extension-api
summary: ''
fullName: RESOURCE_AREA_ID
remarks: ''
isDeprecated: false
syntax:
content: 'static RESOURCE_AREA_ID: string'
return:
description: ''
type: string
methods:
- name: createAttachment(any, string, string, string, string)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.createAttachment
package: azure-devops-extension-api
summary: Uploads an attachment.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createAttachment(content: any, project?: string, fileName?:
string, uploadType?: string, areaPath?: string):
Promise<AttachmentReference>
parameters:
- id: content
type: any
description: Content to upload
- id: project
type: string
description: Project ID or project name
- id: fileName
type: string
description: The name of the file
- id: uploadType
type: string
description: 'Attachment upload type: Simple or Chunked'
- id: areaPath
type: string
description: Target project Area Path
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.AttachmentReference"
/>>
- name: createField(WorkItemField, string)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.createField
package: azure-devops-extension-api
summary: Create a new field.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createField(workItemField: WorkItemField, project?: string):
Promise<WorkItemField>
parameters:
- id: workItemField
type: <xref uid="azure-devops-extension-api.WorkItemField" />
description: New field definition
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: Promise<<xref uid="azure-devops-extension-api.WorkItemField" />>
- name: >-
createOrUpdateClassificationNode(WorkItemClassificationNode, string,
TreeStructureGroup, string)
uid: >-
azure-devops-extension-api.WorkItemTrackingRestClient.createOrUpdateClassificationNode
package: azure-devops-extension-api
summary: Create new or update an existing classification node.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createOrUpdateClassificationNode(postedNode:
WorkItemClassificationNode, project: string, structureGroup:
TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>
parameters:
- id: postedNode
type: <xref uid="azure-devops-extension-api.WorkItemClassificationNode" />
description: Node to create or update.
- id: project
type: string
description: Project ID or project name
- id: structureGroup
type: <xref uid="azure-devops-extension-api.TreeStructureGroup" />
description: Structure group of the classification node, area or iteration.
- id: path
type: string
description: Path of the classification node.
return:
description: ''
type: >-
Promise<<xref
uid="azure-devops-extension-api.WorkItemClassificationNode" />>
- name: createQuery(QueryHierarchyItem, string, string, boolean)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.createQuery
package: azure-devops-extension-api
summary: Creates a query, or moves a query.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createQuery(postedQuery: QueryHierarchyItem, project: string,
query: string, validateWiqlOnly?: boolean): Promise<QueryHierarchyItem>
parameters:
- id: postedQuery
type: <xref uid="azure-devops-extension-api.QueryHierarchyItem" />
description: The query to create.
- id: project
type: string
description: Project ID or project name
- id: query
type: string
description: The parent id or path under which the query is to be created.
- id: validateWiqlOnly
type: boolean
description: >-
If you only want to validate your WIQL query without actually
creating one, set it to true. Default is false.
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.QueryHierarchyItem"
/>>
- name: createTemplate(WorkItemTemplate, string, string)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.createTemplate
package: azure-devops-extension-api
summary: Creates a template
remarks: ''
isDeprecated: false
syntax:
content: >-
function createTemplate(template: WorkItemTemplate, project: string,
team: string): Promise<WorkItemTemplate>
parameters:
- id: template
type: <xref uid="azure-devops-extension-api.WorkItemTemplate" />
description: Template contents
- id: project
type: string
description: Project ID or project name
- id: team
type: string
description: Team ID or team name
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.WorkItemTemplate"
/>>
- name: >-
createWorkItem(JsonPatchDocument, string, string, boolean, boolean,
boolean, WorkItemExpand)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.createWorkItem
package: azure-devops-extension-api
summary: Creates a single work item.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createWorkItem(document: JsonPatchDocument, project: string,
type: string, validateOnly?: boolean, bypassRules?: boolean,
suppressNotifications?: boolean, expand?: WorkItemExpand):
Promise<WorkItem>
parameters:
- id: document
type: <xref uid="azure-devops-extension-api.JsonPatchDocument" />
description: The JSON Patch document representing the work item
- id: project
type: string
description: Project ID or project name
- id: type
type: string
description: The work item type of the work item to create
- id: validateOnly
type: boolean
description: >-
Indicate if you only want to validate the changes without saving the
work item
- id: bypassRules
type: boolean
description: Do not enforce the work item type rules on this update
- id: suppressNotifications
type: boolean
description: Do not fire any notifications for this change
- id: expand
type: <xref uid="azure-devops-extension-api.WorkItemExpand" />
description: >-
The expand parameters for work item attributes. Possible options are
{ None, Relations, Fields, Links, All }.
return:
description: ''
type: Promise<<xref uid="azure-devops-extension-api.WorkItem" />>
- name: deleteClassificationNode(string, TreeStructureGroup, string, number)
uid: >-
azure-devops-extension-api.WorkItemTrackingRestClient.deleteClassificationNode
package: azure-devops-extension-api
summary: Delete an existing classification node.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteClassificationNode(project: string, structureGroup:
TreeStructureGroup, path?: string, reclassifyId?: number): Promise<void>
parameters:
- id: project
type: string
description: Project ID or project name
- id: structureGroup
type: <xref uid="azure-devops-extension-api.TreeStructureGroup" />
description: Structure group of the classification node, area or iteration.
- id: path
type: string
description: Path of the classification node.
- id: reclassifyId
type: number
description: Id of the target classification node for reclassification.
return:
description: ''
type: Promise<void>
- name: deleteField(string, string)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.deleteField
package: azure-devops-extension-api
summary: Deletes the field. To undelete a filed, see "Update Field" API.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteField(fieldNameOrRefName: string, project?: string):
Promise<void>
parameters:
- id: fieldNameOrRefName
type: string
description: Field simple name or reference name
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: Promise<void>
- name: deleteQuery(string, string)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.deleteQuery
package: azure-devops-extension-api
summary: >-
Delete a query or a folder. This deletes any permission change on the
deleted query or folder and any of its descendants if it is a folder. It
is important to note that the deleted permission changes cannot be
recovered upon undeleting the query or folder.
remarks: ''
isDeprecated: false
syntax:
content: 'function deleteQuery(project: string, query: string): Promise<void>'
parameters:
- id: project
type: string
description: Project ID or project name
- id: query
type: string
description: ID or path of the query or folder to delete.
return:
description: ''
type: Promise<void>
- name: deleteTemplate(string, string, string)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.deleteTemplate
package: azure-devops-extension-api
summary: Deletes the template with given id
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteTemplate(project: string, team: string, templateId:
string): Promise<void>
parameters:
- id: project
type: string
description: Project ID or project name
- id: team
type: string
description: Team ID or team name
- id: templateId
type: string
description: Template id
return:
description: ''
type: Promise<void>
- name: deleteWorkItem(number, string, boolean)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.deleteWorkItem
package: azure-devops-extension-api
summary: >-
Deletes the specified work item and sends it to the Recycle Bin, so that
it can be restored back, if required. Optionally, if the destroy parameter
has been set to true, it destroys the work item permanently. WARNING: If
the destroy parameter is set to true, work items deleted by this command
will NOT go to recycle-bin and there is no way to restore/recover them
after deletion. It is recommended NOT to use this parameter. If you do,
please use this parameter with extreme caution.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteWorkItem(id: number, project?: string, destroy?:
boolean): Promise<WorkItemDelete>
parameters:
- id: id
type: number
description: ID of the work item to be deleted
- id: project
type: string
description: Project ID or project name
- id: destroy
type: boolean
description: >-
Optional parameter, if set to true, the work item is deleted
permanently. Please note: the destroy action is PERMANENT and cannot
be undone.
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.WorkItemDelete"
/>>
- name: destroyWorkItem(number, string)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.destroyWorkItem
package: azure-devops-extension-api
summary: >-
Destroys the specified work item permanently from the Recycle Bin. This
action can not be undone.
remarks: ''
isDeprecated: false
syntax:
content: 'function destroyWorkItem(id: number, project?: string): Promise<void>'
parameters:
- id: id
type: number
description: ID of the work item to be destroyed permanently
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: Promise<void>
- name: exportWorkItemTypeDefinition(string, string, boolean)
uid: >-
azure-devops-extension-api.WorkItemTrackingRestClient.exportWorkItemTypeDefinition
package: azure-devops-extension-api
summary: Export work item type
remarks: ''
isDeprecated: false
syntax:
content: >-
function exportWorkItemTypeDefinition(project?: string, type?: string,
exportGlobalLists?: boolean): Promise<WorkItemTypeTemplate>
parameters:
- id: project
type: string
description: Project ID or project name
- id: type
type: string
description: ''
- id: exportGlobalLists
type: boolean
description: ''
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.WorkItemTypeTemplate"
/>>
- name: getAccountMyWorkData(QueryOption)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getAccountMyWorkData
package: azure-devops-extension-api
summary: >-
INTERNAL ONLY: USED BY ACCOUNT MY WORK PAGE. This returns Doing, Done,
Follows and activity work items details.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getAccountMyWorkData(queryOption?: QueryOption):
Promise<AccountMyWorkResult>
parameters:
- id: queryOption
type: <xref uid="azure-devops-extension-api.QueryOption" />
description: ''
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.AccountMyWorkResult"
/>>
- name: getAttachmentContent(string, string, string, boolean)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getAttachmentContent
package: azure-devops-extension-api
summary: Downloads an attachment.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getAttachmentContent(id: string, project?: string, fileName?:
string, download?: boolean): Promise<ArrayBuffer>
parameters:
- id: id
type: string
description: Attachment ID
- id: project
type: string
description: Project ID or project name
- id: fileName
type: string
description: Name of the file
- id: download
type: boolean
description: If set to \<c\>true\</c\> always download attachment
return:
description: ''
type: Promise<ArrayBuffer>
- name: getAttachmentZip(string, string, string, boolean)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getAttachmentZip
package: azure-devops-extension-api
summary: Downloads an attachment.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getAttachmentZip(id: string, project?: string, fileName?:
string, download?: boolean): Promise<ArrayBuffer>
parameters:
- id: id
type: string
description: Attachment ID
- id: project
type: string
description: Project ID or project name
- id: fileName
type: string
description: Name of the file
- id: download
type: boolean
description: If set to \<c\>true\</c\> always download attachment
return:
description: ''
type: Promise<ArrayBuffer>
- name: getClassificationNode(string, TreeStructureGroup, string, number)
uid: >-
azure-devops-extension-api.WorkItemTrackingRestClient.getClassificationNode
package: azure-devops-extension-api
summary: Gets the classification node for a given node path.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getClassificationNode(project: string, structureGroup:
TreeStructureGroup, path?: string, depth?: number):
Promise<WorkItemClassificationNode>
parameters:
- id: project
type: string
description: Project ID or project name
- id: structureGroup
type: <xref uid="azure-devops-extension-api.TreeStructureGroup" />
description: Structure group of the classification node, area or iteration.
- id: path
type: string
description: Path of the classification node.
- id: depth
type: number
description: Depth of children to fetch.
return:
description: ''
type: >-
Promise<<xref
uid="azure-devops-extension-api.WorkItemClassificationNode" />>
- name: >-
getClassificationNodes(string, number[], number,
ClassificationNodesErrorPolicy)
uid: >-
azure-devops-extension-api.WorkItemTrackingRestClient.getClassificationNodes
package: azure-devops-extension-api
summary: >-
Gets root classification nodes or list of classification nodes for a given
list of nodes ids, for a given project. In case ids parameter is supplied
you will get list of classification nodes for those ids. Otherwise you
will get root classification nodes for this project.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getClassificationNodes(project: string, ids: number[], depth?:
number, errorPolicy?: ClassificationNodesErrorPolicy):
Promise<WorkItemClassificationNode[]>
parameters:
- id: project
type: string
description: Project ID or project name
- id: ids
type: number[]
description: >-
Comma separated integer classification nodes ids. It's not required,
if you want root nodes.
- id: depth
type: number
description: Depth of children to fetch.
- id: errorPolicy
type: >-
<xref
uid="azure-devops-extension-api.ClassificationNodesErrorPolicy" />
description: >-
Flag to handle errors in getting some nodes. Possible options are
Fail and Omit.
return:
description: ''
type: >-
Promise<<xref
uid="azure-devops-extension-api.WorkItemClassificationNode" />[]>
- name: getComment(number, number, string)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getComment
package: azure-devops-extension-api
summary: Gets a comment for a work item at the specified revision.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getComment(id: number, revision: number, project?: string):
Promise<WorkItemComment>
parameters:
- id: id
type: number
description: Work item id
- id: revision
type: number
description: Revision for which the comment need to be fetched
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.WorkItemComment"
/>>
- name: getComments(number, string, number, number, CommentSortOrder)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getComments
package: azure-devops-extension-api
summary: >-
Gets the specified number of comments for a work item from the specified
revision.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getComments(id: number, project?: string, fromRevision?:
number, top?: number, order?: CommentSortOrder):
Promise<WorkItemComments>
parameters:
- id: id
type: number
description: Work item id
- id: project
type: string
description: Project ID or project name
- id: fromRevision
type: number
description: Revision from which comments are to be fetched (default is 1)
- id: top
type: number
description: The number of comments to return (default is 200)
- id: order
type: <xref uid="azure-devops-extension-api.CommentSortOrder" />
description: Ascending or descending by revision id (default is ascending)
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.WorkItemComments"
/>>
- name: getDeletedWorkItem(number, string)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getDeletedWorkItem
package: azure-devops-extension-api
summary: Gets a deleted work item from Recycle Bin.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getDeletedWorkItem(id: number, project?: string):
Promise<WorkItemDelete>
parameters:
- id: id
type: number
description: ID of the work item to be returned
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.WorkItemDelete"
/>>
- name: getDeletedWorkItems(number[], string)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getDeletedWorkItems
package: azure-devops-extension-api
summary: >-
Gets the work items from the recycle bin, whose IDs have been specified in
the parameters
remarks: ''
isDeprecated: false
syntax:
content: >-
function getDeletedWorkItems(ids: number[], project?: string):
Promise<WorkItemDeleteReference[]>
parameters:
- id: ids
type: number[]
description: Comma separated list of IDs of the deleted work items to be returned
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: >-
Promise<<xref
uid="azure-devops-extension-api.WorkItemDeleteReference" />[]>
- name: getDeletedWorkItemShallowReferences(string)
uid: >-
azure-devops-extension-api.WorkItemTrackingRestClient.getDeletedWorkItemShallowReferences
package: azure-devops-extension-api
summary: >-
Gets a list of the IDs and the URLs of the deleted the work items in the
Recycle Bin.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getDeletedWorkItemShallowReferences(project?: string):
Promise<WorkItemDeleteShallowReference[]>
parameters:
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: >-
Promise<<xref
uid="azure-devops-extension-api.WorkItemDeleteShallowReference"
/>[]>
- name: getField(string, string)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getField
package: azure-devops-extension-api
summary: Gets information on a specific field.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getField(fieldNameOrRefName: string, project?: string):
Promise<WorkItemField>
parameters:
- id: fieldNameOrRefName
type: string
description: Field simple name or reference name
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: Promise<<xref uid="azure-devops-extension-api.WorkItemField" />>
- name: getFields(string, GetFieldsExpand)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getFields
package: azure-devops-extension-api
summary: >-
Returns information for all fields. The project ID/name parameter is
optional.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getFields(project?: string, expand?: GetFieldsExpand):
Promise<WorkItemField[]>
parameters:
- id: project
type: string
description: Project ID or project name
- id: expand
type: <xref uid="azure-devops-extension-api.GetFieldsExpand" />
description: >-
Use ExtensionFields to include extension fields, otherwise exclude
them. Unless the feature flag for this parameter is enabled,
extension fields are always included.
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.WorkItemField"
/>[]>
- name: getQueries(string, QueryExpand, number, boolean)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getQueries
package: azure-devops-extension-api
summary: Gets the root queries and their children
remarks: ''
isDeprecated: false
syntax:
content: >-
function getQueries(project: string, expand?: QueryExpand, depth?:
number, includeDeleted?: boolean): Promise<QueryHierarchyItem[]>
parameters:
- id: project
type: string
description: Project ID or project name
- id: expand
type: <xref uid="azure-devops-extension-api.QueryExpand" />
description: >-
Include the query string (wiql), clauses, query result columns, and
sort options in the results.
- id: depth
type: number
description: >-
In the folder of queries, return child queries and folders to this
depth.
- id: includeDeleted
type: boolean
description: Include deleted queries and folders
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.QueryHierarchyItem"
/>[]>
- name: getQueriesBatch(QueryBatchGetRequest, string)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getQueriesBatch
package: azure-devops-extension-api
summary: Gets a list of queries by ids (Maximum 1000)
remarks: ''
isDeprecated: false
syntax:
content: >-
function getQueriesBatch(queryGetRequest: QueryBatchGetRequest, project:
string): Promise<QueryHierarchyItem[]>
parameters:
- id: queryGetRequest
type: <xref uid="azure-devops-extension-api.QueryBatchGetRequest" />
description: ''
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.QueryHierarchyItem"
/>[]>
- name: getQuery(string, string, QueryExpand, number, boolean, boolean)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getQuery
package: azure-devops-extension-api
summary: Retrieves an individual query and its children
remarks: ''
isDeprecated: false
syntax:
content: >-
function getQuery(project: string, query: string, expand?: QueryExpand,
depth?: number, includeDeleted?: boolean, useIsoDateFormat?: boolean):
Promise<QueryHierarchyItem>
parameters:
- id: project
type: string
description: Project ID or project name
- id: query
type: string
description: ID or path of the query.
- id: expand
type: <xref uid="azure-devops-extension-api.QueryExpand" />
description: >-
Include the query string (wiql), clauses, query result columns, and
sort options in the results.
- id: depth
type: number
description: >-
In the folder of queries, return child queries and folders to this
depth.
- id: includeDeleted
type: boolean
description: Include deleted queries and folders
- id: useIsoDateFormat
type: boolean
description: >-
DateTime query clauses will be formatted using a ISO 8601 compliant
format
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.QueryHierarchyItem"
/>>
- name: getQueryResultCount(string, string, string, boolean, number)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getQueryResultCount
package: azure-devops-extension-api
summary: Gets the results of the query given the query ID.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getQueryResultCount(id: string, project?: string, team?:
string, timePrecision?: boolean, top?: number): Promise<number>
parameters:
- id: id
type: string
description: The query ID.
- id: project
type: string
description: Project ID or project name
- id: team
type: string
description: Team ID or team name
- id: timePrecision
type: boolean
description: Whether or not to use time precision.
- id: top
type: number
description: The max number of results to return.
return:
description: ''
type: Promise<number>
- name: getRecentActivityData()
uid: >-
azure-devops-extension-api.WorkItemTrackingRestClient.getRecentActivityData
package: azure-devops-extension-api
summary: Gets recent work item activities
remarks: ''
isDeprecated: false
syntax:
content: >-
function getRecentActivityData():
Promise<AccountRecentActivityWorkItemModel2[]>
return:
description: ''
type: >-
Promise<<xref
uid="azure-devops-extension-api.AccountRecentActivityWorkItemModel2"
/>[]>
- name: getRecentMentions()
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getRecentMentions
package: azure-devops-extension-api
summary: 'INTERNAL ONLY: USED BY ACCOUNT MY WORK PAGE.'
remarks: ''
isDeprecated: false
syntax:
content: >-
function getRecentMentions():
Promise<AccountRecentMentionWorkItemModel[]>
return:
description: ''
type: >-
Promise<<xref
uid="azure-devops-extension-api.AccountRecentMentionWorkItemModel"
/>[]>
- name: getRelationType(string)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getRelationType
package: azure-devops-extension-api
summary: Gets the work item relation type definition.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getRelationType(relation: string):
Promise<WorkItemRelationType>
parameters:
- id: relation
type: string
description: The relation name
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.WorkItemRelationType"
/>>
- name: getRelationTypes()
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getRelationTypes
package: azure-devops-extension-api
summary: Gets the work item relation types.
remarks: ''
isDeprecated: false
syntax:
content: 'function getRelationTypes(): Promise<WorkItemRelationType[]>'
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.WorkItemRelationType"
/>[]>
- name: getReportingLinksByLinkType(string, string[], string[], string, Date)
uid: >-
azure-devops-extension-api.WorkItemTrackingRestClient.getReportingLinksByLinkType
package: azure-devops-extension-api
summary: Get a batch of work item links
remarks: ''
isDeprecated: false
syntax:
content: >-
function getReportingLinksByLinkType(project?: string, linkTypes?:
string[], types?: string[], continuationToken?: string, startDateTime?:
Date): Promise<ReportingWorkItemLinksBatch>
parameters:
- id: project
type: string
description: Project ID or project name
- id: linkTypes
type: string[]
description: >-
A list of types to filter the results to specific link types. Omit
this parameter to get work item links of all link types.
- id: types
type: string[]
description: >-
A list of types to filter the results to specific work item types.
Omit this parameter to get work item links of all work item types.
- id: continuationToken
type: string
description: >-
Specifies the continuationToken to start the batch from. Omit this
parameter to get the first batch of links.
- id: startDateTime
type: Date
description: >-
Date/time to use as a starting point for link changes. Only link
changes that occurred after that date/time will be returned. Cannot
be used in conjunction with 'watermark' parameter.
return:
description: ''
type: >-
Promise<<xref
uid="azure-devops-extension-api.ReportingWorkItemLinksBatch" />>
- name: getRevision(number, number, string, WorkItemExpand)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getRevision
package: azure-devops-extension-api
summary: Returns a fully hydrated work item for the requested revision
remarks: ''
isDeprecated: false
syntax:
content: >-
function getRevision(id: number, revisionNumber: number, project?:
string, expand?: WorkItemExpand): Promise<WorkItem>
parameters:
- id: id
type: number
description: ''
- id: revisionNumber
type: number
description: ''
- id: project
type: string
description: Project ID or project name
- id: expand
type: <xref uid="azure-devops-extension-api.WorkItemExpand" />
description: ''
return:
description: ''
type: Promise<<xref uid="azure-devops-extension-api.WorkItem" />>
- name: getRevisions(number, string, number, number, WorkItemExpand)
uid: azure-devops-extension-api.WorkItemTrackingRestClient.getRevisions
package: azure-devops-extension-api
summary: Returns the list of fully hydrated work item revisions, paged.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getRevisions(id: number, project?: string, top?: number, skip?:
number, expand?: WorkItemExpand): Promise<WorkItem[]>
parameters:
- id: id
type: number
description: ''
- id: project
type: string
description: Project ID or project name
- id: top
type: number
description: ''
- id: skip
type: number
description: ''
- id: expand
type: <xref uid="azure-devops-extension-api.WorkItemExpand" />
description: ''
return:
description: ''
type: Promise<<xref uid="azure-devops-extension-api.WorkItem" />[]>
- name: getRootNodes(string, number)