-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathxray_v2.0.json
More file actions
6017 lines (6017 loc) · 240 KB
/
Copy pathxray_v2.0.json
File metadata and controls
6017 lines (6017 loc) · 240 KB
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
{
"openapi": "3.0.3",
"info": {
"title": "Xray_REST_API_v2.0",
"version": "1.0.0",
"description": "This OpenAPI specification describes the Xray REST API v2.0 for Xray Server and Data Center (DC).",
"contact": {}
},
"servers": [
{
"url": "https://your-jira-instance.example.com/rest/raven/2.0/api"
}
],
"paths": {
"/test/{testKey}/steps": {
"get": {
"tags": [
"test step"
],
"summary": "List test steps",
"description": "Returns all the steps of a test issue given the key. The response contains for each step the corresponding id, index, fields and the attachments. \n\nThe Test Step fields are identified by their name and can be of type _Data_ (Toggle, Number, Date and Date Time fields), _Option_ (Single Select, Multiple Select and Radio Button fields), _Wiki_ (Native fields, Single and Multiple Line fields). \n\nThe value of step fields of type _Wiki_ have a raw and rendered value. _Option_ fields value will be an array containing the information of the selected options (the option id and its value).",
"operationId": "listTestSteps",
"responses": {
"200": {
"description": "Successfully retrieved all test steps. Returns an array of step objects, each containing step ID, index position, custom field values (Action, Data, Expected Result, etc.), and associated attachments. Each step includes both raw and rendered values for Wiki-type fields, and option details for select-type custom fields."
}
}
},
"post": {
"tags": [
"test step"
],
"summary": "Create test step",
"description": "Creates a new test step. All step fields values are listed under _fields_ and identified by the name and a list of attachments to add to the step. The field values should follow a certain format according to the custom field type. \n\n- **Toggle Fields** values should be _\"true\"_, _\"false\"_, _\"0\"_ or _\"1\"_ \n\n- **Number Fields** values should be a string containing a number, e.g. _\"320\"_. Decimal Number are also accepted,for instance, \"320.5\". The decimal places are always separated by a _\".\"_ \n\n- **Single Select and Radio Button Fields** values should be a single string containing the option value, e.g. _\"Option A\"_. The value should be a valid option for that custom field. The values are not case sensitive. \n\n- **Multiple Select Fields** values should be an array of the string of option values, e.g. _[\"Option A\", \"Option B\"]_. All the selected values should be valid for that custom field. The option values are not case sensitive. \n\n- **Date Fields** should follow the ISO format _yyyy-MM-dd_, where _yyyy_ represents the year, _MM_ the month in year and _dd_ the day in the month. For instance, a valid value would be _\"2020-05-02\"_. \n\n- **Date Time fields** should be in UTC following the ISO format _yyyy-MM-dd'T'HH:mm'Z'_. The date part follows the same date format, while _HH_ represents the hours (0-24), _mm_ the minutes in hour and _Z_ indicates the hour in UTC. For instance, a valid date time value would be _\"2020-05-02T10:30Z\"_. \n\nThe remaining field types values do not required a specific validation. For instance, for a Single Line Custom field a valid value would be _\"Perform Action B\"_. \n\nIf some value is not valid for a certain custom field type, an error will be return stating the field with the incorrect value. Furthermore, **all required step fields must be provided**.",
"operationId": "createTestStep",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"contentType": {
"type": "string",
"example": "text/plain"
},
"data": {
"type": "string",
"example": "ZHVtbXkgY29udGVudA=="
},
"filename": {
"type": "string",
"example": "dummy.txt"
}
}
},
"example": [
{
"contentType": "text/plain",
"data": "ZHVtbXkgY29udGVudA==",
"filename": "dummy.txt"
}
]
},
"fields": {
"type": "object",
"properties": {
"Action": {
"type": "string",
"example": "example step5"
},
"Data": {
"type": "string",
"example": "example data5"
},
"Expected Result": {
"type": "string",
"example": "example result5"
}
}
}
}
},
"examples": {
"add a step, with an attachment": {
"value": {
"attachments": [
{
"contentType": "text/plain",
"data": "ZHVtbXkgY29udGVudA==",
"filename": "dummy.txt"
}
],
"fields": {
"Action": "example step5",
"Data": "example data5",
"Expected Result": "example result5"
}
}
},
"create a new test step": {
"value": {
"attachments": [
{
"contentType": "text/plain",
"data": "ZHVtbXkgY29udGVudA==",
"filename": "dummy.txt"
}
],
"fields": {
"Data": "<p>input Data X</p>",
"Expected Result": "<p>Expected result X</p>",
"action": "<p>Step 1X/p>"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Test step successfully created. Returns the newly created step object including its unique step ID, assigned index position within the test, populated field values, and any attached files. The response includes validation confirmations for all custom field types and attachment processing status."
}
}
},
"parameters": [
{
"name": "testKey",
"in": "path",
"required": true,
"description": "The key of the test issue",
"schema": {
"type": "string",
"example": "TEST-123"
}
}
]
},
"/test/{testKey}/steps/{stepId}": {
"get": {
"tags": ["test step"],
"summary": "Get test step",
"description": "Returns the values of a single test step, given the test key and the step id. The response follows the same format as the previous endpoints, containing the step id, index, fields and the attachments. \n\nThe Test Step fields are identified by their name and can be of type _Data_ (Toggle, Number, Date and Date Time fields), _Option_ (Single Select, Multiple Select and Radio Button fields), _Wiki_ (Native fields, Single and Multiple Line fields). \n\nThe value of step fields of type _Wiki_ have a raw and rendered value. _Option_ fields value will be an array containing the information of the selected options (the option id and its value).",
"operationId": "getTestStep",
"responses": {
"200": {
"description": "Test step details successfully retrieved. Returns the specific test step including its ID, index position, custom field values (Action, Data, Expected Result), and any attached files. Response includes both raw and rendered values for Wiki-type fields and option details for select-type fields."
}
}
},
"put": {
"tags": ["test step"],
"summary": "Update test step",
"description": "Updates the values of an existing test step, given the test key and step id. The user can update the field values and the attachments of a step. The values should follow a specific format similar to the step creation. \n\n- **Toggle Fields** values should be _\"true\"_, _\"false\"_, _\"0\"_ or _\"1\"_ \n\n- **Number Fields** values should be a string containing a number, e.g. _\"320\"_. Decimal Number are also accepted,for instance, \"320.5\". The decimal places are always separated by a _\".\"_ \n\n- **Single Select and Radio Button Fields** values should be a single string containing the option value, e.g. _\"Option A\"_. The value should be a valid option for that custom field. The values are not case sensitive. \n\n- **Multiple Select Fields** values should be an array of the string of option values, e.g. _[\"Option A\", \"Option B\"]_. All the selected values should be valid for that custom field. The option values are not case sensitive. \n\n- **Date Fields** should follow the ISO format _yyyy-MM-dd_, where _yyyy_ represents the year, _MM_ the month in year and _dd_ the day in the month. For instance, a valid value would be _\"2020-05-02\"_. \n\n- **Date Time fields** should be in UTC following the ISO format _yyyy-MM-dd'T'HH:mm'Z'_. The date part follows the same date format, while _HH_ represents the hours (0-24), _mm_ the minutes in hour and _Z_ indicates the hour in UTC. For instance, a valid date time value would be _\"2020-05-02T10:30Z\"_. \n\nThe remaining field types values do not required a specific validation. For instance, for a Single Line Custom field a valid value would be _\"Perform Action B\"_. \n\nIf some value is not valid for a certain custom field type, an error will be return stating the field with the incorrect value. A field value can be deleted sending an empty value, such as _\"\"_ or _[]_, or by sending _null_. **It is not possible to delete the value of a required field.**",
"operationId": "updateTestStep",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"attachments": {
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "object",
"properties": {
"contentType": {"type": "string", "example": "text/plain"},
"data": {"type": "string", "example": "ZHVtbXkgY29udGVudA=="},
"filename": {"type": "string", "example": "dummy.txt"}
}
},
"example": [{"contentType": "text/plain", "data": "ZHVtbXkgY29udGVudA==", "filename": "dummy.txt"}]
}
}
},
"fields": {
"type": "object",
"properties": {
"Action": {"type": "string", "example": "example step5x"},
"Data": {"type": "string", "example": "example data5x"},
"Expected Result": {"type": "string", "example": "example result5x"}
}
}
}
},
"examples": {
"modify a step": {
"value": {
"attachments": {"add": [{"contentType": "text/plain", "data": "ZHVtbXkgY29udGVudA==", "filename": "dummy.txt"}]},
"fields": {"Action": "example step5x", "Data": "example data5x", "Expected Result": "example result5x"}
}
},
"update test step values": {
"value": {
"attachments": {"add": [{"contentType": "text/plain", "data": "ZHVtbXkgY29udGVudA==", "filename": "dummy.txt"}]},
"fields": {"Action": "example step5x", "Data": "example data5x", "Expected Result": "example result5x"}
}
}
}
}
}
},
"responses": {
"200": {"description": "Test step successfully updated. Returns the updated test step with new field values, updated attachments, and confirmation of all changes applied."}
}
},
"delete": {
"tags": ["test step"],
"summary": "Delete test step",
"description": "Deletes a test step given the test key and the step id.",
"operationId": "deleteTestStep",
"responses": {"200": {"description": "Test step successfully deleted. The specified test step has been removed from the test issue and all associated attachments have been cleaned up."}}
},
"parameters": [
{"name": "testKey", "in": "path", "required": true, "description": "The key of the test issue", "schema": {"type": "string", "example": "TEST-123"}},
{"name": "stepId", "in": "path", "required": true, "description": "The unique identifier of the test step", "schema": {"type": "string", "example": "67890"}}
]
},
"/test/{testKey}/steps/{stepId}/attachments": {
"get": {
"tags": [
"test step"
],
"summary": "List test step attachments",
"description": "Returns all the attachments of a test step, given the test key and step id.",
"operationId": "listTestStepAttachments",
"responses": {
"200": {
"description": "Test step attachments successfully retrieved. Returns a list of all attachments associated with the specified test step, including attachment IDs, filenames, content types, and metadata."
}
}
},
"parameters": [
{
"name": "testKey",
"in": "path",
"required": true,
"description": "The key of the test issue",
"schema": {
"type": "string",
"example": "TEST-123"
}
},
{
"name": "stepId",
"in": "path",
"required": true,
"description": "The unique identifier of the test step",
"schema": {
"type": "string",
"example": "67890"
}
}
]
},
"/test/{testKey}/steps/{stepId}/attachment/{attachmentId}": {
"delete": {
"tags": [
"test step"
],
"summary": "Delete test step attachment",
"description": "Deletes a test step attachment, given the test key and step and attachment ids.",
"operationId": "deleteTestStepAttachment",
"responses": {
"200": {
"description": "Test step attachment successfully deleted. The specified attachment has been removed from the test step."
}
}
},
"parameters": [
{
"name": "testKey",
"in": "path",
"required": true,
"description": "The key of the test issue",
"schema": {
"type": "string",
"example": "TEST-123"
}
},
{
"name": "stepId",
"in": "path",
"required": true,
"description": "The unique identifier of the test step",
"schema": {
"type": "string",
"example": "67890"
}
},
{
"name": "attachmentId",
"in": "path",
"required": true,
"description": "The unique identifier of the test step attachment",
"schema": {
"type": "string",
"example": "54321"
}
}
]
},
"/test": {
"get": {
"tags": [
"test"
],
"summary": "List tests",
"description": "Retrieves detailed information about one or more test issues. When keys parameter is provided, returns specific tests; otherwise returns all tests accessible to the user. The response includes test fields, steps, preconditions, and associated metadata.",
"operationId": "listTests",
"parameters": [
{
"name": "keys",
"in": "query",
"schema": {
"type": "string",
"example": "TEST-123;TEST-456;TEST-789"
}
},
{
"name": "filter",
"in": "query",
"schema": {
"type": "string",
"example": "12345"
},
"description": "ID of a saved filter to use for selecting tests."
},
{
"name": "jql",
"in": "query",
"schema": {
"type": "string",
"example": "project = XRAY AND issuetype = Test"
},
"description": "JQL query to filter tests. Must be URL encoded when used in requests. Can be combined with other parameters."
}
],
"responses": {
"200": {
"description": "Tests successfully exported. Returns detailed information about the specified test issues including their fields, steps, preconditions, and associated metadata."
}
}
}
},
"/test/{testKey}/testruns": {
"get": {
"tags": [
"test"
],
"summary": "List test runs for test",
"description": "Retrieves all test runs associated with a specific test issue. Returns a collection of test runs including execution status, timestamps, assignees, and execution results for the specified test.",
"operationId": "listTestRunsForTest",
"responses": {
"200": {
"description": "Test runs successfully exported. Returns a collection of test runs for the specified test, including execution status, timestamps, assignees, and results."
}
}
},
"parameters": [
{
"name": "testKey",
"in": "path",
"required": true,
"description": "The key of the test issue",
"schema": {
"type": "string",
"example": "TEST-123"
}
}
]
},
"/test/{testKey}/testexecutions": {
"get": {
"tags": [
"test"
],
"summary": "List test executions",
"description": "Retrieves all test execution issues that include the specified test. Returns a collection of test executions with their execution details, associated test runs, and execution metadata.",
"operationId": "listTestExecutions",
"responses": {
"200": {
"description": "Test executions successfully exported. Returns a collection of test executions that include the specified test, with execution details and associated test runs."
}
}
},
"parameters": [
{
"name": "testKey",
"in": "path",
"required": true,
"description": "The key of the test issue",
"schema": {
"type": "string",
"example": "TEST-123"
}
}
]
},
"/precondition/{preconditionKey}/test": {
"get": {
"tags": [
"precondition"
],
"summary": "List precondition tests",
"description": "Retrieves all test issues associated with a specific precondition. Returns a list of tests that are linked to the precondition, including test details and association metadata.",
"operationId": "listPreconditionTests",
"responses": {
"200": {
"description": "Precondition tests successfully retrieved. Returns a list of all test issues associated with the specified precondition, including test details and association metadata."
}
}
},
"post": {
"tags": [
"precondition"
],
"summary": "Update precondition tests",
"description": "Associates or disassociates test issues with a precondition. Supports adding new test associations or removing existing ones through the 'add' and 'remove' operations.",
"operationId": "associateTestToPrecondition",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"add": {
"type": "array",
"description": "List of test keys to associate with the precondition",
"items": {
"type": "string",
"example": "TEST-123"
},
"example": [
"TEST-123"
]
},
"remove": {
"type": "array",
"description": "List of test keys to disassociate from the precondition",
"items": {
"type": "string",
"example": "TEST-123"
},
"example": [
"TEST-123"
]
}
}
},
"examples": {
"associate test to a precondition": {
"value": {
"add": [
"TEST-123"
]
}
},
"disassociate test from a precondition": {
"value": {
"remove": [
"TEST-123"
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "Test association operation completed successfully. The specified test has been associated with or removed from the precondition as requested."
}
}
},
"parameters": [
{
"name": "preconditionKey",
"in": "path",
"required": true,
"description": "The key of the precondition issue",
"schema": {
"type": "string",
"example": "PRECOND-123"
}
}
]
},
"/precondition/{preconditionKey}/test/{testKey}": {
"delete": {
"tags": ["precondition"],
"summary": "Remove test from precondition",
"description": "Removes the association of the specified test from the given precondition.",
"operationId": "deleteTestFromPrecondition",
"parameters": [
{
"name": "preconditionKey",
"in": "path",
"required": true,
"description": "The key of the precondition issue",
"schema": { "type": "string", "example": "PRECOND-123" }
},
{
"name": "testKey",
"in": "path",
"required": true,
"description": "The key of the test issue to remove",
"schema": { "type": "string", "example": "TEST-123" }
}
],
"responses": {
"200": {
"description": "Test successfully removed from precondition."
},
"404": {
"description": "Precondition or test not found."
}
}
}
},
"/test/{testKey}/preconditions": {
"get": {
"tags": [
"test"
],
"summary": "List test preconditions",
"description": "Retrieves all precondition issues associated with a specific test. Returns a list of preconditions that are linked to the test, providing traceability between tests and their prerequisites.",
"operationId": "listTestPreconditions",
"responses": {
"200": {
"description": "Test preconditions successfully exported. Returns a list of all precondition issues associated with the specified test."
}
}
},
"parameters": [
{
"name": "testKey",
"in": "path",
"required": true,
"description": "The key of the test issue",
"schema": {
"type": "string",
"example": "TEST-123"
}
}
]
},
"/testset/{testSetKey}/test": {
"get": {
"tags": [
"test set"
],
"summary": "List test set tests",
"description": "Retrieves all test issues associated with a specific test set. Returns a comprehensive list of tests that belong to the test set, including test details and organizational metadata.",
"operationId": "listTestSetTests",
"responses": {
"200": {
"description": "Test set tests successfully retrieved. Returns a list of all test issues associated with the specified test set."
}
}
},
"post": {
"tags": [
"test set"
],
"summary": "Update test set tests",
"description": "Associates or disassociates test issues with a test set. Supports adding new test associations or removing existing ones to manage test set composition and organization.",
"operationId": "associateTestToTestSet",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"add": {
"type": "array",
"description": "List of test keys to associate with the test set",
"items": {
"type": "string",
"example": "TEST-123"
},
"example": [
"TEST-123"
]
},
"remove": {
"type": "array",
"description": "List of test keys to disassociate from the test set",
"items": {
"type": "string",
"example": "TEST-123"
},
"example": [
"TEST-123"
]
}
}
},
"examples": {
"associate test to test set": {
"value": {
"add": [
"TEST-123"
]
}
},
"disassociate test from a test set": {
"value": {
"remove": [
"TEST-123"
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "Test set association operation completed successfully. The specified test has been associated with or removed from the test set as requested."
}
}
},
"parameters": [
{
"name": "testSetKey",
"in": "path",
"required": true,
"description": "The key of the test set issue",
"schema": {
"type": "string",
"example": "TESTSET-123"
}
}
]
},
"/testset/{testSetKey}/test/{testKey}": {
"delete": {
"tags": ["test set"],
"summary": "Remove test from test set",
"description": "Removes the association of the specified test from the given test set.",
"operationId": "deleteTestFromTestSet",
"parameters": [
{
"name": "testSetKey",
"in": "path",
"required": true,
"description": "The key of the test set issue",
"schema": { "type": "string", "example": "TESTSET-123" }
},
{
"name": "testKey",
"in": "path",
"required": true,
"description": "The key of the test issue to remove",
"schema": { "type": "string", "example": "TEST-123" }
}
],
"responses": {
"200": {
"description": "Test successfully removed from test set."
},
"404": {
"description": "Test set or test not found."
}
}
}
},
"/test/{testKey}/testsets": {
"get": {
"tags": [
"test"
],
"summary": "List test sets",
"description": "Retrieves all test set issues that include the specified test. Returns a list of test sets where the test is a member, providing visibility into test organization and grouping.",
"operationId": "listTestTestSets",
"responses": {
"200": {
"description": "Test sets successfully exported. Returns a list of all test set issues that include the specified test."
}
}
},
"parameters": [
{
"name": "testKey",
"in": "path",
"required": true,
"description": "The key of the test issue",
"schema": {
"type": "string",
"example": "TEST-123"
}
}
]
},
"/testexec/{testExecutionKey}/test": {
"get": {
"tags": [
"test execution"
],
"summary": "List test execution tests",
"description": "Retrieves all test issues associated with a specific test execution. Returns a comprehensive list of tests included in the test execution, along with their current execution status and results.",
"operationId": "listTestExecutionTests",
"responses": {
"200": {
"description": "Test execution tests successfully retrieved. Returns a list of all test issues associated with the specified test execution, including test details, execution status, and results."
}
}
},
"put": {
"tags": [
"test execution"
],
"summary": "Update test execution tests",
"description": "Associates or disassociates test issues with a test execution. Supports adding new tests to the execution scope or removing tests from the execution plan through 'add' and 'remove' operations.",
"operationId": "associateTestToTestExecution",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"add": {
"type": "array",
"description": "List of test keys to associate with the test execution",
"items": {
"type": "string",
"example": "TEST-456"
},
"example": [
"TEST-456"
]
},
"remove": {
"type": "array",
"description": "List of test keys to disassociate from the test execution",
"items": {
"type": "string",
"example": "TEST-456"
},
"example": [
"TEST-456"
]
}
}
},
"examples": {
"associate test to a test execution": {
"value": {
"add": [
"TEST-456"
]
}
},
"disassociate test from a test execution": {
"value": {
"remove": [
"TEST-456"
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "Test execution association operation completed successfully. The specified test has been associated with or removed from the test execution as requested."
}
}
},
"parameters": [
{
"name": "testExecutionKey",
"in": "path",
"required": true,
"description": "The key of the test execution issue",
"schema": {
"type": "string",
"example": "EXEC-123"
}
}
]
},
"/testexec/{testExecutionKey}/test/{testKey}": {
"delete": {
"tags": ["test execution"],
"summary": "Remove test from test execution",
"description": "Removes the association of the specified test from the given test execution.",
"operationId": "deleteTestFromTestExecution",
"parameters": [
{
"name": "testExecutionKey",
"in": "path",
"required": true,
"description": "The key of the test execution issue",
"schema": { "type": "string", "example": "EXEC-123" }
},
{
"name": "testKey",
"in": "path",
"required": true,
"description": "The key of the test issue to remove",
"schema": { "type": "string", "example": "TEST-123" }
}
],
"responses": {
"200": {
"description": "Test successfully removed from test execution."
},
"404": {
"description": "Test execution or test not found."
}
}
}
},
"/testrun": {
"get": {
"tags": [
"test run"
],
"summary": "Get test run by keys",
"description": "Retrieves a Test Run given the Test Execution and Test keys. The response will contain all information related to a Test Run, e.g., status, created and finish dates, step results, test environments, defects, Test Run Custom fields, and so on.",
"operationId": "getTestRunByKeys",
"parameters": [
{
"name": "testExecIssueKey",
"in": "query",
"schema": {
"type": "string",
"example": "EXEC-123"
},
"description": "(Required) The key of the Test Execution"
},
{
"name": "testIssueKey",
"in": "query",
"schema": {
"type": "string",
"example": "TEST-123"
},
"description": "(Required) The key of the Test"
}
],
"responses": {
"200": {
"description": "Test Run details successfully retrieved. Returns comprehensive Test Run information including execution status, start/finish timestamps, assignee, test environments, defect associations, step-by-step results with evidence attachments, custom field values, and execution duration metrics."
}
}
}
},
"/testrun/{testRunId}": {
"get": {
"tags": [
"test run"
],
"summary": "Get test run",
"description": "Retrieves a Test Run given the Test Run id. The response will contain all information related to a Test Run, e.g., status, created and finish dates, step results, test environments, defects, Test Run Custom fields, and so on.",
"operationId": "getTestRun",
"responses": {
"200": {
"description": "Test Run details successfully retrieved. Returns comprehensive Test Run information including execution status (TODO, EXECUTING, PASS, FAIL, ABORTED), start/finish timestamps, assignee, test environments, defect associations, step-by-step results with evidence attachments, custom field values, and execution duration metrics."
}
}
},
"put": {
"tags": [
"test run"
],
"summary": "Update test run",
"description": "Updates all the values of a Test Run. The user can update the values of the overall status, step results, assignee, test environments, add defects and evidences and so on. \n\nTo update the value of a Test Run custom field, the id of the field must be provided as well as a valid value for that custom field type. \n\n- **Toggle Fields** values should be _\"true\"_, _\"false\"_, _\"0\"_ or _\"1\"_ \n\n- **Number Fields** values should be a string containing a number, e.g. _\"320\"_. Decimal Number are also accepted,for instance, \"320.5\". The decimal places are always separated by a _\".\"_ \n\n- **Single Select and Radio Button Fields** values should be a single string containing the option value, e.g. _\"Option A\"_. The value should be a valid option for that custom field. The values are not case sensitive. \n\n- **Multiple Select Fields** values should be an array of the string of option values, e.g. _[\"Option A\", \"Option B\"]_. All the selected values should be valid for that custom field. The option values are not case sensitive. \n\n- **Date Fields** should follow the ISO format _yyyy-MM-dd_, where _yyyy_ represents the year, _MM_ the month in year and _dd_ the day in the month. For instance, a valid value would be _\"2020-05-02\"_. \n\n- **Date Time fields** should be in UTC following the ISO format _yyyy-MM-dd'T'HH:mm'Z'_. The date part follows the same date format, while _HH_ represents the hours (0-24), _mm_ the minutes in hour and _Z_ indicates the hour in UTC. For instance, a valid date time value would be _\"2020-05-02T10:30Z\"_. \n\nAn error will be returned when there are invalid custom field values.\nIt is also possible to delete a Test Run custom field value by providing a _null_ or empty value (e.g., _\"\"_ or _[]_). **It is not possible to delete a value of a required Test Run Custom Field value.** Also, **it is not possible to change the Test Run to a final status when there are required Test Run custom fields with empty values.**",
"operationId": "updateTestRun",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"example": "failed"
},
"status": {
"type": "string",
"example": "FAIL"
}
}
},
"examples": {
"update test run": {
"value": {
"comment": "failed",
"status": "FAIL"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Test Run successfully updated. Returns the updated Test Run with new field values, execution status, evidence attachments, defect associations, and confirmation of all changes applied."
}
}
},
"parameters": [
{
"name": "testRunId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "10003"
},
"description": "(Required) The id of the Test Run"
}
]
},
"/testrun/{testRunId}/status": {
"get": {
"tags": [
"test run"
],
"summary": "Get test run status",
"description": "Retrieves the current execution status of a specific Test Run. Returns the status value (TODO, EXECUTING, PASS, FAIL, ABORTED, or custom status) along with related execution metadata.",
"operationId": "getTestRunStatus",
"responses": {
"200": {
"description": "Test Run status successfully retrieved. Returns the current execution status value and related execution metadata including timestamps and status history."
}
}
},
"put": {
"tags": [
"test run"
],
"summary": "Update test run status",
"description": "Updates the overall execution status of a specific Test Run. Valid status values include TODO (not started), EXECUTING (in progress), PASS (successful), FAIL (failed), ABORTED (terminated), and any custom statuses configured in Xray. This operation automatically updates finish timestamp for final statuses and triggers status-dependent workflows.",
"operationId": "updateTestRunStatus",
"parameters": [
{
"name": "status",
"in": "query",
"schema": {
"type": "string",
"example": "FAIL"
}
}
],
"responses": {
"200": {
"description": "Test Run status successfully updated. Returns confirmation of the status change with updated timestamp information. The response includes the new status value and any triggered workflow transitions or notifications."
}
}
},
"parameters": [
{
"name": "testRunId",
"in": "path",
"required": true,
"description": "The unique identifier of the test run",
"schema": {
"type": "string",
"example": "10001"
}
}
]
},
"/testrun/{testRunId}/defect": {
"get": {
"tags": [
"test run"
],
"summary": "List test run defects",
"description": "Retrieves all defect issues (bugs, issues) associated with a specific Test Run. Returns a comprehensive list of defects linked to the test run, providing traceability between failed test executions and their related issues.",
"operationId": "getTestRunDefects",
"responses": {
"200": {
"description": "Test Run defects successfully retrieved. Returns a comprehensive list of all defect issues associated with the Test Run, including defect details, link information, and traceability metadata."
}
}
},
"put": {
"tags": [
"test run"
],
"summary": "Link defects to test run",
"description": "Associates one or more defect issues (bugs, issues) with a specific Test Run. This creates bidirectional traceability links between failed test executions and their related defects, enabling comprehensive defect tracking and test coverage analysis. Defects can be existing Jira issues or newly created ones.",
"operationId": "linkDefectsToTestRun",
"requestBody": {
"content": {
"application/json": {