generated from peter-evans/swagger-github-pages
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy patheMASSRestOpenApi.yaml
3798 lines (3719 loc) · 142 KB
/
eMASSRestOpenApi.yaml
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
#------------------------------------------------------------------------------
# I N F O - API metadata
#------------------------------------------------------------------------------
info:
title: Enterprise Mission Assurance Support Service (eMASS)
description: |-
The Enterprise Mission Assurance Support Service (eMASS) REST Application
Programming Interface (API) enables users to perform assessments and complete actions
associated with system records. This document will provide an outline of all eMASS
objects and their associated endpoints to include Department of Defense (DoD) business
rules that pertain to each.
New users will need to register an API key with the eMASS development team prior to
accessing the site for the first time. The eMASS REST API requires a client certificate
(SSL/TLS, DoD PKI only) where {url}/api/register (POST) is used to register the client
certificate.
Every call to the eMASS REST API will require the use of the agreed upon public key
certificate and API key. The API key must be provided in the request header for all
endpoint calls (api-key). If the service receives an untrusted certificate or API key, a
401 error response code will be returned along with an error message.
<strong>Available Request Headers:</strong>
| Key | Example Value | Description
|----------|------------------------------------|------------------------------------
|`api-key` |avalidkeyisneeded |This API key must be provided in the request header for all endpoint calls
|`user-uid`|avaliduseruid |This User unique identifier key must be provided in the request header for all PUT, POST, and DELETE endpoint calls.
| | |Note: For DoD users this is the DoD ID Number (EIDIPI) on their DoD CAC.
Users are required to log-in to eMASS and grant permissions for a client to update data
within eMASS on their behalf. This is only required for actionable requests (PUT, POST,
DELETE). The Registration Endpoint and all GET requests can be accessed without
completing this process with the correct permissions.
<strong>Approve API Client for Actionable Requests</strong><br>
Users are required to log-in to eMASS and grant permissions for a client to update data
within eMASS on their behalf. This is only required for actionable requests (PUT, POST,
DELETE). The Registration Endpoint and all GET requests can be accessed without
completing this process with the correct permissions. Please note that leaving a field
parameter blank (for PUT/POST requests) has the potential to clear information in the
active eMASS records.
To gain permissions to the relevant endpoints for a new API key:
contact:
name: eMASS Tier III support
url: 'https://www.dcsa.mil/is/emass/'
email: [email protected]
version: '2.3.0'
externalDocs:
description: eMASS New User Registration
url: 'https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf'
#------------------------------------------------------------------------------
# S E R V E R S - Array of Server Objects which provide connectivity information
# to target servers.
#------------------------------------------------------------------------------
#servers:
# - url: "http://localhost:4010"
# - url: "https://pilot-comm.emasstest.boozallencsn.com:443"
#- url: "https://localhost:4433"
servers:
- url: "http://localhost:4010"
description: The localhost mock server
- url: https://pilot-comm.emasstest.boozallencsn.com:{port}
#- url: https://pilot-comm.emasstest.boozallencsn.com:{port}/{basePath}
description: The development API server
variables:
user-uid:
# note! no enum here means it is an open value
default: 'USER.TEST121.EMASS'
description: this value is assigned by the service provider, in this example `gigantic-server.com`
port:
enum:
- '8443'
- '443'
default: '443'
#basePath:
# open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2`
# default: v2
#------------------------------------------------------------------------------
# T A G S - A list of tags used by the specification with additional metadata.
#------------------------------------------------------------------------------
tags:
- name: Test
description: >
The Test Connection endpoint is provided by eMASS to verify and troubleshoot
the connection to the web service
- name: Registration
description: >
The Registration endpoint is provided by eMASS to allow users to register their certificate
and obtain an API key. This API key must be provided in the request header for all
endpoint calls (api-key).
- name: Systems
description: "The System endpoint provides the ability to access system data"
- name: SystemRoles
description: "The System Roles endpoints provide the ability to access user data assigned to systems"
- name: Controls
description: "The Control endpoints provide the ability to add Security Control information to a system for both the Implementation Plan and Risk Assessment."
- name: TestResults
description: >
The Test Result endpoints provide the ability to add test results for a system's DoD
Assessment Procedures (CCIs) which determines NIST SP 80-53 Revision 4 Security
Control Compliance (Compliant, Non-Compliant, Not Applicable). The endpoints also
provide the ability to retrieve test results.
- name: POAM
description: >
These endpoints provide the ability to add Plan of Action and Milestones (POA&M) items to a system.
The endpoint also provides the ability to view, update and/or remove existing POA&M items and associated milestones in a system.
- name: Artifacts
description: >
The Artifact endpoints provide the ability to add new Artifacts
(supporting documentation/evidence for Security Control Assessments and system
Authorization activities) to a system.
- name: ApprovalChain
description: >
The Approval Chain endpoints provide the ability to view Security Controls’ locations in
the Control Approval Chain (CAC) in a system and submit them to the 2nd role of the CAC
for independent verification and validation. These endpoints also provide the ability to
view the location of a system's package in the Package Approval Chain (PAC) and submit
a new package for assessment and authorization.
#------------------------------------------------------------------------------
# P A T H S - The available paths and operations for the API endpoints
#------------------------------------------------------------------------------
paths:
#----------------------------------------------------------------------------
# Test endpoint
#----------------------------------------------------------------------------
/api:
get:
tags:
- Test
summary: "Test connection to the API"
description: "Returns endpoint call status"
operationId: testConnection
responses:
'200':
description: "Successful response"
content:
application/json:
schema:
"$ref": "#/components/schemas/Test"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
'500':
description: "Server encountered an unexpected condition which prevented it from fulfilling the request"
#----------------------------------------------------------------------------
# Register endpoint
#----------------------------------------------------------------------------
/api/api-key:
post:
tags:
- Registration
summary: "Register user certificate and obtain an API key"
description: "Returns the api-key - This API key must be provided in the request header for all endpoint calls (api-key)."
operationId: registerUser
requestBody:
description: "User certificate previously provided by eMASS."
content:
application/json:
schema:
"$ref": "#/components/schemas/RegisterUser"
application/x-www-form-urlencoded:
schema:
"$ref": "#/components/schemas/RegisterUser"
required: true
responses:
'200':
description: "Request has succeeded"
content:
application/json:
schema:
"$ref": "#/components/schemas/Register"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
'500':
description: "Server encountered an unexpected condition which prevented it from fulfilling the request"
#----------------------------------------------------------------------------
# Systems endpoint
#----------------------------------------------------------------------------
/api/systems:
get:
tags:
- Systems
summary: "Get system information matching provided parameters"
description: |-
Returns the system(s) data matching parameters<br>
**Notes**<br>
<ul>
<li>If a system is dual-policy enabled, the returned system details default to the RMF policy information unless otherwise specified for an individual system.</li>
<li>Certain fields are instance specific and may not be returned in GET request.</li>
</ul>
operationId: getSystems
parameters:
- $ref: '#/components/parameters/includePackage'
- $ref: '#/components/parameters/registrationType'
- $ref: '#/components/parameters/ditprId'
- $ref: '#/components/parameters/coamsId'
- $ref: '#/components/parameters/policy'
- $ref: '#/components/parameters/includeDitprMetrics'
- $ref: '#/components/parameters/includeDecommissioned'
responses:
'200':
description: "Successful response"
content:
application/json:
schema:
oneOf:
- "$ref": "#/components/schemas/SystemResponse1"
- "$ref": "#/components/schemas/SystemResponse2"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
'480':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/480"
'490':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/490"
'500':
description: "Server encountered an unexpected condition which prevented it from fulfilling the request"
#----------------------------------------------------------------------------
# System Roles endpoint
#----------------------------------------------------------------------------
/api/system-roles:
get:
tags:
- SystemRoles
summary: "Get available roles"
description: |-
Returns all available roles<br>
**Notes**<br>
<ul>
<li>If a system is dual-policy enabled, the returned system role information default to the RMF policy information unless otherwise specified.</li>
</ul>
operationId: getSystemRoles
responses:
'200':
description: "Successful response"
content:
application/json:
schema:
"$ref": "#/components/schemas/SystemRolesResponse"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
'480':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/480"
'490':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/490"
'500':
description: "Server encountered an unexpected condition which prevented it from fulfilling the request"
/api/system-roles/{roleCategory}:
get:
tags:
- SystemRoles
summary: "Get system roles"
description: |-
Returns the role(s) data matching parameters.<br>
**Notes**<br>
<ul>
<li>If a system is dual-policy enabled, the returned system role information default to the RMF policy information unless otherwise specified.</li>
</ul>
operationId: getSystemByRoleCategoryId
parameters:
- $ref: '#/components/parameters/roleCategory'
- $ref: '#/components/parameters/role'
- $ref: '#/components/parameters/policy'
responses:
'200':
description: "Successful response"
content:
application/json:
schema:
"$ref": "#/components/schemas/SystemRoleCategoryResponse"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
'480':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/480"
'490':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/490"
'500':
description: "Server encountered an unexpected condition which prevented it from fulfilling the request"
#----------------------------------------------------------------------------
# Control endpoint
#----------------------------------------------------------------------------
/api/systems/{systemId}/controls:
get:
tags:
- Controls
summary: "Get control information in a system for one or many controls"
description: |-
Returns system control information for matching `systemId` path parameter
operationId: getSystemBySystemId
parameters:
- $ref: '#/components/parameters/systemId'
- $ref: '#/components/parameters/acronyms'
responses:
'200':
description: "Successful response"
content:
application/json:
schema:
"$ref": "#/components/schemas/ControlResponse"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
'480':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/480"
'490':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/490"
'500':
description: "Server encountered an unexpected condition which prevented it from fulfilling the request"
put:
tags:
- Controls
summary: "Update control information in a system for one or many controls"
description: "Update an existing control by System Id"
operationId: updateControlBySystemId
parameters:
- $ref: '#/components/parameters/systemId'
requestBody:
description: "Update an existing control by Id"
content:
application/json:
schema:
"$ref": "#/components/schemas/Controls"
application/x-www-form-urlencoded:
schema:
"$ref": "#/components/schemas/Controls"
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/200"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
'480':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/480"
'490':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/490"
'500':
description: "Server encountered an unexpected condition which prevented it from fulfilling the request"
#----------------------------------------------------------------------------
# Test Results endpoint
#----------------------------------------------------------------------------
/api/systems/{systemId}/test-results:
get:
tags:
- TestResults
summary: "Get one or many test results in a system"
description: |-
Returns system test results information for matching parameters.<br>
operationId: getTestResultsBySystemId
parameters:
- $ref: '#/components/parameters/systemId'
- $ref: '#/components/parameters/controlAcronyms'
- $ref: '#/components/parameters/ccis'
- $ref: '#/components/parameters/latestOnly'
responses:
'200':
description: "Successful response"
content:
application/json:
schema:
"$ref": "#/components/schemas/TestResultslResponse"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
'480':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/480"
'490':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/490"
'500':
description: "Server encountered an unexpected condition which prevented it from fulfilling the request"
post:
tags:
- TestResults
summary: "Add one or many test results in a system"
description: "Adds test results for given `systemId`"
operationId: addTestResultsBySystemId
parameters:
- $ref: '#/components/parameters/systemId'
requestBody:
description: "Update an existing control by Id"
content:
application/json:
schema:
"$ref": "#/components/schemas/TestResults"
application/x-www-form-urlencoded:
schema:
"$ref": "#/components/schemas/TestResults"
required: true
responses:
'200':
description: "Successful response"
content:
application/json:
schema:
"$ref": "#/components/schemas/200"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
'480':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/480"
'490':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/490"
'500':
description: "Server encountered an unexpected condition which prevented it from fulfilling the request"
#----------------------------------------------------------------------------
# POA&M endpoint
#----------------------------------------------------------------------------
/api/systems/{systemId}/poams:
get:
tags:
- POAM
summary: "Get one or many poa&m items in a system"
description: |-
Returns system containing POA&M items for matching parameters.
parameters:
- $ref: '#/components/parameters/systemId'
- $ref: '#/components/parameters/scheduledCompletionDateStart'
- $ref: '#/components/parameters/scheduledCompletionDateEnd'
- $ref: '#/components/parameters/controlAcronyms'
- $ref: '#/components/parameters/ccis'
- $ref: '#/components/parameters/systemOnly'
responses:
'200':
description: "Successful response"
content:
application/json:
schema:
"$ref": "#/components/schemas/PoamResponse"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
'480':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/480"
'490':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/490"
'500':
description: "Server encountered an unexpected condition which prevented it from fulfilling the request"
post:
tags:
- POAM
summary: "Add one or many poa&m items in a system"
description: |-
Adds POA&M for given `systemId`<br>
**Note**<br>
If a POC email is supplied, the application will attempt to locate a user already
registered within the application and pre-populate any information not explicitly supplied
in the request. If no such user is found, these fields are required within the request.<br>
`pocOrganization`, `pocFirstName`, `pocLastName`, `pocEmail`, `pocPhoneNumber`
operationId: addPoamBySystemId
parameters:
- $ref: '#/components/parameters/systemId'
requestBody:
description: "Update an existing control by Id"
content:
application/json:
schema:
"$ref": "#/components/schemas/POAM"
application/x-www-form-urlencoded:
schema:
"$ref": "#/components/schemas/POAM"
required: true
responses:
'200':
description: "Successful response"
content:
application/json:
schema:
"$ref": "#/components/schemas/200"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
'480':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/480"
'490':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/490"
'500':
description: "Server encountered an unexpected condition which prevented it from fulfilling the request"
put:
tags:
- POAM
summary: "Update one or many poa&m items in a system"
description: |-
Update Adds POA&M for given `systemId`<br>
**Note**<br>
If a POC email is supplied, the application will attempt to locate a user already
registered within the application and pre-populate any information not explicitly supplied
in the request. If no such user is found, these fields are required within the request.<br>
`pocOrganization`, `pocFirstName`, `pocLastName`, `pocEmail`, `pocPhoneNumber`
operationId: updatePoamBySystemId
parameters:
- $ref: '#/components/parameters/systemId'
requestBody:
description: "Update an existing control by Id"
content:
application/json:
schema:
"$ref": "#/components/schemas/POAM"
application/x-www-form-urlencoded:
schema:
"$ref": "#/components/schemas/POAM"
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/200"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
'480':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/480"
'490':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/490"
'500':
description: "Server encountered an unexpected condition which prevented it from fulfilling the request"
delete:
tags:
- POAM
summary: "Remove one or many poa&m items in a system"
description: |-
Remove the POA&M matching `systemId` path parameter and `poamId` query parameter<br>
operationId: deletePoam
parameters:
- $ref: '#/components/parameters/systemId'
- name: poamId
in: query
description: "**POA&M Id**: The unique POA&M record identifier."
required: true
schema:
type: integer
x-faker: random.number
example: 45
responses:
'200':
description: Successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/200"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
/api/systems/{systemId}/poams/{poamId}:
get:
tags:
- POAM
summary: "Get poa&m item by id in a system"
description: |-
Returns system test results information for matching parameters.<br>
operationId: getPoamBySystemIdAndPoamId
parameters:
- $ref: '#/components/parameters/systemId'
- $ref: '#/components/parameters/poamId'
responses:
'200':
description: "Successful response"
content:
application/json:
schema:
"$ref": "#/components/schemas/PoamResponse"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
'480':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/480"
'490':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/490"
'500':
description: "Server encountered an unexpected condition which prevented it from fulfilling the request"
/api/systems/{systemId}/poams/{poamId}/milestones:
get:
tags:
- POAM
summary: "Get milestones in one or many poa&m items in a system"
description: |-
Returns system containing milestones for matching parameters.
operationId: getMilestonesBySystemIdAndPoamId
parameters:
- $ref: '#/components/parameters/systemId'
- $ref: '#/components/parameters/poamId'
- $ref: '#/components/parameters/scheduledCompletionDateStart'
- $ref: '#/components/parameters/scheduledCompletionDateEnd'
responses:
'200':
description: "Successful response"
content:
application/json:
schema:
"$ref": "#/components/schemas/MilestoneResponse"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
'480':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/480"
'490':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/490"
'500':
description: "Server encountered an unexpected condition which prevented it from fulfilling the request"
post:
tags:
- POAM
summary: "Add milestones to one or many poa&m items in a system"
description: "Adds a milestone for given `systemId` and `poamId` path parameters"
operationId: addMilestoneBySystemIdAndPoamId
parameters:
- $ref: '#/components/parameters/systemId'
- $ref: '#/components/parameters/poamId'
requestBody:
description: "Update an existing milestone"
content:
application/json:
schema:
"$ref": "#/components/schemas/PostMilestones"
application/x-www-form-urlencoded:
schema:
"$ref": "#/components/schemas/PostMilestones"
required: true
responses:
'200':
description: "Successful response"
content:
application/json:
schema:
"$ref": "#/components/schemas/200"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
'480':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/480"
'490':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/490"
'500':
description: "Server encountered an unexpected condition which prevented it from fulfilling the request"
put:
tags:
- POAM
summary: "Update one or many poa&m items in a system"
description: "Updates a milestone for given `systemId` and `poamId` path parameters"
operationId: updateMilestoneBySystemIdAndPoamId
parameters:
- $ref: '#/components/parameters/systemId'
- $ref: '#/components/parameters/poamId'
requestBody:
description: "Update an existing control by Id"
content:
application/json:
schema:
"$ref": "#/components/schemas/PutMilestones"
application/x-www-form-urlencoded:
schema:
"$ref": "#/components/schemas/PostMilestones"
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/200"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
'480':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/480"
'490':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/490"
'500':
description: "Server encountered an unexpected condition which prevented it from fulfilling the request"
delete:
tags:
- POAM
summary: "Remove milestones in a system for one or many poa&m items"
description: |-
Remove the POA&M matching `systemId` path parameter<br>
**Notes**<br>
To delete a milestone the record must be inactive by having the field isActive set to false (`isActive=false`).
operationId: deleteMilestone
parameters:
- $ref: '#/components/parameters/systemId'
- $ref: '#/components/parameters/poamId'
- name: milestoneId
in: query
description: "**Milestone Id**: The unique milestone record identifier."
required: true
schema:
type: integer
x-faker: random.number
example: 77
responses:
'200':
description: Successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/200"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
/api/systems/{systemId}/poams/{poamId}/milestones/{milestoneId}:
get:
tags:
- POAM
summary: "Get milestone by id in poa&m item in a system"
description: |-
Returns systems containing milestones for matching parameters.
operationId: getMilestonesBySystemIdAndPoamIdAndfMilestoneId
parameters:
- $ref: '#/components/parameters/systemId'
- $ref: '#/components/parameters/poamId'
- $ref: '#/components/parameters/milestoneId'
responses:
'200':
description: "Successful response"
content:
application/json:
schema:
"$ref": "#/components/schemas/MilestoneResponse"
'400':
description: "Request could not be understood by the server due to malformed syntax."
'401':
description: "Request requires user authentication. Client may repeat the request with suitable Authorization"
content:
text/plain:
schema:
"$ref": "#/components/schemas/401"
'480':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/480"
'490':
description: "Business rule is violated that prevents the requested action."
content:
text/plain:
schema:
"$ref": "#/components/schemas/490"
'500':
description: "Server encountered an unexpected condition which prevented it from fulfilling the request"
#----------------------------------------------------------------------------
# Artifacts endpoint
#----------------------------------------------------------------------------
/api/systems/{systemId}/artifacts:
get:
tags: