-
Notifications
You must be signed in to change notification settings - Fork 0
/
jira-rest-plugin.wadl
2451 lines (2414 loc) · 349 KB
/
jira-rest-plugin.wadl
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
<?xml version="1.0" encoding="UTF-8"?>
<ns2:application
xmlns:ns2="http://research.sun.com/wadl/2006/10"><ns2:doc
jersey:generatedBy="Jersey: 1.8 06/24/2011 12:17 PM"
xmlns:jersey="http://jersey.java.net/"/><ns2:doc
title="JIRA 6.1.7 REST API documentation"
xml:lang="en"><![CDATA[
This documents the current REST API provided by JIRA.
]]></ns2:doc><ns2:grammars/><ns2:resources
base="http://example.com:8080/jira/rest/"><ns2:resource
path="api/2/search"><ns2:doc><![CDATA[Resource for searches.]]></ns2:doc><ns2:method
id="search"
name="GET"><ns2:doc><![CDATA[Searches for issues using JQL.
<p><b>Sorting</b>
the <code>jql</code> parameter is a full <a href="http://confluence.atlassian.com/display/JIRA/Advanced+Searching">JQL</a>
expression, and includes an <code>ORDER BY</code> clause.
</p>
<p>
The <code>fields</code> param (which can be specified multiple times) gives a comma-separated list of fields
to include in the response. This can be used to retrieve a subset of fields.
A particular field can be excluded by prefixing it with a minus.
<p>
By default, only navigable (<code>*navigable</code>) fields are returned in this search resource. Note: the default is different
in the get-issue resource -- the default there all fields (<code>*all</code>).
<ul>
<li><code>*all</code> - include all fields</li>
<li><code>*navigable</code> - include just navigable fields</li>
<li><code>summary,comment</code> - include just the summary and comments</li>
<li><code>-description</code> - include navigable fields except the description (the default is <code>*navigable</code> for search)</li>
<li><code>*all,-comment</code> - include everything except comments</li>
</ul>
</p>
<p><b>GET vs POST:</b>
If the JQL query is too large to be encoded as a query param you should instead
POST to this resource.
</p>
<p><b>Expanding Issues in the Search Result:</b>
It is possible to expand the issues returned by directly specifying the expansion on the expand parameter passed
in to this resources.
</p>
<p>
For instance, to expand the "changelog" for all the issues on the search result, it is neccesary to
specify "changelog" as one of the values to expand.
</p>]]></ns2:doc><ns2:request><ns2:param
name="jql" style="query" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[a JQL query string]]></ns2:doc></ns2:param><ns2:param
name="startAt" style="query" type="xs:int"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the index of the first issue to return (0-based)]]></ns2:doc></ns2:param><ns2:param
name="maxResults" style="query" type="xs:int"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the maximum number of issues to return (defaults to 50). The maximum allowable value is
dictated by the JIRA property 'jira.search.views.default.max'. If you specify a value that is higher than this
number, your search results will be truncated.]]></ns2:doc></ns2:param><ns2:param
name="validateQuery" style="query"
type="xs:boolean" default="true"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[whether to validate the JQL query]]></ns2:doc></ns2:param><ns2:param
name="fields" style="query" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the list of fields to return for each issue. By default, all navigable fields are returned.]]></ns2:doc></ns2:param><ns2:param
name="expand" style="query" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[A comma-separated list of the parameters to expand.]]></ns2:doc></ns2:param></ns2:request><ns2:response><ns2:representation
element="searchResults" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"expand":"names,schema","startAt":0,"maxResults":50,"total":1,"issues":[{"expand":"","id":"10001","self":"http://www.example.com/jira/rest/api/2/issue/10001","key":"HSP-1"}]}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returns a JSON representation of the search results.]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if there is a problem with the JQL query.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="searchUsingSearchRequest"
name="POST"><ns2:doc><![CDATA[Performs a search using JQL.]]></ns2:doc><ns2:request><ns2:representation
element="searchRequest"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"jql":"project = HSP","startAt":0,"maxResults":15,"fields":["summary","status","assignee"]}</ns3:code></ns3:pre></ns3:p></ns2:doc></ns2:representation></ns2:request><ns2:response><ns2:representation
element="searchResults" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"expand":"names,schema","startAt":0,"maxResults":50,"total":1,"issues":[{"expand":"","id":"10001","self":"http://www.example.com/jira/rest/api/2/issue/10001","key":"HSP-1"}]}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returns a JSON representation of the search results.]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if there is a problem with the JQL query.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="api/2/issue/{issueIdOrKey}/attachments"><ns2:doc><![CDATA[Issue attachments]]></ns2:doc><ns2:param
name="issueIdOrKey" style="template" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the issue that you want to add the attachments to]]></ns2:doc></ns2:param><ns2:method
id="addAttachment"
name="POST"><ns2:doc><![CDATA[Add one or more attachments to an issue.
<p>
This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client
libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components
library provides a
<a href="http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntity.html">MultiPartEntity</a>
that makes it simple to submit a multipart POST.
<p>
In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection
on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be
blocked.
<p>
The name of the multipart/form-data parameter that contains attachments must be "file"
<p>
A simple example to upload a file called "myfile.txt" to issue REST-123:
<pre>curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "[email protected]" http://myhost/rest/api/2/issue/TEST-123/attachments</pre>]]></ns2:doc><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the requested issue is not found, the user does not have permission to view it, or if the
attachments exceeds the maximum configured attachment size.]]></ns2:doc></ns2:representation><ns2:representation
status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>[{"self":"http://www.example.com/jira/rest/api/2.0/attachments/10000","filename":"picture.jpg","author":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"created":"2014-01-28T14:29:00.005+0100","size":23123,"mimeType":"image/jpeg","content":"http://www.example.com/jira/attachments/10000","thumbnail":"http://www.example.com/jira/secure/thumbnail/10000"},{"self":"http://www.example.com/jira/rest/api/2.0/attachments/10001","filename":"dbeuglog.txt","author":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"created":"2014-01-28T14:29:00.005+0100","size":2460,"mimeType":"text/plain","content":"http://www.example.com/jira/attachments/10001","thumbnail":"http://www.example.com/jira/secure/thumbnail/10002"}]</ns3:code></ns3:pre></ns3:p></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if attachments is disabled or if you don't have permission to add attachments to this issue.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="api/2/project"><ns2:method id="getAllProjects"
name="GET"><ns2:doc><![CDATA[Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the
list of projects that are visible when using anonymous access.]]></ns2:doc><ns2:response><ns2:representation
element="projects" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>[{"self":"http://www.example.com/jira/rest/api/2/project/EX","id":"10000","key":"EX","name":"Example","avatarUrls":{"24x24":"http://www.example.com/jira/secure/projectavatar?size=small&pid=10000","16x16":"http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000","32x32":"http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000","48x48":"http://www.example.com/jira/secure/projectavatar?size=large&pid=10000"}},{"self":"http://www.example.com/jira/rest/api/2/project/ABC","id":"10001","key":"ABC","name":"Alphabetical","avatarUrls":{"24x24":"http://www.example.com/jira/secure/projectavatar?size=small&pid=10001","16x16":"http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10001","32x32":"http://www.example.com/jira/secure/projectavatar?size=medium&pid=10001","48x48":"http://www.example.com/jira/secure/projectavatar?size=large&pid=10001"}}]</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returns a list of projects for which the user has the BROWSE, ADMINISTER or PROJECT_ADMIN project permission.]]></ns2:doc></ns2:representation><ns2:representation
status="500"><ns2:doc><![CDATA[Returned if an error occurs while retrieving the list of projects.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:resource
path="{projectIdOrKey}"><ns2:param
name="projectIdOrKey" style="template"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the project id or project key]]></ns2:doc></ns2:param><ns2:method
id="getProject"
name="GET"><ns2:doc><![CDATA[Contains a full representation of a project in JSON format.
<p>
All project keys associated with the project will only be returned if <code>expand=projectKeys</code>.
<p>]]></ns2:doc><ns2:request><ns2:param
name="expand" style="query" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"/></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the project is not found, or the calling user does not have permission to view it.]]></ns2:doc></ns2:representation><ns2:representation
element="project" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"self":"http://www.example.com/jira/rest/api/2/project/EX","id":"10000","key":"EX","description":"This project was created as an example for REST.","lead":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"components":[{"self":"http://www.example.com/jira/rest/api/2/component/10000","id":"10000","name":"Component 1","description":"This is a JIRA component","lead":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"assigneeType":"PROJECT_LEAD","assignee":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"realAssigneeType":"PROJECT_LEAD","realAssignee":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"isAssigneeTypeValid":false}],"issueTypes":[{"self":"http://localhost:8090/jira/rest/api/2.0/issueType/3","id":"3","description":"A task that needs to be done.","iconUrl":"http://localhost:8090/jira/images/icons/issuetypes/task.png","name":"Task","subtask":false},{"self":"http://localhost:8090/jira/rest/api/2.0/issueType/1","id":"1","description":"A problem with the software.","iconUrl":"http://localhost:8090/jira/images/icons/issuetypes/bug.png","name":"Bug","subtask":false}],"url":"http://www.example.com/jira/browse/EX","email":"[email protected]","assigneeType":"PROJECT_LEAD","versions":[],"name":"Example","roles":{"Developers":"http://www.example.com/jira/rest/api/2/project/EX/role/10000"},"avatarUrls":{"24x24":"http://www.example.com/jira/secure/projectavatar?size=small&pid=10000","16x16":"http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000","32x32":"http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000","48x48":"http://www.example.com/jira/secure/projectavatar?size=large&pid=10000"}}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the project exists and the user has permission to view it. Contains a full representation
of a project in JSON format.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{projectIdOrKey}/avatar/temporary"><ns2:param
name="projectIdOrKey" style="template"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[Project id or project key]]></ns2:doc></ns2:param><ns2:method
id="storeTemporaryAvatar"
name="POST"><ns2:doc><![CDATA[Creates temporary avatar]]></ns2:doc><ns2:request><ns2:param
name="filename" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[name of file being uploaded]]></ns2:doc></ns2:param><ns2:param
name="size" style="query" type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[size of file]]></ns2:doc></ns2:param></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have EDIT PROJECT permission.]]></ns2:doc></ns2:representation><ns2:representation
element="avatar" status="201"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"url":"http://example.com/jira/secure/temporaryavatar?cropped=true","needsCropping":true}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[temporary avatar cropping instructions]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Validation failed. For example filesize is beyond max attachment size.]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the request does not contain a valid XSRF token]]></ns2:doc></ns2:representation><ns2:representation
status="500"><ns2:doc><![CDATA[Returned if an error occurs while converting temporary avatar to real avatar]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="storeTemporaryAvatarUsingMultiPart"
name="POST"><ns2:doc><![CDATA[Creates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because
the client uses remote iframing to submit avatars using multipart. So we must send them a valid HTML page back from
which the client parses the JSON.]]></ns2:doc><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have EDIT PROJECT permission.]]></ns2:doc></ns2:representation><ns2:representation
element="avatar" status="201"
mediaType="text/html"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"url":"http://example.com/jira/secure/temporaryavatar?cropped=true","needsCropping":true}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[temporary avatar cropping instructions embeded in HTML page. Error messages will also be embeded in the page.]]></ns2:doc></ns2:representation><ns2:representation
status="500"><ns2:doc><![CDATA[Returned if an error occurs while converting temporary avatar to real avatar]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{projectIdOrKey}/avatar"><ns2:param
name="projectIdOrKey" style="template"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"/><ns2:method
id="createAvatarFromTemporary"
name="POST"><ns2:doc><![CDATA[Converts temporary avatar into a real avatar]]></ns2:doc><ns2:request><ns2:representation
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"needsCropping":false}</ns3:code></ns3:pre></ns3:p></ns2:doc></ns2:representation></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have EDIT PROJECT permission.]]></ns2:doc></ns2:representation><ns2:representation
element="avatar" status="201"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"id":"1000","owner":"fred","isSystemAvatar":true,"isSelected":true,"selected":true}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returns created avatar]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if the cropping coordinates are invalid]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have permission to pick avatar]]></ns2:doc></ns2:representation><ns2:representation
status="500"><ns2:doc><![CDATA[Returned if an error occurs while converting temporary avatar to real avatar]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="updateProjectAvatar"
name="PUT"><ns2:request><ns2:representation
mediaType="application/json"/></ns2:request><ns2:response><ns2:representation
mediaType="application/json"/></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{projectIdOrKey}/versions"><ns2:param
name="projectIdOrKey" style="template"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the project id or project key]]></ns2:doc></ns2:param><ns2:method
id="getProjectVersions"
name="GET"><ns2:doc><![CDATA[Contains a full representation of a the specified project's versions.]]></ns2:doc><ns2:request><ns2:param
name="expand" style="query" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"/></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the project is not found, or the calling user does not have permission to view it.]]></ns2:doc></ns2:representation><ns2:representation
element="versions" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>[{"self":"http://www.example.com/jira/rest/api/2/version/10000","id":"10000","description":"An excellent version","name":"New Version 1","archived":false,"released":true,"releaseDate":"2010-07-06","overdue":true,"userReleaseDate":"6/Jul/2010","projectId":10000},{"self":"http://www.example.com/jira/rest/api/2/version/10010","id":"10010","description":"Minor Bugfix version","name":"Next Version","archived":false,"released":false,"overdue":false,"projectId":10000}]</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the project exists and the user has permission to view its versions. Contains a full
representation of the project's versions in JSON format.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{projectIdOrKey}/components"><ns2:param
name="projectIdOrKey" style="template"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the project id or project key]]></ns2:doc></ns2:param><ns2:method
id="getProjectComponents"
name="GET"><ns2:doc><![CDATA[Contains a full representation of a the specified project's components.]]></ns2:doc><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the project is not found, or the calling user does not have permission to view it.]]></ns2:doc></ns2:representation><ns2:representation
element="components" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>[{"self":"http://www.example.com/jira/rest/api/2/component/10000","id":"10000","name":"Component 1","description":"This is a JIRA component","lead":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"assigneeType":"PROJECT_LEAD","assignee":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"realAssigneeType":"PROJECT_LEAD","realAssignee":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"isAssigneeTypeValid":false},{"self":"http://www.example.com/jira/rest/api/2/component/10000","id":"10050","name":"PXA","description":"This is a another JIRA component","lead":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"assigneeType":"PROJECT_LEAD","assignee":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"realAssigneeType":"PROJECT_LEAD","realAssignee":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"isAssigneeTypeValid":false}]</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the project exists and the user has permission to view its components. Contains a full
representation of the project's components in JSON format.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{projectIdOrKey}/avatars"><ns2:param
name="projectIdOrKey" style="template"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[project id or project key]]></ns2:doc></ns2:param><ns2:method
id="getAllAvatars"
name="GET"><ns2:doc><![CDATA[Returns all avatars which are visible for the currently logged in user. The avatars are grouped into
system and custom.]]></ns2:doc><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have VIEW PROJECT permission.]]></ns2:doc></ns2:representation><ns2:representation
element="avatars" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"system":[{"id":"1000","owner":"fred","isSystemAvatar":true,"isSelected":true,"selected":true}],"custom":[{"id":"1010","owner":"andrew","isSystemAvatar":false,"isSelected":false,"selected":false}]}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returns a map containing a list of avatars for both custom an system avatars, which the user has the BROWSE project permission.]]></ns2:doc></ns2:representation><ns2:representation
status="500"><ns2:doc><![CDATA[Returned if an error occurs while retrieving the list of avatars.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{projectIdOrKey}/avatar/{id}"><ns2:param
name="id" style="template" type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[database id for avatar]]></ns2:doc></ns2:param><ns2:param
name="projectIdOrKey" style="template"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[Project id or project key]]></ns2:doc></ns2:param><ns2:method
id="deleteAvatar"
name="DELETE"><ns2:doc><![CDATA[Deletes avatar]]></ns2:doc><ns2:response><ns2:representation
status="204"
mediaType="application/json"><ns2:doc><![CDATA[Returned if the avatar is successfully deleted.]]></ns2:doc></ns2:representation><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the avatar does not exist or the currently authenticated user does not have permission to
delete it.]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have permission to delete the component.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{projectIdOrKey}/statuses"><ns2:param
name="projectIdOrKey" style="template"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[Project id or project key]]></ns2:doc></ns2:param><ns2:method
id="getAllStatuses"
name="GET"><ns2:doc><![CDATA[Get all issue types with valid status values for a project]]></ns2:doc><ns2:response><ns2:representation
status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>[{"self":"http://localhost:8090/jira/rest/api/2.0/issueType/3","id":"3","name":"Task","subtask":false,"statuses":[{"self":"http://localhost:8090/jira/rest/api/2.0/status/10000","description":"The issue is currently being worked on.","iconUrl":"http://localhost:8090/jira/images/icons/progress.gif","name":"In Progress","id":"10000"},{"self":"http://localhost:8090/jira/rest/api/2.0/status/5","description":"The issue is closed.","iconUrl":"http://localhost:8090/jira/images/icons/closed.gif","name":"Closed","id":"5"}]}]</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the project exists and the user has permission to view its components. Contains a full
representation of issue types with status values which are valid for each issue type.]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if the project is not found, or the calling user does not have permission to view it.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource></ns2:resource><ns2:resource
path="api/2/groupuserpicker"><ns2:method
id="findUsersAndGroups"
name="GET"><ns2:doc><![CDATA[Returns a list of users and groups matching query with highlighting. This resource cannot be accessed
anonymously.]]></ns2:doc><ns2:request><ns2:param
name="query" style="query" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[A string used to search username, Name or e-mail address]]></ns2:doc></ns2:param><ns2:param
name="maxResults" style="query" type="xs:int"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If
you specify a value that is higher than this number, your search results will be truncated.]]></ns2:doc></ns2:param><ns2:param
name="showAvatar" style="query"
type="xs:boolean"
xmlns:xs="http://www.w3.org/2001/XMLSchema"/></ns2:request><ns2:response><ns2:doc><![CDATA[An object containing list of matched user objects, with html representing highlighting.]]></ns2:doc><ns2:representation
mediaType="application/json"/></ns2:response></ns2:method></ns2:resource><ns2:resource
path="api/2/resolution"><ns2:method id="getResolutions"
name="GET"><ns2:doc><![CDATA[Returns a list of all resolutions.]]></ns2:doc><ns2:response><ns2:representation
element="list of resolutions" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>[{"self":"http://www.example.com/jira/rest/api/2/resolution/1","description":"A fix for this issue is checked into the tree and tested.","iconUrl":"http://www.example.com/jira/images/icons/statuses/resolved.png","name":"Fixed"},{"self":"http://www.example.com/jira/rest/api/2/resolution/3","description":"This is what it is supposed to do.","name":"Works as designed"}]</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the resolutions exists and the user has permission to view them. Contains a full representation of
the resolution in JSON format.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:resource
path="{id}"><ns2:param name="id" style="template"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[a String containing the resolution id]]></ns2:doc></ns2:param><ns2:method
id="getResolution"
name="GET"><ns2:doc><![CDATA[Returns a resolution.]]></ns2:doc><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the resolution does not exist or the user does not have permission to view it.]]></ns2:doc></ns2:representation><ns2:representation
element="resolution" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"self":"http://www.example.com/jira/rest/api/2/resolution/1","description":"A fix for this issue is checked into the tree and tested.","iconUrl":"http://www.example.com/jira/images/icons/statuses/resolved.png","name":"Fixed"}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the resolution exists and the user has permission to view it. Contains a full representation of
the resolution in JSON format.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource></ns2:resource><ns2:resource
path="api/2/field"><ns2:method id="getFields"
name="GET"><ns2:doc><![CDATA[Returns a list of all fields, both System and Custom]]></ns2:doc><ns2:response><ns2:representation
element="List of field" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>[{"id":"description","name":"Description","custom":false,"orderable":true,"navigable":true,"searchable":true,"schema":{"type":"string","system":"description"}},{"id":"summary","name":"Summary","custom":false,"schema":{"type":"string","system":"summary"}}]</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Contains a full representation of all visible fields in JSON.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="createCustomField"
name="POST"><ns2:doc><![CDATA[Creates a custom field using a definition (object encapsulating custom field data)]]></ns2:doc><ns2:request><ns2:representation
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"name":"New custom field","description":"Custom field for picking groups","type":"com.atlassian.jira.plugin.system.customfieldtypes:grouppicker","searcherKey":"com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher"}</ns3:code></ns3:pre></ns3:p></ns2:doc></ns2:representation></ns2:request><ns2:response><ns2:representation
status="201"><ns2:doc><![CDATA[Returned if custom field was created. {@link FieldBean#DOC_EXAMPLE_CF}]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if the input is invalid (e.g. invalid values).]]></ns2:doc></ns2:representation><ns2:representation
status="500"><ns2:doc><![CDATA[Returned if exception occured during custom field creation.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="api/2/project/{projectIdOrKey}/role"><ns2:param
name="projectIdOrKey" style="template" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the project id or project key]]></ns2:doc></ns2:param><ns2:method
id="getProjectRoles"
name="GET"><ns2:doc><![CDATA[Contains a list of roles in this project with links to full details.]]></ns2:doc><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the project is not found, or the calling user does not have permission to view it.]]></ns2:doc></ns2:representation><ns2:representation
status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"Users":"http://www.example.com/jira/rest/api/2/project/MKY/role/10001","Administrators":"http://www.example.com/jira/rest/api/2/project/MKY/role/10002","Developers":"http://www.example.com/jira/rest/api/2/project/MKY/role/10000"}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the project exists and the user has permission to view it. A maps of roles to URIs containing
full details for that role.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:resource
path="{id}"><ns2:param name="id" style="template"
type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the project role id]]></ns2:doc></ns2:param><ns2:param
name="projectIdOrKey" style="template"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the project id or project key]]></ns2:doc></ns2:param><ns2:method
id="getProjectRole"
name="GET"><ns2:doc><![CDATA[Details on a given project role.]]></ns2:doc><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the project or role is not found, or the calling user does not have permission to view it.]]></ns2:doc></ns2:representation><ns2:representation
status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"self":"http://www.example.com/jira/rest/api/2/project/MKY/role/10360","name":"Developers","id":10360,"description":"A project role that represents developers in a project","actors":[{"id":10240,"displayName":"jira-developers","type":"atlassian-group-role-actor","name":"jira-developers"}]}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the project and role exists and the user has permission to view it. Contains the role name,
description, and project actors.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="setActors"
name="PUT"><ns2:doc><![CDATA[Updates a project role to contain the sent actors.]]></ns2:doc><ns2:request><ns2:representation
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{ "user" : ["admin"] } or
{ "group" : ["jira-developers"] }</ns3:code></ns3:pre></ns3:p></ns2:doc></ns2:representation></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the actor could not be added to the project role]]></ns2:doc></ns2:representation><ns2:representation
status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"self":"http://www.example.com/jira/rest/api/2/project/MKY/role/10360","name":"Developers","id":10360,"description":"A project role that represents developers in a project","actors":[{"id":10240,"displayName":"jira-developers","type":"atlassian-group-role-actor","name":"jira-developers"}]}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the project and role exists and the user has permission to view it. Contains the role name,
description, and project actors.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="addActorUsers"
name="POST"><ns2:doc><![CDATA[Add an actor to a project role.]]></ns2:doc><ns2:request><ns2:representation
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{ "user" : ["admin"] } or
{ "group" : ["jira-developers"] }</ns3:code></ns3:pre></ns3:p></ns2:doc></ns2:representation></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the actor could not be added to the project role]]></ns2:doc></ns2:representation><ns2:representation
status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"self":"http://www.example.com/jira/rest/api/2/project/MKY/role/10360","name":"Developers","id":10360,"description":"A project role that represents developers in a project","actors":[{"id":10240,"displayName":"jira-developers","type":"atlassian-group-role-actor","name":"jira-developers"}]}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the project and role exists and the user has permission to view it. Contains the role name,
description, and project actors.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="deleteActor"
name="DELETE"><ns2:doc><![CDATA[Remove actors from a project role.]]></ns2:doc><ns2:response><ns2:representation
status="204"><ns2:doc><![CDATA[Returned if the actor was successfully removed from the project role.]]></ns2:doc></ns2:representation><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the project or role is not found, the calling user does not have permission to view it, or does
not have permission to modify the actors in the project role.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource></ns2:resource><ns2:resource
path="api/2/version"><ns2:method id="createVersion"
name="POST"><ns2:doc><![CDATA[Create a version via POST.]]></ns2:doc><ns2:request><ns2:representation
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"description":"An excellent version","name":"New Version 1","archived":false,"released":true,"releaseDate":"2010-07-06","userReleaseDate":"6/Jul/2010","project":"PXA","projectId":10000}</ns3:code></ns3:pre></ns3:p></ns2:doc></ns2:representation></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the version does not exist or the currently authenticated user does not have permission to
view it.]]></ns2:doc></ns2:representation><ns2:representation
status="201"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"description":"An excellent version","name":"New Version 1","archived":false,"released":true,"releaseDate":"2010-07-06","userReleaseDate":"6/Jul/2010","project":"PXA","projectId":10000}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the version is created successfully.]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have permission to edit the version.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:resource
path="{id}"><ns2:param name="id" style="template"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"/><ns2:method
id="delete"
name="DELETE"><ns2:doc><![CDATA[Delete a project version.]]></ns2:doc><ns2:request><ns2:param
name="moveFixIssuesTo" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[The version to set fixVersion to on issues where the deleted version is the fix version,
If null then the fixVersion is removed.]]></ns2:doc></ns2:param><ns2:param
name="moveAffectedIssuesTo" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[The version to set affectedVersion to on issues where the deleted version is the affected version,
If null then the affectedVersion is removed.]]></ns2:doc></ns2:param></ns2:request><ns2:response><ns2:representation
status="204"><ns2:doc><![CDATA[Returned if the version is successfully deleted.]]></ns2:doc></ns2:representation><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the version does not exist or the currently authenticated user does not have permission to
view it.]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have permission to delete the version.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="getVersion"
name="GET"><ns2:doc><![CDATA[Returns a project version.]]></ns2:doc><ns2:request><ns2:param
name="expand" style="query" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"/></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the version does not exist or the currently authenticated user does not have permission to
view it.]]></ns2:doc></ns2:representation><ns2:representation
element="version" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"self":"http://www.example.com/jira/rest/api/2/version/10000","id":"10000","description":"An excellent version","name":"New Version 1","archived":false,"released":true,"releaseDate":"2010-07-06","overdue":true,"userReleaseDate":"6/Jul/2010","projectId":10000}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the version exists and the currently authenticated user has permission to view it. Contains a
full representation of the version.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="updateVersion"
name="PUT"><ns2:doc><![CDATA[Modify a version via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field
is not present, it is silently ignored.]]></ns2:doc><ns2:request><ns2:representation
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"self":"http://www.example.com/jira/rest/api/2/version/10000","id":"10000","description":"An excellent version","name":"New Version 1","archived":false,"released":true,"releaseDate":"2010-07-06","overdue":true,"userReleaseDate":"6/Jul/2010","projectId":10000}</ns3:code></ns3:pre></ns3:p></ns2:doc></ns2:representation></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the version does not exist or the currently authenticated user does not have permission to
view it.]]></ns2:doc></ns2:representation><ns2:representation
status="200"><ns2:doc><![CDATA[Returned if the version exists and the currently authenticated user has permission to edit it.]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have permission to edit the version.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{id}/relatedIssueCounts"><ns2:param name="id"
style="template" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[a String containing the version id]]></ns2:doc></ns2:param><ns2:method
id="getVersionRelatedIssues"
name="GET"><ns2:doc><![CDATA[Returns a bean containing the number of fixed in and affected issues for the given version.]]></ns2:doc><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the version does not exist or the currently authenticated user does not have permission to
view it.]]></ns2:doc></ns2:representation><ns2:representation
element="issue Count Bean" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"self":"http://www.example.com/jira/rest/api/2/version/10000","issuesFixedCount":23,"issuesAffectedCount":101}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the version exists and the currently authenticated user has permission to view it. Contains
counts of issues fixed in and affecting this version.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{id}/unresolvedIssueCount"><ns2:param
name="id" style="template" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[a String containing the version id]]></ns2:doc></ns2:param><ns2:method
id="getVersionUnresolvedIssues"
name="GET"><ns2:doc><![CDATA[Returns the number of unresolved issues for the given version]]></ns2:doc><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the version does not exist or the currently authenticated user does not have permission to
view it.]]></ns2:doc></ns2:representation><ns2:representation
element="issuesUnresolvedCount" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"self":"http://www.example.com/jira/rest/api/2/version/10000","issuesUnresolvedCount":23}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the version exists and the currently authenticated user has permission to view it. Contains
counts of issues unresolved in this version.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="/{id}/move"><ns2:param name="id"
style="template" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[a String containing the version id]]></ns2:doc></ns2:param><ns2:method
id="moveVersion"
name="POST"><ns2:doc><![CDATA[Modify a version's sequence within a project.
The move version bean has 2 alternative field value pairs:
<dl>
<dt>position</dt><dd>An absolute position, which may have a value of 'First', 'Last', 'Earlier' or 'Later'</dd>
<dt>after</dt><dd>A version to place this version after. The value should be the self link of another version</dd>
</dl>]]></ns2:doc><ns2:request><ns2:representation
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"after":"http://www.example.com/jira/rest/api/2/version/10000"}</ns3:code></ns3:pre></ns3:p></ns2:doc></ns2:representation></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the version, or target of the version to move after does not exist or the currently authenticated
user does not have permission to view it.]]></ns2:doc></ns2:representation><ns2:representation
element="version" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"self":"http://www.example.com/jira/rest/api/2/version/10000","id":"10000","description":"An excellent version","name":"New Version 1","archived":false,"released":true,"releaseDate":"2010-07-06","overdue":true,"userReleaseDate":"6/Jul/2010","projectId":10000}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the version exists and the currently authenticated user has permission to view it. Contains a
full representation of the version moved.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="remotelink"><ns2:method
id="getRemoteVersionLinks"
name="GET"><ns2:doc><![CDATA[Returns the remote version links for a given global ID.]]></ns2:doc><ns2:request><ns2:param
name="globalId" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the global ID of the remote resource that is linked to the versions]]></ns2:doc></ns2:param></ns2:request><ns2:response><ns2:representation
element="remoteVersionLinks" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"links":[{"self":"http://www.example.com/version/10000/SomeGlobalId","name":"Version 1","link":{ "globalId": "SomeGlobalId", "myCustomLinkProperty": true, "colors": [ "red", "green", "blue" ]}},{"self":"http://www.example.com/version/10101/SomeGlobalId","name":"Version 2","link":{ "globalId": "SomeGlobalId" }}]}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Contains a list of remote version links. Any existing links that the user does not
have permission to see will be filtered out. The user must have BROWSE permission
for the project to see links to its versions.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{versionId}/remotelink"><ns2:param
name="versionId" style="template" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[The version for which to delete ALL existing remote version links]]></ns2:doc></ns2:param><ns2:method
id="getRemoteVersionLinksByVersionId"
name="GET"><ns2:doc><![CDATA[Returns the remote version links associated with the given version ID.]]></ns2:doc><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the version does not exist or the currently authenticated user does not have permission to
view it.]]></ns2:doc></ns2:representation><ns2:representation
element="remoteVersionLinks" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"links":[{"self":"http://www.example.com/version/10000/AnotherGlobalId","name":"Version 1","link":{ "globalId": "AnotherGlobalId", "myCustomLinkProperty": false, "colors": [ "cyan", "magenta", "yellow" ]}},{"self":"http://www.example.com/version/10000/SomeGlobalId","name":"Version 1","link":{ "globalId": "SomeGlobalId", "myCustomLinkProperty": true, "colors": [ "red", "green", "blue" ]}}]}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the version exists and the currently authenticated user has permission to view it, which
is restricted to those users with BROWSE permission for the project. Contains a full representation
of the remote version links.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="createOrUpdateRemoteVersionLink"
name="POST"><ns2:doc><![CDATA[Create a remote version link via POST. The link's global ID will be taken from the
JSON payload if provided; otherwise, it will be generated.]]></ns2:doc><ns2:request><ns2:representation
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"globalId":"SomeGlobalId","myCustomLinkProperty":true,"colors":["red","green","blue"],"notes":["Remote version links may take any well-formed JSON shape that is desired,","provided that they fit within the maximum buffer size allowed,","which is currently 32,768 characters."]}</ns3:code></ns3:pre></ns3:p></ns2:doc></ns2:representation></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the version does not exist or the currently authenticated user does not have permission to
view it.]]></ns2:doc></ns2:representation><ns2:representation
status="201"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>Returned if the remote version link is created or updated successfully.
The document has no content, and a </ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the version is created successfully. The document will has no content,
and a {@code Location:} header contains the self-URI for the newly created link.]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if the JSON payload is empty or malformed]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have permission to edit the version.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="deleteRemoteVersionLinksByVersionId"
name="DELETE"><ns2:doc><![CDATA[Delete all remote version links for a given version ID.]]></ns2:doc><ns2:response><ns2:representation
status="204"><ns2:doc><![CDATA[Returned if the remote version links are successfully deleted.]]></ns2:doc></ns2:representation><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the version does not exist, the currently authenticated user does not have permission to
view it, or the version does not have any remote links to delete]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have administrative rights to the project
and thereby cannot delete remote links to the version.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{versionId}/remotelink/{globalId}"><ns2:param
name="versionId" style="template" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[The version ID of the remote link]]></ns2:doc></ns2:param><ns2:param
name="globalId" style="template" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[The global ID of the remote link]]></ns2:doc></ns2:param><ns2:method
id="getRemoteVersionLink"
name="GET"><ns2:doc><![CDATA[A REST sub-resource representing a remote version link]]></ns2:doc><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the version or remote version link does not exist or if the user does not have
the BROWSE permission for the project that owns the specified version]]></ns2:doc></ns2:representation><ns2:representation
status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"self":"http://www.example.com/version/10000/SomeGlobalId","name":"Version 1","link":{ "globalId": "SomeGlobalId", "myCustomLinkProperty": true, "colors": [ "red", "green", "blue" ]}}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Information on the remote version link (or links)]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="createOrUpdateRemoteVersionLink"
name="POST"><ns2:doc><![CDATA[Create a remote version link via POST. The link's global ID will be taken from the
JSON payload if provided; otherwise, it will be generated.]]></ns2:doc><ns2:request><ns2:representation
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"globalId":"SomeGlobalId","myCustomLinkProperty":true,"colors":["red","green","blue"],"notes":["Remote version links may take any well-formed JSON shape that is desired,","provided that they fit within the maximum buffer size allowed,","which is currently 32,768 characters."]}</ns3:code></ns3:pre></ns3:p></ns2:doc></ns2:representation></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the version does not exist or the currently authenticated user does not have permission to
view it.]]></ns2:doc></ns2:representation><ns2:representation
status="201"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>Returned if the remote version link is created or updated successfully.
The document has no content, and a </ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the version is created successfully. The document will has no content,
and a {@code Location:} header contains the self-URI for the newly created link.]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if the JSON payload is empty or malformed]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have permission to edit the version.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="deleteRemoteVersionLink"
name="DELETE"><ns2:doc><![CDATA[Delete a specific remote version link with the given version ID and global ID.]]></ns2:doc><ns2:response><ns2:representation
status="204"><ns2:doc><![CDATA[Returned if the remote version link is successfully deleted.]]></ns2:doc></ns2:representation><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the version does not exist, the currently authenticated user does not have permission to
view it, or the version does not have a link for the given global ID]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have administrative rights to the project
and thereby cannot delete remote links to the version.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource></ns2:resource><ns2:resource
path="api/2/user"><ns2:method id="getUser"
name="GET"><ns2:doc><![CDATA[Returns a user. This resource cannot be accessed anonymously.]]></ns2:doc><ns2:request><ns2:param
name="username" style="query" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the username]]></ns2:doc></ns2:param><ns2:param
name="key" style="query" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[user key]]></ns2:doc></ns2:param></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the requested user is not found.]]></ns2:doc></ns2:representation><ns2:representation
element="user" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","emailAddress":"[email protected]","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":true,"timeZone":"Australia/Sydney","groups":{"size":3,"items":[{"name":"jira-user","self":"http://www.example.com/jira/rest/api/2/group?groupname=jira-user"},{"name":"jira-admin","self":"http://www.example.com/jira/rest/api/2/group?groupname=jira-admin"},{"name":"important","self":"http://www.example.com/jira/rest/api/2/group?groupname=important"}]},"expand":"groups"}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returns a full representation of a JIRA user in JSON format.]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if the current user is not authenticated.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="updateUser"
name="PUT"><ns2:doc><![CDATA[Modify user. The "value" fields present will override the existing value.
Fields skipped in request will not be changed.]]></ns2:doc><ns2:request><ns2:param
name="username" style="query" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the username]]></ns2:doc></ns2:param><ns2:param
name="key" style="query" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[user key]]></ns2:doc></ns2:param><ns2:representation
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"name":"eddie","emailAddress":"[email protected]","displayName":"Eddie of Atlassian"}</ns3:code></ns3:pre></ns3:p></ns2:doc></ns2:representation></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the caller does have permission to edit the user but the user does not exist.]]></ns2:doc></ns2:representation><ns2:representation
element="user" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"self":"http://www.example.com/jirahttp://www.example.com/jira/rest/api/2/user/charlie","key":"charlie","name":"charlie","emailAddress":"[email protected]","displayName":"Charlie of Atlassian"}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the user exists and the caller has permission to edit it.]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if the request is invalid.]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the caller user does not have permission to edit the user.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="createUser"
name="POST"><ns2:doc><![CDATA[Create user. By default created user will not be notified with email.
If password field is not set then password will be randomly generated.]]></ns2:doc><ns2:request><ns2:representation
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"name":"charlie","password":"abracadabra","emailAddress":"[email protected]","displayName":"Charlie of Atlassian"}</ns3:code></ns3:pre></ns3:p></ns2:doc></ns2:representation></ns2:request><ns2:response><ns2:representation
status="201"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"self":"http://www.example.com/jirahttp://www.example.com/jira/rest/api/2/user/charlie","key":"charlie","name":"charlie","emailAddress":"[email protected]","displayName":"Charlie of Atlassian"}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returned if the user was created.]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if the request is invalid.]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the caller user does not have permission to create the user.]]></ns2:doc></ns2:representation><ns2:representation
status="500"><ns2:doc><![CDATA[Returned if the user was not created because of other error.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="removeUser"
name="DELETE"><ns2:doc><![CDATA[Removes user.]]></ns2:doc><ns2:request><ns2:param
name="username" style="query" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the username]]></ns2:doc></ns2:param><ns2:param
name="key" style="query" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[user key]]></ns2:doc></ns2:param></ns2:request><ns2:response><ns2:representation
status="204"><ns2:doc><![CDATA[Returned if the user was deleted successfully.]]></ns2:doc></ns2:representation><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the caller does have permission to remove user but the user does not exist.]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if the request is invalid or some other server error occurred.]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the caller does not have permission to remove the user.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:resource
path="avatar/temporary"><ns2:method
id="storeTemporaryAvatar"
name="POST"><ns2:doc><![CDATA[Creates temporary avatar. Creating a temporary avatar is part of a 3-step process in uploading a new
avatar for a user: upload, crop, confirm.
<p>
The following examples shows these three steps using curl.
The cookies (session) need to be preserved between requests, hence the use of -b and -c.
The id created in step 2 needs to be passed to step 3
(you can simply pass the whole response of step 2 as the request of step 3).
</p>
<pre>
curl -c cookiejar.txt -X POST -u admin:admin -H "X-Atlassian-Token: no-check" \
-H "Content-Type: image/png" --data-binary @mynewavatar.png \
'http://localhost:8090/jira/rest/api/2/user/avatar/temporary?username=admin&filename=mynewavatar.png'
curl -b cookiejar.txt -X POST -u admin:admin -H "X-Atlassian-Token: no-check" \
-H "Content-Type: application/json" --data '{"cropperWidth": "65","cropperOffsetX": "10","cropperOffsetY": "16"}' \
-o tmpid.json \
http://localhost:8090/jira/rest/api/2/user/avatar?username=admin
curl -b cookiejar.txt -X PUT -u admin:admin -H "X-Atlassian-Token: no-check" \
-H "Content-Type: application/json" --data-binary @tmpid.json \
http://localhost:8090/jira/rest/api/2/user/avatar?username=admin
</pre>]]></ns2:doc><ns2:request><ns2:param
name="username" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[username]]></ns2:doc></ns2:param><ns2:param
name="filename" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[name of file being uploaded]]></ns2:doc></ns2:param><ns2:param
name="size" style="query" type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[size of file]]></ns2:doc></ns2:param></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have EDIT PROJECT permission.]]></ns2:doc></ns2:representation><ns2:representation
element="avatar" status="201"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"url":"http://example.com/jira/secure/temporaryavatar?cropped=true","needsCropping":true}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[temporary avatar cropping instructions]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the request does not conain a valid XSRF token]]></ns2:doc></ns2:representation><ns2:representation
status="500"><ns2:doc><![CDATA[Returned if an error occurs while converting temporary avatar to real avatar]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="storeTemporaryAvatarUsingMultiPart"
name="POST"><ns2:doc><![CDATA[Creates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because
the client uses remote iframing to submit avatars using multipart. So we must send them a valid HTML page back from
which the client parses the JSON from.
<p>
Creating a temporary avatar is part of a 3-step process in uploading a new
avatar for a user: upload, crop, confirm. This endpoint allows you to use a multipart upload
instead of sending the image directly as the request body.
</p>
<p>You *must* use "avatar" as the name of the upload parameter:</p>
<pre>
curl -c cookiejar.txt -X POST -u admin:admin -H "X-Atlassian-Token: no-check" \
-F "[email protected];type=image/png" \
'http://localhost:8090/jira/rest/api/2/user/avatar/temporary?username=admin'
</pre>]]></ns2:doc><ns2:request><ns2:param
name="username" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[Username]]></ns2:doc></ns2:param></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if user does NOT exist]]></ns2:doc></ns2:representation><ns2:representation
element="avatar" status="201"
mediaType="text/html"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"url":"http://example.com/jira/secure/temporaryavatar?cropped=true","needsCropping":true}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[temporary avatar cropping instructions embeded in HTML page. Error messages will also be embeded in the page.]]></ns2:doc></ns2:representation><ns2:representation
status="500"><ns2:doc><![CDATA[Returned if an error occurs while converting temporary avatar to real avatar]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="avatar"><ns2:method
id="createAvatarFromTemporary"
name="POST"><ns2:doc><![CDATA[Converts temporary avatar into a real avatar]]></ns2:doc><ns2:request><ns2:param
name="username" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[username]]></ns2:doc></ns2:param><ns2:representation
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"needsCropping":false}</ns3:code></ns3:pre></ns3:p></ns2:doc></ns2:representation></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have EDIT PROJECT permission.]]></ns2:doc></ns2:representation><ns2:representation
element="avatar" status="201"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"id":"1000","owner":"fred","isSystemAvatar":true,"isSelected":true,"selected":true}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returns created avatar]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if the cropping coordinates are invalid]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have permission to pick avatar]]></ns2:doc></ns2:representation><ns2:representation
status="500"><ns2:doc><![CDATA[Returned if an error occurs while converting temporary avatar to real avatar]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="updateProjectAvatar"
name="PUT"><ns2:request><ns2:param
name="username" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"/><ns2:representation
mediaType="application/json"/></ns2:request><ns2:response><ns2:representation
mediaType="application/json"/></ns2:response></ns2:method></ns2:resource><ns2:resource
path="avatars"><ns2:method id="getAllAvatars"
name="GET"><ns2:doc><![CDATA[Returns all avatars which are visible for the currently logged in user.]]></ns2:doc><ns2:request><ns2:param
name="username" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[username]]></ns2:doc></ns2:param></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the requested user is not found.]]></ns2:doc></ns2:representation><ns2:representation
element="avatars" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"system":[{"id":"1000","owner":"fred","isSystemAvatar":true,"isSelected":true,"selected":true}],"custom":[{"id":"1010","owner":"andrew","isSystemAvatar":false,"isSelected":false,"selected":false}]}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returns a map containing a list of avatars for both custom an system avatars]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if the current user is not authenticated.]]></ns2:doc></ns2:representation><ns2:representation
status="500"><ns2:doc><![CDATA[Returned if an error occurs while retrieving the list of avatars.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="avatar/{id}"><ns2:param name="id"
style="template" type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[database id for avatar]]></ns2:doc></ns2:param><ns2:method
id="deleteAvatar"
name="DELETE"><ns2:doc><![CDATA[Deletes avatar]]></ns2:doc><ns2:request><ns2:param
name="username" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[username]]></ns2:doc></ns2:param></ns2:request><ns2:response><ns2:representation
status="204"
mediaType="application/json"><ns2:doc><![CDATA[Returned if the avatar is successfully deleted.]]></ns2:doc></ns2:representation><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the avatar does not exist or the currently authenticated user does not have permission to
delete it.]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have permission to delete the avatar.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="search"><ns2:method id="findUsers"
name="GET"><ns2:doc><![CDATA[Returns a list of users that match the search string. This resource cannot be accessed anonymously.]]></ns2:doc><ns2:request><ns2:param
name="username" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[A query string used to search username, name or e-mail address]]></ns2:doc></ns2:param><ns2:param
name="startAt" style="query" type="xs:int"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the index of the first user to return (0-based)]]></ns2:doc></ns2:param><ns2:param
name="maxResults" style="query"
type="xs:int"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the maximum number of users to return (defaults to 50). The maximum allowed value is 1000.
If you specify a value that is higher than this number, your search results will be truncated.]]></ns2:doc></ns2:param><ns2:param
name="includeActive" style="query"
type="xs:boolean"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[If true, then active users are included in the results (default true)]]></ns2:doc></ns2:param><ns2:param
name="includeInactive" style="query"
type="xs:boolean"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[If true, then inactive users are included in the results (default false)]]></ns2:doc></ns2:param></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the requested user is not found.]]></ns2:doc></ns2:representation><ns2:representation
element="List of users" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>[{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},{"self":"http://www.example.com/jira/rest/api/2/user?username=andrew","name":"andrew","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=andrew","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=andrew","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=andrew","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=andrew"},"displayName":"Andrew Anderson","active":false}]</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returns a full representation of a JIRA user in JSON format.]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if the current user is not authenticated.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="picker"><ns2:method id="findUsersForPicker"
name="GET"><ns2:doc><![CDATA[Returns a list of users matching query with highlighting. This resource cannot be accessed anonymously.]]></ns2:doc><ns2:request><ns2:param
name="query" style="query" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[A string used to search username, Name or e-mail address]]></ns2:doc></ns2:param><ns2:param
name="maxResults" style="query"
type="xs:int"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the maximum number of users to return (defaults to 50). The maximum allowed value is 1000.
If you specify a value that is higher than this number, your search results will be truncated.]]></ns2:doc></ns2:param><ns2:param
name="showAvatar" style="query"
type="xs:boolean"
xmlns:xs="http://www.w3.org/2001/XMLSchema"/><ns2:param
name="exclude" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"/></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the requested user is not found.]]></ns2:doc></ns2:representation><ns2:representation
element="List of users" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"users":[{"name":"fred","key":"fred","html":"[email protected]","displayName":"Fred Grumble","avatarUrl":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred"}],"total":25,"header":"Showing 20 of 25 matching groups"}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returns a full representation of a JIRA user in JSON format.]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if the current user is not authenticated.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="assignable/search"><ns2:method
id="findAssignableUsers"
name="GET"><ns2:doc><![CDATA[Returns a list of users that match the search string. This resource cannot be accessed anonymously.
Please note that this resource should be called with an issue key when a list of assignable users is retrieved
for editing. For create only a project key should be supplied. The list of assignable users may be incorrect
if it's called with the project key for editing.]]></ns2:doc><ns2:request><ns2:param
name="username" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the username]]></ns2:doc></ns2:param><ns2:param
name="project" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the key of the project we are finding assignable users for]]></ns2:doc></ns2:param><ns2:param
name="issueKey" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the issue key for the issue being edited we need to find assignable users for.]]></ns2:doc></ns2:param><ns2:param
name="startAt" style="query" type="xs:int"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the index of the first user to return (0-based)]]></ns2:doc></ns2:param><ns2:param
name="maxResults" style="query"
type="xs:int"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the maximum number of users to return (defaults to 50). The maximum allowed value is 1000.
If you specify a value that is higher than this number, your search results will be truncated.]]></ns2:doc></ns2:param><ns2:param
name="actionDescriptorId" style="query"
type="xs:int"
xmlns:xs="http://www.w3.org/2001/XMLSchema"/></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the requested user is not found.]]></ns2:doc></ns2:representation><ns2:representation
element="user" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","emailAddress":"[email protected]","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":true,"timeZone":"Australia/Sydney","groups":{"size":3,"items":[{"name":"jira-user","self":"http://www.example.com/jira/rest/api/2/group?groupname=jira-user"},{"name":"jira-admin","self":"http://www.example.com/jira/rest/api/2/group?groupname=jira-admin"},{"name":"important","self":"http://www.example.com/jira/rest/api/2/group?groupname=important"}]},"expand":"groups"}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returns a full representation of a JIRA user in JSON format.]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if the current user is not authenticated.]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if no project or issue key was provided]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="password"><ns2:method id="changeUserPassword"
name="PUT"><ns2:doc><![CDATA[Modify user password.]]></ns2:doc><ns2:request><ns2:param
name="username" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the username]]></ns2:doc></ns2:param><ns2:param
name="key" style="query" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[user key]]></ns2:doc></ns2:param><ns2:representation
mediaType="application/json"/></ns2:request><ns2:response><ns2:representation
status="204"><ns2:doc><![CDATA[Returned if the user exists and the caller has permission to edit it.]]></ns2:doc></ns2:representation><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the caller does have permission to change user password but the user does not exist.]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the caller does not have permission to change the user password.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="viewissue/search"><ns2:method
id="findUsersWithBrowsePermission"
name="GET"><ns2:doc><![CDATA[Returns a list of active users that match the search string. This resource cannot be accessed anonymously.
Given an issue key this resource will provide a list of users that match the search string and have
the browse issue permission for the issue provided.]]></ns2:doc><ns2:request><ns2:param
name="username" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the username filter, no users returned if left blank]]></ns2:doc></ns2:param><ns2:param
name="issueKey" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the issue key for the issue being edited we need to find viewable users for.]]></ns2:doc></ns2:param><ns2:param
name="projectKey" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the optional project key to search for users with if no issueKey is supplied.]]></ns2:doc></ns2:param><ns2:param
name="startAt" style="query" type="xs:int"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the index of the first user to return (0-based)]]></ns2:doc></ns2:param><ns2:param
name="maxResults" style="query"
type="xs:int"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the maximum number of users to return (defaults to 50). The maximum allowed value is 1000.
If you specify a value that is higher than this number, your search results will be truncated.]]></ns2:doc></ns2:param></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the requested issue or project is not found.]]></ns2:doc></ns2:representation><ns2:representation
element="List of users" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>[{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},{"self":"http://www.example.com/jira/rest/api/2/user?username=andrew","name":"andrew","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=andrew","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=andrew","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=andrew","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=andrew"},"displayName":"Andrew Anderson","active":false}]</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returns a full representation of a JIRA user in JSON format.]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if the current user is not authenticated.]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if no project or issue key was provided]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="permission/search"><ns2:method
id="findUsersWithAllPermissions"
name="GET"><ns2:doc><![CDATA[Returns a list of active users that match the search string and have all specified permissions for the project or issue.<br>
This resource can be accessed by users with ADMINISTER_PROJECT permission for the project or global ADMIN or SYSADMIN rights.]]></ns2:doc><ns2:request><ns2:param
name="username" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the username filter, list includes all users if unspecified]]></ns2:doc></ns2:param><ns2:param
name="permissions" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[comma separated list of permissions for project or issue returned users must have, see
<a href="https://developer.atlassian.com/static/javadoc/jira/6.0/reference/com/atlassian/jira/security/Permissions.Permission.html">Permissions</a>
JavaDoc for the list of all possible permissions.]]></ns2:doc></ns2:param><ns2:param
name="issueKey" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the issue key for the issue for which returned users have specified permissions.]]></ns2:doc></ns2:param><ns2:param
name="projectKey" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the optional project key to search for users with if no issueKey is supplied.]]></ns2:doc></ns2:param><ns2:param
name="startAt" style="query" type="xs:int"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the index of the first user to return (0-based)]]></ns2:doc></ns2:param><ns2:param
name="maxResults" style="query"
type="xs:int"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the maximum number of users to return (defaults to 50). The maximum allowed value is 1000.
If you specify a value that is higher than this number, your search results will be truncated.]]></ns2:doc></ns2:param></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the requested issue or project is not found.]]></ns2:doc></ns2:representation><ns2:representation
element="List of users" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>[{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},{"self":"http://www.example.com/jira/rest/api/2/user?username=andrew","name":"andrew","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=andrew","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=andrew","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=andrew","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=andrew"},"displayName":"Andrew Anderson","active":false}]</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returns a full representation of a JIRA user in JSON format.]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if the current user is not authenticated.]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if no project or issue key was provided or when permissions list is empty or contains an invalid entry]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the current user does not have admin rights for the project.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="assignable/multiProjectSearch"><ns2:method
id="findBulkAssignableUsers"
name="GET"><ns2:doc><![CDATA[Returns a list of users that match the search string and can be assigned issues for all the given projects.
This resource cannot be accessed anonymously.]]></ns2:doc><ns2:request><ns2:param
name="username" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the username]]></ns2:doc></ns2:param><ns2:param
name="projectKeys" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the keys of the projects we are finding assignable users for, comma-separated]]></ns2:doc></ns2:param><ns2:param
name="startAt" style="query" type="xs:int"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the index of the first user to return (0-based)]]></ns2:doc></ns2:param><ns2:param
name="maxResults" style="query"
type="xs:int"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the maximum number of users to return (defaults to 50). The maximum allowed value is 1000.
If you specify a value that is higher than this number, your search results will be truncated.]]></ns2:doc></ns2:param></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the requested user is not found.]]></ns2:doc></ns2:representation><ns2:representation
element="user" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>[{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},{"self":"http://www.example.com/jira/rest/api/2/user?username=andrew","name":"andrew","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=andrew","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=andrew","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=andrew","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=andrew"},"displayName":"Andrew Anderson","active":false}]</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returns a full representation of a JIRA user in JSON format.]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if the current user is not authenticated.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="columns"><ns2:method id="defaultColumns"
name="GET"><ns2:doc><![CDATA[Returns the default columns for the given user. Admin permission will be required to get columns for a user
other than the currently logged in user.]]></ns2:doc><ns2:request><ns2:param
name="username" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[username]]></ns2:doc></ns2:param></ns2:request><ns2:response><ns2:representation
status="404"><ns2:doc><![CDATA[Returned if the requested user is not found.]]></ns2:doc></ns2:representation><ns2:representation
element="columns" status="200"
mediaType="application/json"><ns2:doc><![CDATA[Returns a list of columns for configured for the given user]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if the current user is not permitted to request the columns for the given user.]]></ns2:doc></ns2:representation><ns2:representation
status="500"><ns2:doc><![CDATA[Returned if an error occurs while retrieving the column configuration.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="setColumns"
name="PUT"><ns2:doc><![CDATA[Sets the default columns for the given user. Admin permission will be required to get columns for a user
other than the currently logged in user.]]></ns2:doc><ns2:request><ns2:representation
mediaType="application/x-www-form-urlencoded"><ns2:param
name="username" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[username]]></ns2:doc></ns2:param><ns2:param
name="columns" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[list of column ids]]></ns2:doc></ns2:param></ns2:representation></ns2:request><ns2:response><ns2:representation
status="200"><ns2:doc><![CDATA[Returned when the columns is saved successfully]]></ns2:doc></ns2:representation><ns2:representation
status="500"><ns2:doc><![CDATA[Returned if an error occurs while retrieving the column configuration.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="resetColumns"
name="DELETE"><ns2:doc><![CDATA[Reset the default columns for the given user to the system default. Admin permission will be required to get
columns for a user other than the currently logged in user.]]></ns2:doc><ns2:request><ns2:param
name="username" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[username]]></ns2:doc></ns2:param></ns2:request><ns2:response><ns2:representation
status="204"><ns2:doc><![CDATA[Returned when the columns are reset successfully]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if the current user is not permitted to request the columns for the given user.]]></ns2:doc></ns2:representation><ns2:representation
status="500"><ns2:doc><![CDATA[Returned if an error occurs while resetting the column configuration.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource></ns2:resource><ns2:resource
path="api/2/serverInfo"><ns2:method id="getServerInfo"
name="GET"><ns2:doc><![CDATA[Returns general information about the current JIRA server.]]></ns2:doc><ns2:request><ns2:param
name="doHealthCheck" style="query"
type="xs:boolean"
xmlns:xs="http://www.w3.org/2001/XMLSchema"/></ns2:request><ns2:response><ns2:representation
element="serverInfo" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"baseUrl":"http://localhost:8080/jira","version":"5.0-SNAPSHOT","versionNumbers":[5,0,0],"buildNumber":582,"buildDate":"2014-01-28T14:28:59.248+0100","serverTime":"2014-01-28T14:28:59.248+0100","scmInfo":"1f51473f5c7b75c1a69a0090f4832cdc5053702a","buildPartnerName":"Example Partner Co.","serverTitle":"My Shiny New JIRA Server"}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returns a full representation of the server info in JSON format]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="api/2/screens"><ns2:resource
path="{screenId}/tabs"><ns2:param name="screenId"
style="template" type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[id of screen]]></ns2:doc></ns2:param><ns2:method
id="addTab"
name="POST"><ns2:doc><![CDATA[Creates tab for given screen]]></ns2:doc><ns2:request><ns2:representation
mediaType="application/json"/></ns2:request><ns2:response><ns2:representation
element="Newly created tab" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"id":10000,"name":"Fields Tab"}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Newly created tab in JSON.]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if you do not have permissions]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if screen does not exist or tab name is invalid]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="getAllTabs"
name="GET"><ns2:doc><![CDATA[Returns a list of all tabs for the given screen]]></ns2:doc><ns2:response><ns2:representation
element="List of tabs" status="200"
mediaType="application/json"><ns2:doc><![CDATA[Contains a full representation of all visible tabs in JSON.]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if you do not have permissions]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if screen does not exist]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{screenId}/tabs/{tabId}/fields"><ns2:param
name="screenId" style="template" type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[id of screen]]></ns2:doc></ns2:param><ns2:param
name="tabId" style="template" type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[id of tab]]></ns2:doc></ns2:param><ns2:method
id="addField"
name="POST"><ns2:doc><![CDATA[Adds field to the given tab]]></ns2:doc><ns2:request><ns2:representation
mediaType="application/json"/></ns2:request><ns2:response><ns2:representation
status="200"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"id":"summary","name":"Summary"}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Newly added field as json]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if you do not have permissions]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if screen,tab or field does not exist.]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="getAllFields"
name="GET"><ns2:doc><![CDATA[Gets all fields for a given tab]]></ns2:doc><ns2:response><ns2:representation
status="200"><ns2:doc><![CDATA[List of fields for given tab]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if you do not have permissions]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if screen or tab does not exist]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{screenId}/tabs/{tabId}/fields/{id}"><ns2:param
name="id" style="template" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"/><ns2:param
name="screenId" style="template" type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[id of screen]]></ns2:doc></ns2:param><ns2:param
name="tabId" style="template" type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[id of tab]]></ns2:doc></ns2:param><ns2:method
id="removeField"
name="DELETE"><ns2:doc><![CDATA[Removes field from given tab]]></ns2:doc><ns2:response><ns2:representation
status="201"><ns2:doc><![CDATA[Successfully removed field from tab]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if you do not have permissions]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if screen or tab does not exist]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{screenId}/tabs/{tabId}"><ns2:param
name="screenId" style="template" type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[id of screen]]></ns2:doc></ns2:param><ns2:param
name="tabId" style="template" type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[id of tab]]></ns2:doc></ns2:param><ns2:method
id="renameTab"
name="PUT"><ns2:doc><![CDATA[Renames tab on given screen]]></ns2:doc><ns2:request><ns2:representation
mediaType="application/json"/></ns2:request><ns2:response><ns2:representation
element="Modified tab" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"id":10000,"name":"Fields Tab"}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Modified tab in JSON.]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if you do not have permissions]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if screen does not exist or tab name is invalid]]></ns2:doc></ns2:representation></ns2:response></ns2:method><ns2:method
id="deleteTab"
name="DELETE"><ns2:doc><![CDATA[Deletes tab to give screen]]></ns2:doc><ns2:response><ns2:representation
status="201"><ns2:doc><![CDATA[Successfully deleted tab]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if you do not have permissions]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if screen or tab does not exist]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{screenId}/tabs/{tabId}/move/{pos}"><ns2:param
name="screenId" style="template" type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[id of screen]]></ns2:doc></ns2:param><ns2:param
name="tabId" style="template" type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[id of tab]]></ns2:doc></ns2:param><ns2:param
name="pos" style="template" type="xs:int"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[position of tab]]></ns2:doc></ns2:param><ns2:method
id="moveTab"
name="POST"><ns2:doc><![CDATA[Moves tab position]]></ns2:doc><ns2:response><ns2:representation
status="201"><ns2:doc><![CDATA[Successfully moved tab]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if you do not have permissions]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if screen or tab does not exist]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{screenId}/availableFields"><ns2:param
name="screenId" style="template" type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[id of screen]]></ns2:doc></ns2:param><ns2:method
id="getFieldsToAdd"
name="GET"><ns2:doc><![CDATA[Gets available fields for screen. i.e ones that haven't already been added.]]></ns2:doc><ns2:response><ns2:representation
status="200"><ns2:doc><![CDATA[List of available fields for screen]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if you do not have permissions]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if screen does not exist]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{screenId}/tabs/{tabId}/fields/{id}/move"><ns2:param
name="id" style="template" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"/><ns2:param
name="screenId" style="template" type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[id of screen]]></ns2:doc></ns2:param><ns2:param
name="tabId" style="template" type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[id of tab]]></ns2:doc></ns2:param><ns2:method
id="moveField"
name="POST"><ns2:doc><![CDATA[Moves field on the given tab]]></ns2:doc><ns2:request><ns2:representation
mediaType="application/json"/></ns2:request><ns2:response><ns2:representation
status="201"><ns2:doc><![CDATA[Successfully moved tab]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if you do not have permissions]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if screen or tab does not exist. Or move cooridinates invalid.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="addToDefault/{fieldId}"><ns2:param
name="fieldId" style="template" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[id of field / custom field]]></ns2:doc></ns2:param><ns2:method
id="addFieldToDefaultScreen"
name="POST"><ns2:doc><![CDATA[Adds field or custom field to the default tab]]></ns2:doc><ns2:response><ns2:representation
status="201"/><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if you do not have administrator permissions]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if screen, tab or field does not exist or field is already present on a selected tab]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource></ns2:resource><ns2:resource
path="api/2/workflow"><ns2:doc><![CDATA[REST resource for retrieving workflows.]]></ns2:doc><ns2:method
id="getAllWorkflows"
name="GET"><ns2:doc><![CDATA[Returns all workflows.]]></ns2:doc><ns2:request><ns2:param
name="workflowName" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"/></ns2:request><ns2:response><ns2:representation
status="200"
mediaType="application/json"><ns2:doc><![CDATA[Returned if the currently authenticated user has administration permission. Contains a
full representation of every workflow.]]></ns2:doc></ns2:representation><ns2:representation
status="401"><ns2:doc><![CDATA[Returned if the currently authenticated user does not have administration permission.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="api/2/avatar"><ns2:resource
path="{type}/system"><ns2:param name="type"
style="template" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the avatar type]]></ns2:doc></ns2:param><ns2:method
id="getAllSystemAvatars"
name="GET"><ns2:doc><![CDATA[Returns all system avatars of the given type.]]></ns2:doc><ns2:response><ns2:representation
element="avatars" status="200"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"system":[{"id":"1000","owner":"fred","isSystemAvatar":true,"isSelected":true,"selected":true}]}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[Returns a map containing a list of system avatars. A map is returned to be consistent with the shape of the
project/KEY/avatars REST end point.]]></ns2:doc></ns2:representation><ns2:representation
status="500"><ns2:doc><![CDATA[Returned if an error occurs while retrieving the list of avatars.]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{type}/temporary"><ns2:param name="type"
style="template" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the avatar type]]></ns2:doc></ns2:param><ns2:method
id="storeTemporaryAvatar"
name="POST"><ns2:doc><![CDATA[Creates temporary avatar]]></ns2:doc><ns2:request><ns2:param
name="filename" style="query"
type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[name of file being uploaded]]></ns2:doc></ns2:param><ns2:param
name="size" style="query" type="xs:long"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[size of file]]></ns2:doc></ns2:param></ns2:request><ns2:response><ns2:representation
element="avatar" status="201"
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"url":"http://example.com/jira/secure/temporaryavatar?cropped=true","needsCropping":true}</ns3:code></ns3:pre></ns3:p></ns2:doc><ns2:doc><![CDATA[temporary avatar cropping instructions]]></ns2:doc></ns2:representation><ns2:representation
status="400"><ns2:doc><![CDATA[Valiation failed. For example filesize is beyond max attachment size.]]></ns2:doc></ns2:representation><ns2:representation
status="403"><ns2:doc><![CDATA[Returned if the request does not conain a valid XSRF token]]></ns2:doc></ns2:representation><ns2:representation
status="500"><ns2:doc><![CDATA[Returned if an error occurs while converting temporary avatar to real avatar]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource><ns2:resource
path="{type}/temporaryCrop"><ns2:param name="type"
style="template" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[the avatar type]]></ns2:doc></ns2:param><ns2:method
id="createAvatarFromTemporary"
name="POST"><ns2:doc><![CDATA[Updates the cropping instructions of the temporary avatar.]]></ns2:doc><ns2:request><ns2:representation
mediaType="application/json"><ns2:doc><ns3:p
xmlns:ns3="http://www.w3.org/1999/xhtml"><ns3:h6>Example</ns3:h6><ns3:pre><ns3:code>{"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"needsCropping":false}</ns3:code></ns3:pre></ns3:p></ns2:doc></ns2:representation></ns2:request><ns2:response><ns2:representation
element="avatar" status="201"
mediaType="application/json"/><ns2:representation
status="400"><ns2:doc><![CDATA[Returned if the cropping coordinates are invalid]]></ns2:doc></ns2:representation><ns2:representation
status="500"><ns2:doc><![CDATA[Returned if an error occurs while cropping the temporary avatar]]></ns2:doc></ns2:representation></ns2:response></ns2:method></ns2:resource></ns2:resource><ns2:resource
path="api/2/dashboard"><ns2:doc><![CDATA[The <code>/dashboard</code> resource.]]></ns2:doc><ns2:method
id="list"
name="GET"><ns2:doc><![CDATA[Returns a list of all dashboards, optionally filtering them.]]></ns2:doc><ns2:request><ns2:param
name="filter" style="query" type="xs:string"
xmlns:xs="http://www.w3.org/2001/XMLSchema"><ns2:doc><![CDATA[an optional filter that is applied to the list of dashboards. Valid values include