diff --git a/dispoAPI/index.html b/dispoAPI/index.html
index e9b6185..ae3a36d 100644
--- a/dispoAPI/index.html
+++ b/dispoAPI/index.html
@@ -13,7 +13,7 @@
       margin: 0;
     }
   </style>
-  <script src="https://cdn.redoc.ly/redoc/v2.1.5/bundles/redoc.standalone.js"></script><style data-styled="true" data-styled-version="6.1.13">.dFrZq{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
+  <script src="https://cdn.redocly.com/redoc/v2.2.0/bundles/redoc.standalone.js"></script><style data-styled="true" data-styled-version="6.1.13">.dFrZq{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
 @media print,screen and (max-width: 75rem){.dFrZq{width:100%;padding:40px 40px;}}/*!sc*/
 data-styled.g4[id="sc-fAUdSK"]{content:"dFrZq,"}/*!sc*/
 .bvhSud{padding:40px 0;}/*!sc*/
@@ -250,19 +250,19 @@
 data-styled.g91[id="sc-geoRQH"]{content:"dZsYqS,"}/*!sc*/
 .enkzRg{border:1px solid #32329f;color:#32329f;font-weight:normal;margin-left:0.5em;padding:4px 8px 4px;display:inline-block;text-decoration:none;cursor:pointer;}/*!sc*/
 data-styled.g92[id="sc-kEsJEW"]{content:"enkzRg,"}/*!sc*/
-.gYaAxf{width:9ex;display:inline-block;height:13px;line-height:13px;background-color:#333;border-radius:3px;background-repeat:no-repeat;background-position:6px 4px;font-size:7px;font-family:Verdana,sans-serif;color:white;text-transform:uppercase;text-align:center;font-weight:bold;vertical-align:middle;margin-right:6px;margin-top:2px;}/*!sc*/
-.gYaAxf.get{background-color:#2F8132;}/*!sc*/
-.gYaAxf.post{background-color:#186FAF;}/*!sc*/
-.gYaAxf.put{background-color:#95507c;}/*!sc*/
-.gYaAxf.options{background-color:#947014;}/*!sc*/
-.gYaAxf.patch{background-color:#bf581d;}/*!sc*/
-.gYaAxf.delete{background-color:#cc3333;}/*!sc*/
-.gYaAxf.basic{background-color:#707070;}/*!sc*/
-.gYaAxf.link{background-color:#07818F;}/*!sc*/
-.gYaAxf.head{background-color:#A23DAD;}/*!sc*/
-.gYaAxf.hook{background-color:#32329f;}/*!sc*/
-.gYaAxf.schema{background-color:#707070;}/*!sc*/
-data-styled.g99[id="sc-erSfwj"]{content:"gYaAxf,"}/*!sc*/
+.bbQame{width:9ex;display:inline-block;height:13px;line-height:13px;background-color:#333;border-radius:3px;background-repeat:no-repeat;background-position:6px 4px;font-size:7px;font-family:Verdana,sans-serif;color:white;text-transform:uppercase;text-align:center;font-weight:bold;vertical-align:middle;margin-right:6px;margin-top:2px;}/*!sc*/
+.bbQame.get{background-color:#2F8132;}/*!sc*/
+.bbQame.post{background-color:#186FAF;}/*!sc*/
+.bbQame.put{background-color:#95507c;}/*!sc*/
+.bbQame.options{background-color:#947014;}/*!sc*/
+.bbQame.patch{background-color:#bf581d;}/*!sc*/
+.bbQame.delete{background-color:#cc3333;}/*!sc*/
+.bbQame.basic{background-color:#707070;}/*!sc*/
+.bbQame.link{background-color:#07818F;}/*!sc*/
+.bbQame.head{background-color:#A23DAD;}/*!sc*/
+.bbQame.hook{background-color:#32329f;}/*!sc*/
+.bbQame.schema{background-color:#707070;}/*!sc*/
+data-styled.g99[id="sc-erSfwj"]{content:"bbQame,"}/*!sc*/
 .dXwhdL{margin:0;padding:0;}/*!sc*/
 .dXwhdL:first-child{padding-bottom:32px;}/*!sc*/
 .sc-iRVXky .sc-iRVXky{font-size:0.929em;}/*!sc*/
@@ -342,7 +342,7 @@
 
 <body>
   
-      <div id="redoc"><div class="sc-iMPxVN beDZfq redoc-wrap"><div class="sc-dFqmTM jmYWik menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-dtOqdk cqdCbT"><svg class="sc-kBpWFy eDlXyu search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input placeholder="Search..." aria-label="Search" type="text" class="sc-hPGoDJ kAGYgE search-input" value=""/></div><div class="sc-dEkLRj cpBPUN scrollbar-container undefined"><ul role="menu" class="sc-iRVXky dXwhdL"><li tabindex="0" depth="2" data-item-id="/paths/~1switchDevice/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj gYaAxf operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Switches one device for another in the cmdb, including any children the old device might have had.</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1installDevice/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj gYaAxf operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Installs a device in the cmdb</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1uninstallDevice/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj gYaAxf operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Uninstalls a device in the cmdb including any children passed in the request.</span></label></li></ul><div class="sc-fUEImY fxirIR"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-eqXzvo cZPhLc"><div class="sc-bLmarx isQMci"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
+      <div id="redoc"><div class="sc-iMPxVN beDZfq redoc-wrap"><div class="sc-dFqmTM jmYWik menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-dtOqdk cqdCbT"><svg class="sc-kBpWFy eDlXyu search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input placeholder="Search..." aria-label="Search" type="text" class="sc-hPGoDJ kAGYgE search-input" value=""/></div><div class="sc-dEkLRj cpBPUN scrollbar-container undefined"><ul role="menu" class="sc-iRVXky dXwhdL"><li tabindex="0" depth="2" data-item-id="/paths/~1switchDevice/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj bbQame operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Switches one device for another in the cmdb, including any children the old device might have had.</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1installDevice/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj bbQame operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Installs a device in the cmdb</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1uninstallDevice/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj bbQame operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Uninstalls a device in the cmdb including any children passed in the request.</span></label></li></ul><div class="sc-fUEImY fxirIR"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-eqXzvo cZPhLc"><div class="sc-bLmarx isQMci"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
           m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
           -55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
           0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
diff --git a/incidentRestAPI.html b/incidentRestAPI.html
index f96ae65..1426aa8 100644
--- a/incidentRestAPI.html
+++ b/incidentRestAPI.html
@@ -13,7 +13,7 @@
       margin: 0;
     }
   </style>
-  <script src="https://cdn.redoc.ly/redoc/v2.1.5/bundles/redoc.standalone.js"></script><style data-styled="true" data-styled-version="6.1.13">.dFrZq{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
+  <script src="https://cdn.redocly.com/redoc/v2.2.0/bundles/redoc.standalone.js"></script><style data-styled="true" data-styled-version="6.1.13">.dFrZq{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
 @media print,screen and (max-width: 75rem){.dFrZq{width:100%;padding:40px 40px;}}/*!sc*/
 data-styled.g4[id="sc-fAUdSK"]{content:"dFrZq,"}/*!sc*/
 .bvhSud{padding:40px 0;}/*!sc*/
@@ -260,19 +260,19 @@
 data-styled.g91[id="sc-geoRQH"]{content:"dZsYqS,"}/*!sc*/
 .enkzRg{border:1px solid #32329f;color:#32329f;font-weight:normal;margin-left:0.5em;padding:4px 8px 4px;display:inline-block;text-decoration:none;cursor:pointer;}/*!sc*/
 data-styled.g92[id="sc-kEsJEW"]{content:"enkzRg,"}/*!sc*/
-.gYaAxf{width:9ex;display:inline-block;height:13px;line-height:13px;background-color:#333;border-radius:3px;background-repeat:no-repeat;background-position:6px 4px;font-size:7px;font-family:Verdana,sans-serif;color:white;text-transform:uppercase;text-align:center;font-weight:bold;vertical-align:middle;margin-right:6px;margin-top:2px;}/*!sc*/
-.gYaAxf.get{background-color:#2F8132;}/*!sc*/
-.gYaAxf.post{background-color:#186FAF;}/*!sc*/
-.gYaAxf.put{background-color:#95507c;}/*!sc*/
-.gYaAxf.options{background-color:#947014;}/*!sc*/
-.gYaAxf.patch{background-color:#bf581d;}/*!sc*/
-.gYaAxf.delete{background-color:#cc3333;}/*!sc*/
-.gYaAxf.basic{background-color:#707070;}/*!sc*/
-.gYaAxf.link{background-color:#07818F;}/*!sc*/
-.gYaAxf.head{background-color:#A23DAD;}/*!sc*/
-.gYaAxf.hook{background-color:#32329f;}/*!sc*/
-.gYaAxf.schema{background-color:#707070;}/*!sc*/
-data-styled.g99[id="sc-erSfwj"]{content:"gYaAxf,"}/*!sc*/
+.bbQame{width:9ex;display:inline-block;height:13px;line-height:13px;background-color:#333;border-radius:3px;background-repeat:no-repeat;background-position:6px 4px;font-size:7px;font-family:Verdana,sans-serif;color:white;text-transform:uppercase;text-align:center;font-weight:bold;vertical-align:middle;margin-right:6px;margin-top:2px;}/*!sc*/
+.bbQame.get{background-color:#2F8132;}/*!sc*/
+.bbQame.post{background-color:#186FAF;}/*!sc*/
+.bbQame.put{background-color:#95507c;}/*!sc*/
+.bbQame.options{background-color:#947014;}/*!sc*/
+.bbQame.patch{background-color:#bf581d;}/*!sc*/
+.bbQame.delete{background-color:#cc3333;}/*!sc*/
+.bbQame.basic{background-color:#707070;}/*!sc*/
+.bbQame.link{background-color:#07818F;}/*!sc*/
+.bbQame.head{background-color:#A23DAD;}/*!sc*/
+.bbQame.hook{background-color:#32329f;}/*!sc*/
+.bbQame.schema{background-color:#707070;}/*!sc*/
+data-styled.g99[id="sc-erSfwj"]{content:"bbQame,"}/*!sc*/
 .dXwhdL{margin:0;padding:0;}/*!sc*/
 .dXwhdL:first-child{padding-bottom:32px;}/*!sc*/
 .sc-iRVXky .sc-iRVXky{font-size:0.929em;}/*!sc*/
@@ -362,7 +362,7 @@
 
 <body>
   
-      <div id="redoc"><div class="sc-iMPxVN beDZfq redoc-wrap"><div class="sc-dFqmTM jmYWik menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-dtOqdk cqdCbT"><svg class="sc-kBpWFy eDlXyu search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input placeholder="Search..." aria-label="Search" type="text" class="sc-hPGoDJ kAGYgE search-input" value=""/></div><div class="sc-dEkLRj cpBPUN scrollbar-container undefined"><ul role="menu" class="sc-iRVXky dXwhdL"><li tabindex="0" depth="2" data-item-id="/paths/~1incident/post" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="post" class="sc-erSfwj gYaAxf operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">create a new incident</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1incident/get" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="get" class="sc-erSfwj gYaAxf operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">fetch an existing incident</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1incident/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj gYaAxf operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">update an incident</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1incident~1addAttachment/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj gYaAxf operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">add attachments</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1incident~1addWorknote/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj gYaAxf operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">add a worknote</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1incident~1addComment/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj gYaAxf operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">add a comment</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1incident~1resolve/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj gYaAxf operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">resolve an incident</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1incident~1reopen/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj gYaAxf operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">reopen an incident</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1callback/post" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="post" class="sc-erSfwj gYaAxf operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Notification via POST request</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1callback/get" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="get" class="sc-erSfwj gYaAxf operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Notification via GET request</span></label></li></ul><div class="sc-fUEImY fxirIR"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-eqXzvo cZPhLc"><div class="sc-bLmarx isQMci"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
+      <div id="redoc"><div class="sc-iMPxVN beDZfq redoc-wrap"><div class="sc-dFqmTM jmYWik menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-dtOqdk cqdCbT"><svg class="sc-kBpWFy eDlXyu search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input placeholder="Search..." aria-label="Search" type="text" class="sc-hPGoDJ kAGYgE search-input" value=""/></div><div class="sc-dEkLRj cpBPUN scrollbar-container undefined"><ul role="menu" class="sc-iRVXky dXwhdL"><li tabindex="0" depth="2" data-item-id="/paths/~1incident/post" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="post" class="sc-erSfwj bbQame operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">create a new incident</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1incident/get" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="get" class="sc-erSfwj bbQame operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">fetch an existing incident</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1incident/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj bbQame operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">update an incident</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1incident~1addAttachment/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj bbQame operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">add attachments</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1incident~1addWorknote/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj bbQame operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">add a worknote</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1incident~1addComment/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj bbQame operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">add a comment</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1incident~1resolve/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj bbQame operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">resolve an incident</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1incident~1reopen/patch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="patch" class="sc-erSfwj bbQame operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">reopen an incident</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1callback/post" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="post" class="sc-erSfwj bbQame operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Notification via POST request</span></label></li><li tabindex="0" depth="2" data-item-id="/paths/~1callback/get" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="get" class="sc-erSfwj bbQame operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Notification via GET request</span></label></li></ul><div class="sc-fUEImY fxirIR"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-eqXzvo cZPhLc"><div class="sc-bLmarx isQMci"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
           m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
           -55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
           0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
@@ -380,8 +380,26 @@
           55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
           -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
           -104.0616 -231.873,-231.248 z
-        " fill="currentColor"></path></g></svg></div></div><div class="sc-jdwyG knmTbM api-content"><div class="sc-dntaoT bvhSud"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq api-info"><h1 class="sc-ixGGxD sc-geoRQH kHkxTT dZsYqS">Incident REST API<!-- --> <span>(<!-- -->1.0.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-kEsJEW enkzRg">Download</a></p><div class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"></div><div data-role="redoc-summary" html="" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"></div><div data-role="redoc-description" html="&lt;p&gt;handles communication between the MyIT incident system and partner systems.&lt;/p&gt;
-" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>handles communication between the MyIT incident system and partner systems.</p>
+        " fill="currentColor"></path></g></svg></div></div><div class="sc-jdwyG knmTbM api-content"><div class="sc-dntaoT bvhSud"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq api-info"><h1 class="sc-ixGGxD sc-geoRQH kHkxTT dZsYqS">Incident REST API<!-- --> <span>(<!-- -->1.0.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-kEsJEW enkzRg">Download</a></p><div class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"></div><div data-role="redoc-summary" html="" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"></div><div data-role="redoc-description" html="&lt;p&gt;Handles communication between the MyIT incident system and partner systems.&lt;/p&gt;
+&lt;p&gt;&lt;strong&gt;State values:&lt;/strong&gt;&lt;/p&gt;
+&lt;ul&gt;
+&lt;li&gt;New: 1&lt;/li&gt;
+&lt;li&gt;In progress: 2&lt;/li&gt;
+&lt;li&gt;On hold: 3&lt;/li&gt;
+&lt;li&gt;Resolved: 6&lt;/li&gt;
+&lt;li&gt;Closed: 7&lt;/li&gt;
+&lt;li&gt;Cancelled: 8&lt;/li&gt;
+&lt;/ul&gt;
+" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>Handles communication between the MyIT incident system and partner systems.</p>
+<p><strong>State values:</strong></p>
+<ul>
+<li>New: 1</li>
+<li>In progress: 2</li>
+<li>On hold: 3</li>
+<li>Resolved: 6</li>
+<li>Closed: 7</li>
+<li>Cancelled: 8</li>
+</ul>
 </div></div></div></div><div id="/paths/~1incident/post" data-section-id="/paths/~1incident/post" class="sc-dntaoT aYCdu"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq"><h2 class="sc-khLCKb wHiQv"><a class="sc-jwIPbr hbTOAm" href="#/paths/~1incident/post" aria-label="/paths/~1incident/post"></a>create a new incident<!-- --> </h2><div class="sc-fantwC exRUVh"><div html="&lt;p&gt;creates a new incident in myIT and returns said incident.&lt;/p&gt;
 " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>creates a new incident in myIT and returns said incident.</p>
 </div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy eqXCjK"><span class="sc-bqvdXA dIXVzO"><i>BasicAuth</i></span></span></div></div><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><div html="&lt;p&gt;The values to intially write to the incident.&lt;/p&gt;
@@ -510,7 +528,7 @@
 " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>General response. Actual response handling is managed by the receiving system.</p>
 </div></button></div></div></div><div class="sc-ivxoEo sc-ghWlax gOjFGl oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY IVbnb http-verb get">get</span><span class="sc-etPtWW iqHzp">/callback</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"></div><div tabindex="0" role="button"><div class="sc-hSyjfr gufODt"><span>https://&lt;MyIT-url&gt;/api/x_ssagd_inc_rest/rest</span>/callback</div></div></div></div></div></div></div></div></div><div class="sc-eEVuZf ifLiBE"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.2","info":{"title":"Incident REST API","description":"handles communication between the MyIT incident system and partner systems.","version":"1.0.0"},"servers":[{"url":"https://<MyIT-url>/api/x_ssagd_inc_rest/rest"}],"security":[{"BasicAuth":[]}],"paths":{"/incident":{"post":{"summary":"create a new incident","description":"creates a new incident in myIT and returns said incident.","requestBody":{"description":"The values to intially write to the incident.","content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"description":"the id of the partner system, agreed upon with the MyIT team.","example":"SystemX","type":"string"},"partnerIncidentId":{"description":"your internal id of the incident, for your reference. Note that this must be unique. Once an incident is closed however - the id is freed up again.","example":"1234567890","type":"string"},"channel":{"description":"possible values are 'monitoring' or 'vendor'. If you are an external vendor, please choose 'vendor'. If you are an internal event-monitoring system, please choose 'monitoring'.","example":"vendor","type":"string"},"description":{"description":"the descriptive title of the incident.","example":"Some problem with something","type":"string"},"short_description":{"description":"the description of the incident, describing the situation in detail.","example":"There is a complicated problem with the incident rest api - HELP!","type":"string"},"location":{"description":"the name or sys-id of the concerned location. If you don't know what to put here, please ask your swisspost contact.","example":"afeeadcb8776c6103efc00000000","type":"string"},"cmdb_ci":{"description":"the name or sys-id of the concerned configuration item. If you don't know what to put here, please ask your swisspost contact.","example":"w010xq","type":"string"},"causing_ci":{"description":"the name or sys-id of the underlying causing configuration item. If you don't know what to put here, please ask your swisspost contact. This is mandatory only for systems of channel 'monitoring'.","example":"w010xq","type":"string"},"attachments":{"description":"any attachments you'd like to add to the incident. The content must be base64 encoded.","type":"array","items":{"type":"object","properties":{"fileName":{"description":"the name of the file","example":"picture_of_the_problem.png","type":"string"},"content_type":{"description":"the mime type of the file","example":"image/png","type":"string"},"content":{"type":"string","description":"the content of the file in base64","example":"c25lYWt5","format":"byte"}}}}},"required":["partnerId","partnerIncidentId","channel","description","short_description"]}}}},"responses":{"200":{"description":"the created incident","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","example":{"config":"SystemX","partnerId":"SystemX","server_system_time":"2020-10-24T06:23:41.089Z"}},"message":{"type":"string","example":"Incident 00000000000000000000000000000001 created."},"data":{"type":"object","example":{"incidentId":"6d101e0487e3ca903ef00000000000","number":"INC0000001","channel":"vendor","partnerIncidentId":"1234567890","description":"Some problem with something","short_description":"There is a complicated problem with the incident rest api - HELP!","state":1,"opened_at":"1997-09-08T05:55:00Z","sys_updated_on":"2024-07-17T14:36:59Z","opened_by":{"first_name":"Example","last_name":"Name","user_name":"example_name"},"assignment_group":{"description":"Example group","name":"Example groupname"},"location":{"city":"Bern","cmn_location_type":"room","country":"Switzerland","full_name":"CH/Bern/Viktoriastrasse 21/Viktoriastrasse 21/1.UG/001","name":"001"},"causing_ci":{"asset_tag":"123456789","model_id":{"display_name":"Lenovo ThinkPad P16 Gen1","name":"ThinkPad P16 Gen1","sys_id":"70a44cbf87f739d06d000000000000"},"name":"example hostname","operational_status":1,"serial_number":"ABCD12345","sys_id":"acba0c3f87ff75503ef0000000000000"},"attachments":[{"filename":"thisIsAFileName.pdf","content_type":"application/pdf","download_url":"https://<MyIT-url>/sys_attachment.do?sys_id=12f0297d87544e12334567890000000","sys_id":"12f0297d87544e12334567890000000"},{"filename":"picture_of_the_problem.png","content_type":"image/png","download_url":"https://<MyIT-url>/sys_attachment.do?sys_id=12f0297d87544e12334567890000001","sys_id":"12f0297d87544e12334567890000001"}]}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"MyItRestException"},"message":{"type":"string","example":"'partnerId' not specified"},"status":{"type":"integer","example":400}}}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":{"message":"User Not Authenticated","detail":"Required to provide Auth information"}},"status":{"type":"string","example":"failure"}}}}}},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"MyItRestException"},"message":{"type":"string","example":"The action failed due to a business rule. Message: [\"short_description is mandatory.\",\"partnerIncidentId is mandatory.\"]"},"status":{"type":"integer","example":500}}}}}}}},"get":{"summary":"fetch an existing incident","description":"Requires 'partnerId' AND either 'incidentId' OR 'partnerIncidentId' and returns the corresponding incident.","parameters":[{"name":"partnerId","in":"query","required":true,"description":"The id of the partner system, to be agreed upon with the MyIT team.","example":"SystemX","schema":{"type":"string"}},{"name":"incidentId","in":"query","required":true,"description":"The MyIT-internal id of the incident.","example":"6d101e0487e3ca903ef00000000000","schema":{"type":"string"}},{"name":"partnerIncidentId","in":"query","required":true,"description":"your internal id of the incident, for your reference.  Note that this must be unique. Once an incident is closed however - the id is freed up again.","example":"1234567890","schema":{"type":"string"}}],"responses":{"200":{"description":"the incident corresponding to the incidentId or partnerIncidentId.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","example":{"config":"SystemX","partnerId":"SystemX","server_system_time":"2020-10-24T06:23:41.089Z"}},"data":{"type":"object","example":{"incidentId":"6d101e0487e3ca903ef00000000000","number":"INC0000001","partnerIncidentId":"12345","short_description":"descriptive text","state":1,"opened_at":"1997-09-08T05:55:00Z","sys_updated_on":"2024-07-17T14:36:59Z","u_current_workplace":"workplace 123","opened_by":{"first_name":"Example","last_name":"Name","user_name":"example_name"},"assignment_group":{"description":"Example group","name":"Example groupname"},"causing_ci":{"asset_tag":"123456789","model_id":{"display_name":"Lenovo ThinkPad P16 Gen1","name":"ThinkPad P16 Gen1","sys_id":"70a44cbf87f739d06d000000000000"},"name":"example hostname","operational_status":1,"serial_number":"ABCD12345","sys_id":"acba0c3f87ff75503ef0000000000000"},"attachments":[{"filename":"thisIsAFileName.pdf","content_type":"application/pdf","download_url":"https://<MyIT-url>/sys_attachment.do?sys_id=12f0297d87544e12334567890000000","sys_id":"12f0297d87544e12334567890000000"}]}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":"MyItRestException"},"message":{"type":"string","example":"'partnerId' not specified"},"status":{"type":"integer","example":400}}}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":{"message":"User Not Authenticated","detail":"Required to provide Auth information"}},"status":{"type":"string","example":"failure"}}}}}}}},"patch":{"summary":"update an incident","description":"updates an incident that already exists in myIT. 'partnerId' AND 'incidentId' OR 'partnerIncidentId' must either be in the body or the query params.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"description":"the id of the partner system, agreed upon with the MyIT team.","example":"SystemX","type":"string"},"incidentId":{"description":"The MyIT-internal id of the incident.","example":"43c569a98771f5106dc8630000000000","type":"string"},"partnerIncidentId":{"description":"your internal id of the incident, for your reference.  Note that this must be unique. Once an incident is closed however - the id is freed up again.","example":"1234567890","type":"string"},"short_description":{"type":"string","description":"example field to update","example":"this is an updated description of the problem"}},"required":["partnerId","incidentId","partnerIncidentId"]}}}},"responses":{"200":{"description":"the updated incident","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","example":{"config":"SystemX","partnerId":"SystemX","server_system_time":"2020-10-24T06:23:41.089Z"}},"message":{"type":"string","example":"Incident 43c569a98771f5106dc8630000000000 updated."},"data":{"type":"object","example":{"incidentId":"6d101e0487e3ca903ef00000000000","number":"INC0000001","partnerIncidentId":"1234567890","short_description":"this is an updated description of the problem","state":1,"opened_at":"1997-09-08T05:55:00Z","sys_updated_on":"2024-07-17T14:36:59Z","opened_by":{"first_name":"Example","last_name":"Name","user_name":"example_name"},"assignment_group":{"description":"Example group","name":"Example groupname"},"causing_ci":{"asset_tag":"123456789","model_id":{"display_name":"Lenovo ThinkPad P16 Gen1","name":"ThinkPad P16 Gen1","sys_id":"70a44cbf87f739d06d000000000000"},"name":"example hostname","operational_status":1,"serial_number":"ABCD12345","sys_id":"acba0c3f87ff75503ef0000000000000"},"attachments":[{"filename":"thisIsAFileName.pdf","content_type":"application/pdf","download_url":"https://<MyIT-url>/sys_attachment.do?sys_id=12f0297d87544e12334567890000000","sys_id":"12f0297d87544e12334567890000000"}]}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"MyItRestException"},"message":{"type":"string","example":"'partnerId' not specified"},"status":{"type":"integer","example":400}}}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":{"message":"User Not Authenticated","detail":"Required to provide Auth information"}},"status":{"type":"string","example":"failure"}}}}}}}}},"/incident/addAttachment":{"patch":{"summary":"add attachments","description":"adds attachments to an incident that already exists in myIT. 'partnerId' AND either 'incidentId' OR 'partnerIncidentId' must either be in the body or the query params. Any attachments must be base64 encoded.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"description":"the id of the partner system, agreed upon with the MyIT team.","example":"SystemX","type":"string"},"incidentId":{"description":"The MyIT-internal id of the incident.","example":"6d101e0487e3ca903ef00000000000","type":"string"},"partnerIncidentId":{"description":"your internal id of the incident, for your reference.  Note that this must be unique. Once an incident is closed however - the id is freed up again.","example":"1234567890","type":"string"},"attachments":{"description":"any attachments you'd like to add to the incident. The content must be base64 encoded.","type":"array","items":{"type":"object","properties":{"fileName":{"description":"the name of the file","example":"picture_of_the_problem.png","type":"string"},"content_type":{"description":"the mime type of the file","example":"image/png","type":"string"},"content":{"type":"string","description":"the content of the file in base64","example":"c25lYWt5","format":"byte"}}}}}}}}},"responses":{"200":{"description":"the updated incident","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","example":{"Caveat":"THIS IS PRE-ALPHA CODE AND SUBJECT TO CHANGE AT ANY TIM(E)!","git":"IncidentRestApi-0.0.1+70-dd86b01-dirty","build":"2023-10-24T14:54:24.706Z","config":"systemId","partnerId":"systemId","server_system_time":"2023-10-27T07:02:46.583Z"}},"message":{"type":"string","example":"Attachment(s) added to Incident 43c569a98771f5106dc8630000000000."},"data":{"type":"object","example":{"number":"INC0000001","short_description":"short description","priority":4,"opened_by:":{"active":true,"sys_class_name":"sys_user","sys_id":"a6fb235587fc71503efcec000000000"},"severity":3,"opened_at":"2023-10-10T07:22:04Z","category":"service_request","incident_id":"43c569a98771f5106dc8630000000000","class":"incident","attachments":[{"filename":"thisIsAFileName.txt","content_type":"application/json","download_url":"https://<MyIT-url>/sys_attachment.do?sys_id=af0192da874481234567890123456789","sys_id":"af0192da874481234567890123456789"}]}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"MyItRestException"},"message":{"type":"string","example":"content of attachment thisIsAFileName.txt is not valid base64."},"status":{"type":"integer","example":400}}}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":{"message":"User Not Authenticated","detail":"Required to provide Auth information"}},"status":{"type":"string","example":"failure"}}}}}}}}},"/incident/addWorknote":{"patch":{"summary":"add a worknote","description":"adds a worknote to an incident that already exists in myIT. PartnerId AND either IncidentId OR partnerIncidentId must either be in the body or the query params.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"type":"string"},"incidentId":{"type":"string"},"partnerIncidentId":{"type":"string"},"worknote":{"type":"string"}}}}}},"responses":{"200":{"description":"the updated incident","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","example":{"Caveat":"THIS IS PRE-ALPHA CODE AND SUBJECT TO CHANGE AT ANY TIM(E)!","git":"IncidentRestApi-0.0.1+70-dd86b01-dirty","build":"2023-10-24T14:54:24.706Z","config":"systemId","partnerId":"systemId","server_system_time":"2023-10-27T07:02:46.583Z"}},"message":{"type":"string","example":"Worknote added to incident 43c569a98771f5106dc8630000000000."},"data":{"type":"object","example":{"number":"INC0000001","short_description":"short description","priority":4,"opened_by:":{"active":true,"sys_class_name":"sys_user","sys_id":"a6fb235587fc71503efcec000000000"},"severity":3,"opened_at":"2023-10-10T07:22:04Z","category":"service_request","incident_id":"43c569a98771f5106dc8630000000000","class":"incident","worknotes":[{"sys_id":"ta6fb235587fc71503efcec000000123","sys_created_by":"admin.user","sys_created_on":"2024-01-24T06:29:35Z","value":"worknote detailing progress on incident\r\nTest"}]}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"MyItRestException"},"message":{"type":"string","example":"No worknote found in request body."},"status":{"type":"integer","example":400}}}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":{"message":"User Not Authenticated","detail":"Required to provide Auth information"}},"status":{"type":"string","example":"failure"}}}}}}}}},"/incident/addComment":{"patch":{"summary":"add a comment","description":"adds a comment to an incident that already exists in myIT. 'partnerId' AND either 'incidentId' OR 'partnerIncidentId' must either be in the body or the query params.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"type":"string"},"incidentId":{"type":"string"},"partnerIncidentId":{"type":"string"},"comment":{"type":"string"}}}}}},"responses":{"200":{"description":"the updated incident","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","example":{"Caveat":"THIS IS PRE-ALPHA CODE AND SUBJECT TO CHANGE AT ANY TIM(E)!","git":"IncidentRestApi-0.0.1+70-dd86b01-dirty","build":"2023-10-24T14:54:24.706Z","config":"systemId","partnerId":"systemId","server_system_time":"2023-10-27T07:02:46.583Z"}},"message":{"type":"string","example":"Comment added to incident 43c569a98771f5106dc8630000000000."},"data":{"type":"object","example":{"number":"INC0000001","short_description":"short description","priority":4,"opened_by:":{"active":true,"sys_class_name":"sys_user","sys_id":"a6fb235587fc71503efcec000000000"},"severity":3,"opened_at":"2023-10-10T07:22:04Z","category":"service_request","incident_id":"43c569a98771f5106dc8630000000000","class":"incident","comments":[{"sys_id":"ta6fb235587fc71503efcec000000123","sys_created_by":"admin.user","sys_created_on":"2024-01-24T06:29:35Z","value":"Customer-facing comment, detailing progress on incident\r\nTest"}]}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"MyItRestException"},"message":{"type":"string","example":"comment must be of type string."},"status":{"type":"integer","example":400}}}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":{"message":"User Not Authenticated","detail":"Required to provide Auth information"}},"status":{"type":"string","example":"failure"}}}}}}}}},"/incident/resolve":{"patch":{"summary":"resolve an incident","description":"resolves an incident in myIT. Requires a worknote. PartnerId AND either IncidentId OR partnerIncidentId must either be in the body or the query params.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"type":"string"},"incidentId":{"type":"string"},"partnerIncidentId":{"type":"string"},"worknote":{"type":"string"}},"required":["partnerId","incidentId","partnerIncidentId","worknote"]}}}},"responses":{"200":{"description":"the resolved incident","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","example":{"Caveat":"THIS IS PRE-ALPHA CODE AND SUBJECT TO CHANGE AT ANY TIM(E)!","git":"IncidentRestApi-0.0.1+70-dd86b01-dirty","build":"2023-10-24T14:54:24.706Z","config":"systemId","partnerId":"systemId","server_system_time":"2023-10-27T07:02:46.583Z"}},"message":{"type":"string","example":"Incident 43c569a98771f5106dc8630000000000 resolved."},"data":{"type":"object","example":{"number":"INC0000001","short_description":"short description","priority":4,"opened_by:":{"active":true,"sys_class_name":"sys_user","sys_id":"a6fb235587fc71503efcec000000000"},"severity":3,"opened_at":"2023-10-10T07:22:04Z","category":"service_request","incident_id":"43c569a98771f5106dc8630000000000","class":"incident","worknotes":[{"sys_id":"ta6fb235587fc71503efcec000000123","sys_created_by":"admin.user","sys_created_on":"2024-01-24T06:29:35Z","value":"reason for reopening incident\r\nTest"}]}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"MyItRestException"},"message":{"type":"string","example":"No worknote found in request body."},"status":{"type":"integer","example":400}}}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":{"message":"User Not Authenticated","detail":"Required to provide Auth information"}},"status":{"type":"string","example":"failure"}}}}}}}}},"/incident/reopen":{"patch":{"summary":"reopen an incident","description":"Reopens an incident in myIT that has status 'resolved'. Requires a worknote. PartnerId AND either IncidentId OR partnerIncidentId must either be in the body or the query params.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"type":"string"},"incidentId":{"type":"string"},"partnerIncidentId":{"type":"string"},"worknote":{"type":"string"}},"required":["partnerId","incidentId","partnerIncidentId","worknote"]}}}},"responses":{"200":{"description":"the reopened incident","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","example":{"Caveat":"THIS IS PRE-ALPHA CODE AND SUBJECT TO CHANGE AT ANY TIM(E)!","git":"IncidentRestApi-0.0.1+70-dd86b01-dirty","build":"2023-10-24T14:54:24.706Z","config":"systemId","partnerId":"systemId","server_system_time":"2023-10-27T07:02:46.583Z"}},"message":{"type":"string","example":"Incident 43c569a98771f5106dc8630000000000 reopened."},"data":{"type":"object","example":{"number":"INC0000001","short_description":"short description","priority":4,"opened_by:":{"active":true,"sys_class_name":"sys_user","sys_id":"a6fb235587fc71503efcec000000000"},"severity":3,"opened_at":"2023-10-10T07:22:04Z","category":"service_request","incident_id":"43c569a98771f5106dc8630000000000","class":"incident","worknotes":[{"sys_id":"ta6fb235587fc71503efcec000000123","sys_created_by":"admin.user","sys_created_on":"2024-01-24T06:29:35Z","value":"reason for reopening incident\r\nTest"}]}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"MyItRestException"},"message":{"type":"string","example":"No worknote found in request body."},"status":{"type":"integer","example":400}}}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":{"message":"User Not Authenticated","detail":"Required to provide Auth information"}},"status":{"type":"string","example":"failure"}}}}}}}}},"/callback":{"post":{"summary":"Notification via POST request","description":"Sends a POST request to the partner's callback URL when an incident changes containing the complete incident.","requestBody":{"description":"The incident data sent to the callback URL.","content":{"application/json":{"schema":{"type":"object","properties":{"metaData":{"type":"string","example":"The incident has changed. This is the newest state:"},"number":{"type":"string","example":"INC0000001"},"time_worked":{"type":"string","example":"1970-01-01 01:54:46"},"short_description":{"type":"string","example":"update"},"priority":{"type":"number","example":1},"severity":{"type":"number","example":2},"opened_at":{"type":"string","example":"2023-11-23T09:16:47Z"},"category":{"type":"string","example":"service_request"},"incident_id":{"type":"string","example":"f806607f87a6f9d03efcec0000000000"},"class":{"type":"string","example":"incident"}}}}}},"responses":{"200":{"description":"Callback request description. Actual response handling is managed by the receiving system."},"default":{"description":"General response. Actual response handling is managed by the receiving system."}}},"get":{"summary":"Notification via GET request","description":"Sends a GET request to the partner's callback URL with incidentId and callbackUrl as query parameters when an incident changes. This URL can be queried with GET to then receive the changed incident.","parameters":[{"name":"incidentId","in":"query","description":"The ID of the incident that changed.","schema":{"type":"string","example":"f806607f87a6f9d03efcec0000000000"}},{"name":"callbackUrl","in":"query","description":"The readymade URL leading to the changed incident.","schema":{"type":"string","example":"https://<MyIT-url>/api/x_ssagd_inc_rest/rest/incident?partnerId=systemX&incidentId=f806607f87a6f9d03efcec0000000000"}}],"responses":{"200":{"description":"Callback request description. Actual response handling is managed by the receiving system."},"default":{"description":"General response. Actual response handling is managed by the receiving system."}}}}},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}}},"searchIndex":{"store":["/paths/~1incident/post","/paths/~1incident/get","/paths/~1incident/patch","/paths/~1incident~1addAttachment/patch","/paths/~1incident~1addWorknote/patch","/paths/~1incident~1addComment/patch","/paths/~1incident~1resolve/patch","/paths/~1incident~1reopen/patch","/paths/~1callback/post","/paths/~1callback/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,1.37,1,1.37,2,0.236]],["description/0",[0,1.803,1,1.803,2,0.442,3,0.466,4,1.803]],["title/1",[2,0.236,5,1.842,6,0.641]],["description/1",[2,0.389,4,1.733,7,1.34,8,0.448,9,0.302,10,0.448,11,2.331]],["title/2",[2,0.278,12,1.614]],["description/2",[2,0.354,3,0.388,6,0.702,8,0.388,9,0.261,10,0.388,12,1.501,13,0.906,14,0.533,15,0.388,16,0.533]],["title/3",[17,0.573,18,1.614]],["description/3",[2,0.228,3,0.342,6,0.62,8,0.342,9,0.23,10,0.342,13,0.799,14,0.47,15,0.342,16,0.47,17,0.47,18,1.883,19,1.781,20,1.781,21,1.781]],["title/4",[17,0.573,22,0.973]],["description/4",[2,0.25,3,0.376,6,0.68,8,0.376,9,0.253,10,0.376,13,0.876,14,0.516,15,0.376,16,0.516,17,0.516,22,0.876,23,1.954]],["title/5",[17,0.573,24,1.614]],["description/5",[2,0.25,3,0.376,6,0.68,8,0.376,9,0.253,10,0.376,13,0.876,14,0.516,15,0.376,16,0.516,17,0.516,24,1.453,25,1.954]],["title/6",[2,0.278,26,1.247]],["description/6",[2,0.258,3,0.388,7,1.16,8,0.388,9,0.261,10,0.388,14,0.533,15,0.388,16,0.533,22,0.906,26,1.16,27,2.019]],["title/7",[2,0.278,28,1.614]],["description/7",[2,0.242,3,0.364,7,1.088,8,0.364,9,0.245,10,0.364,14,0.5,15,0.364,16,0.5,22,0.849,26,1.088,28,1.407,29,1.893,30,1.893]],["title/8",[31,1.19,32,1.19,33,1.19,34,0.718]],["description/8",[2,0.354,33,1.501,34,0.906,35,1.501,36,1.501,37,2.056,38,1.501,39,1.501,40,2.019,41,2.019]],["title/9",[31,1.37,32,1.37,34,0.826]],["description/9",[2,0.317,9,0.224,15,0.477,34,0.776,35,1.286,36,1.286,37,1.845,38,1.845,39,1.845,42,1.73,43,1.73,44,1.73]]],"invertedIndex":[["add",{"_index":17,"title":{"3":{},"4":{},"5":{}},"description":{"3":{},"4":{},"5":{}}}],["alreadi",{"_index":13,"title":{},"description":{"2":{},"3":{},"4":{},"5":{}}}],["attach",{"_index":18,"title":{"3":{}},"description":{"3":{}}}],["base64",{"_index":19,"title":{},"description":{"3":{}}}],["bodi",{"_index":14,"title":{},"description":{"2":{},"3":{},"4":{},"5":{},"6":{},"7":{}}}],["callback",{"_index":37,"title":{},"description":{"8":{},"9":{}}}],["callbackurl",{"_index":42,"title":{},"description":{"9":{}}}],["chang",{"_index":39,"title":{},"description":{"8":{},"9":{}}}],["comment",{"_index":24,"title":{"5":{}},"description":{"5":{}}}],["complet",{"_index":41,"title":{},"description":{"8":{}}}],["contain",{"_index":40,"title":{},"description":{"8":{}}}],["correspond",{"_index":11,"title":{},"description":{"1":{}}}],["creat",{"_index":0,"title":{"0":{}},"description":{"0":{}}}],["encod",{"_index":20,"title":{},"description":{"3":{}}}],["exist",{"_index":6,"title":{"1":{}},"description":{"2":{},"3":{},"4":{},"5":{}}}],["fetch",{"_index":5,"title":{"1":{}},"description":{}}],["incid",{"_index":2,"title":{"0":{},"1":{},"2":{},"6":{},"7":{}},"description":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{}}}],["incident/addattach",{"_index":21,"title":{},"description":{"3":{}}}],["incident/addcom",{"_index":25,"title":{},"description":{"5":{}}}],["incident/addworknot",{"_index":23,"title":{},"description":{"4":{}}}],["incident/reopen",{"_index":30,"title":{},"description":{"7":{}}}],["incident/resolv",{"_index":27,"title":{},"description":{"6":{}}}],["incidentid",{"_index":9,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"9":{}}}],["myit",{"_index":3,"title":{},"description":{"0":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{}}}],["new",{"_index":1,"title":{"0":{}},"description":{"0":{}}}],["notif",{"_index":31,"title":{"8":{},"9":{}},"description":{}}],["param",{"_index":16,"title":{},"description":{"2":{},"3":{},"4":{},"5":{},"6":{},"7":{}}}],["paramet",{"_index":43,"title":{},"description":{"9":{}}}],["partner'",{"_index":36,"title":{},"description":{"8":{},"9":{}}}],["partnerid",{"_index":8,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{}}}],["partnerincidentid",{"_index":10,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{}}}],["post",{"_index":33,"title":{"8":{}},"description":{"8":{}}}],["queri",{"_index":15,"title":{},"description":{"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"9":{}}}],["receiv",{"_index":44,"title":{},"description":{"9":{}}}],["reopen",{"_index":28,"title":{"7":{}},"description":{"7":{}}}],["request",{"_index":34,"title":{"8":{},"9":{}},"description":{"8":{},"9":{}}}],["requir",{"_index":7,"title":{},"description":{"1":{},"6":{},"7":{}}}],["resolv",{"_index":26,"title":{"6":{}},"description":{"6":{},"7":{}}}],["return",{"_index":4,"title":{},"description":{"0":{},"1":{}}}],["send",{"_index":35,"title":{},"description":{"8":{},"9":{}}}],["statu",{"_index":29,"title":{},"description":{"7":{}}}],["updat",{"_index":12,"title":{"2":{}},"description":{"2":{}}}],["url",{"_index":38,"title":{},"description":{"8":{},"9":{}}}],["via",{"_index":32,"title":{"8":{},"9":{}},"description":{}}],["worknot",{"_index":22,"title":{"4":{}},"description":{"4":{},"6":{},"7":{}}}]],"pipeline":[]}},"options":{}};
+      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.2","info":{"title":"Incident REST API","description":"Handles communication between the MyIT incident system and partner systems.\n\n**State values:**\n- New: 1\n- In progress: 2\n- On hold: 3\n- Resolved: 6\n- Closed: 7\n- Cancelled: 8\n","version":"1.0.0"},"servers":[{"url":"https://<MyIT-url>/api/x_ssagd_inc_rest/rest"}],"security":[{"BasicAuth":[]}],"paths":{"/incident":{"post":{"summary":"create a new incident","description":"creates a new incident in myIT and returns said incident.","requestBody":{"description":"The values to intially write to the incident.","content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"description":"the id of the partner system, agreed upon with the MyIT team.","example":"SystemX","type":"string"},"partnerIncidentId":{"description":"your internal id of the incident, for your reference. Note that this must be unique. Once an incident is closed however - the id is freed up again.","example":"1234567890","type":"string"},"channel":{"description":"possible values are 'monitoring' or 'vendor'. If you are an external vendor, please choose 'vendor'. If you are an internal event-monitoring system, please choose 'monitoring'.","example":"vendor","type":"string"},"description":{"description":"the descriptive title of the incident.","example":"Some problem with something","type":"string"},"short_description":{"description":"the description of the incident, describing the situation in detail.","example":"There is a complicated problem with the incident rest api - HELP!","type":"string"},"location":{"description":"the name or sys-id of the concerned location. If you don't know what to put here, please ask your swisspost contact.","example":"afeeadcb8776c6103efc00000000","type":"string"},"cmdb_ci":{"description":"the name or sys-id of the concerned configuration item. If you don't know what to put here, please ask your swisspost contact.","example":"w010xq","type":"string"},"causing_ci":{"description":"the name or sys-id of the underlying causing configuration item. If you don't know what to put here, please ask your swisspost contact. This is mandatory only for systems of channel 'monitoring'.","example":"w010xq","type":"string"},"attachments":{"description":"any attachments you'd like to add to the incident. The content must be base64 encoded.","type":"array","items":{"type":"object","properties":{"fileName":{"description":"the name of the file","example":"picture_of_the_problem.png","type":"string"},"content_type":{"description":"the mime type of the file","example":"image/png","type":"string"},"content":{"type":"string","description":"the content of the file in base64","example":"c25lYWt5","format":"byte"}}}}},"required":["partnerId","partnerIncidentId","channel","description","short_description"]}}}},"responses":{"200":{"description":"the created incident","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","example":{"config":"SystemX","partnerId":"SystemX","server_system_time":"2020-10-24T06:23:41.089Z"}},"message":{"type":"string","example":"Incident 00000000000000000000000000000001 created."},"data":{"type":"object","example":{"incidentId":"6d101e0487e3ca903ef00000000000","number":"INC0000001","channel":"vendor","partnerIncidentId":"1234567890","description":"Some problem with something","short_description":"There is a complicated problem with the incident rest api - HELP!","state":1,"opened_at":"1997-09-08T05:55:00Z","sys_updated_on":"2024-07-17T14:36:59Z","opened_by":{"first_name":"Example","last_name":"Name","user_name":"example_name"},"assignment_group":{"description":"Example group","name":"Example groupname"},"location":{"city":"Bern","cmn_location_type":"room","country":"Switzerland","full_name":"CH/Bern/Viktoriastrasse 21/Viktoriastrasse 21/1.UG/001","name":"001"},"causing_ci":{"asset_tag":"123456789","model_id":{"display_name":"Lenovo ThinkPad P16 Gen1","name":"ThinkPad P16 Gen1","sys_id":"70a44cbf87f739d06d000000000000"},"name":"example hostname","operational_status":1,"serial_number":"ABCD12345","sys_id":"acba0c3f87ff75503ef0000000000000"},"attachments":[{"filename":"thisIsAFileName.pdf","content_type":"application/pdf","download_url":"https://<MyIT-url>/sys_attachment.do?sys_id=12f0297d87544e12334567890000000","sys_id":"12f0297d87544e12334567890000000"},{"filename":"picture_of_the_problem.png","content_type":"image/png","download_url":"https://<MyIT-url>/sys_attachment.do?sys_id=12f0297d87544e12334567890000001","sys_id":"12f0297d87544e12334567890000001"}]}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"MyItRestException"},"message":{"type":"string","example":"'partnerId' not specified"},"status":{"type":"integer","example":400}}}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":{"message":"User Not Authenticated","detail":"Required to provide Auth information"}},"status":{"type":"string","example":"failure"}}}}}},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"MyItRestException"},"message":{"type":"string","example":"The action failed due to a business rule. Message: [\"short_description is mandatory.\",\"partnerIncidentId is mandatory.\"]"},"status":{"type":"integer","example":500}}}}}}}},"get":{"summary":"fetch an existing incident","description":"Requires 'partnerId' AND either 'incidentId' OR 'partnerIncidentId' and returns the corresponding incident.","parameters":[{"name":"partnerId","in":"query","required":true,"description":"The id of the partner system, to be agreed upon with the MyIT team.","example":"SystemX","schema":{"type":"string"}},{"name":"incidentId","in":"query","required":true,"description":"The MyIT-internal id of the incident.","example":"6d101e0487e3ca903ef00000000000","schema":{"type":"string"}},{"name":"partnerIncidentId","in":"query","required":true,"description":"your internal id of the incident, for your reference.  Note that this must be unique. Once an incident is closed however - the id is freed up again.","example":"1234567890","schema":{"type":"string"}}],"responses":{"200":{"description":"the incident corresponding to the incidentId or partnerIncidentId.","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","example":{"config":"SystemX","partnerId":"SystemX","server_system_time":"2020-10-24T06:23:41.089Z"}},"data":{"type":"object","example":{"incidentId":"6d101e0487e3ca903ef00000000000","number":"INC0000001","partnerIncidentId":"12345","short_description":"descriptive text","state":1,"opened_at":"1997-09-08T05:55:00Z","sys_updated_on":"2024-07-17T14:36:59Z","u_current_workplace":"workplace 123","opened_by":{"first_name":"Example","last_name":"Name","user_name":"example_name"},"assignment_group":{"description":"Example group","name":"Example groupname"},"causing_ci":{"asset_tag":"123456789","model_id":{"display_name":"Lenovo ThinkPad P16 Gen1","name":"ThinkPad P16 Gen1","sys_id":"70a44cbf87f739d06d000000000000"},"name":"example hostname","operational_status":1,"serial_number":"ABCD12345","sys_id":"acba0c3f87ff75503ef0000000000000"},"attachments":[{"filename":"thisIsAFileName.pdf","content_type":"application/pdf","download_url":"https://<MyIT-url>/sys_attachment.do?sys_id=12f0297d87544e12334567890000000","sys_id":"12f0297d87544e12334567890000000"}]}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":"MyItRestException"},"message":{"type":"string","example":"'partnerId' not specified"},"status":{"type":"integer","example":400}}}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":{"message":"User Not Authenticated","detail":"Required to provide Auth information"}},"status":{"type":"string","example":"failure"}}}}}}}},"patch":{"summary":"update an incident","description":"updates an incident that already exists in myIT. 'partnerId' AND 'incidentId' OR 'partnerIncidentId' must either be in the body or the query params.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"description":"the id of the partner system, agreed upon with the MyIT team.","example":"SystemX","type":"string"},"incidentId":{"description":"The MyIT-internal id of the incident.","example":"43c569a98771f5106dc8630000000000","type":"string"},"partnerIncidentId":{"description":"your internal id of the incident, for your reference.  Note that this must be unique. Once an incident is closed however - the id is freed up again.","example":"1234567890","type":"string"},"short_description":{"type":"string","description":"example field to update","example":"this is an updated description of the problem"}},"required":["partnerId","incidentId","partnerIncidentId"]}}}},"responses":{"200":{"description":"the updated incident","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","example":{"config":"SystemX","partnerId":"SystemX","server_system_time":"2020-10-24T06:23:41.089Z"}},"message":{"type":"string","example":"Incident 43c569a98771f5106dc8630000000000 updated."},"data":{"type":"object","example":{"incidentId":"6d101e0487e3ca903ef00000000000","number":"INC0000001","partnerIncidentId":"1234567890","short_description":"this is an updated description of the problem","state":1,"opened_at":"1997-09-08T05:55:00Z","sys_updated_on":"2024-07-17T14:36:59Z","opened_by":{"first_name":"Example","last_name":"Name","user_name":"example_name"},"assignment_group":{"description":"Example group","name":"Example groupname"},"causing_ci":{"asset_tag":"123456789","model_id":{"display_name":"Lenovo ThinkPad P16 Gen1","name":"ThinkPad P16 Gen1","sys_id":"70a44cbf87f739d06d000000000000"},"name":"example hostname","operational_status":1,"serial_number":"ABCD12345","sys_id":"acba0c3f87ff75503ef0000000000000"},"attachments":[{"filename":"thisIsAFileName.pdf","content_type":"application/pdf","download_url":"https://<MyIT-url>/sys_attachment.do?sys_id=12f0297d87544e12334567890000000","sys_id":"12f0297d87544e12334567890000000"}]}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"MyItRestException"},"message":{"type":"string","example":"'partnerId' not specified"},"status":{"type":"integer","example":400}}}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":{"message":"User Not Authenticated","detail":"Required to provide Auth information"}},"status":{"type":"string","example":"failure"}}}}}}}}},"/incident/addAttachment":{"patch":{"summary":"add attachments","description":"adds attachments to an incident that already exists in myIT. 'partnerId' AND either 'incidentId' OR 'partnerIncidentId' must either be in the body or the query params. Any attachments must be base64 encoded.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"description":"the id of the partner system, agreed upon with the MyIT team.","example":"SystemX","type":"string"},"incidentId":{"description":"The MyIT-internal id of the incident.","example":"6d101e0487e3ca903ef00000000000","type":"string"},"partnerIncidentId":{"description":"your internal id of the incident, for your reference.  Note that this must be unique. Once an incident is closed however - the id is freed up again.","example":"1234567890","type":"string"},"attachments":{"description":"any attachments you'd like to add to the incident. The content must be base64 encoded.","type":"array","items":{"type":"object","properties":{"fileName":{"description":"the name of the file","example":"picture_of_the_problem.png","type":"string"},"content_type":{"description":"the mime type of the file","example":"image/png","type":"string"},"content":{"type":"string","description":"the content of the file in base64","example":"c25lYWt5","format":"byte"}}}}}}}}},"responses":{"200":{"description":"the updated incident","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","example":{"Caveat":"THIS IS PRE-ALPHA CODE AND SUBJECT TO CHANGE AT ANY TIM(E)!","git":"IncidentRestApi-0.0.1+70-dd86b01-dirty","build":"2023-10-24T14:54:24.706Z","config":"systemId","partnerId":"systemId","server_system_time":"2023-10-27T07:02:46.583Z"}},"message":{"type":"string","example":"Attachment(s) added to Incident 43c569a98771f5106dc8630000000000."},"data":{"type":"object","example":{"number":"INC0000001","short_description":"short description","priority":4,"opened_by:":{"active":true,"sys_class_name":"sys_user","sys_id":"a6fb235587fc71503efcec000000000"},"severity":3,"opened_at":"2023-10-10T07:22:04Z","category":"service_request","incident_id":"43c569a98771f5106dc8630000000000","class":"incident","attachments":[{"filename":"thisIsAFileName.txt","content_type":"application/json","download_url":"https://<MyIT-url>/sys_attachment.do?sys_id=af0192da874481234567890123456789","sys_id":"af0192da874481234567890123456789"}]}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"MyItRestException"},"message":{"type":"string","example":"content of attachment thisIsAFileName.txt is not valid base64."},"status":{"type":"integer","example":400}}}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":{"message":"User Not Authenticated","detail":"Required to provide Auth information"}},"status":{"type":"string","example":"failure"}}}}}}}}},"/incident/addWorknote":{"patch":{"summary":"add a worknote","description":"adds a worknote to an incident that already exists in myIT. PartnerId AND either IncidentId OR partnerIncidentId must either be in the body or the query params.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"type":"string"},"incidentId":{"type":"string"},"partnerIncidentId":{"type":"string"},"worknote":{"type":"string"}}}}}},"responses":{"200":{"description":"the updated incident","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","example":{"Caveat":"THIS IS PRE-ALPHA CODE AND SUBJECT TO CHANGE AT ANY TIM(E)!","git":"IncidentRestApi-0.0.1+70-dd86b01-dirty","build":"2023-10-24T14:54:24.706Z","config":"systemId","partnerId":"systemId","server_system_time":"2023-10-27T07:02:46.583Z"}},"message":{"type":"string","example":"Worknote added to incident 43c569a98771f5106dc8630000000000."},"data":{"type":"object","example":{"number":"INC0000001","short_description":"short description","priority":4,"opened_by:":{"active":true,"sys_class_name":"sys_user","sys_id":"a6fb235587fc71503efcec000000000"},"severity":3,"opened_at":"2023-10-10T07:22:04Z","category":"service_request","incident_id":"43c569a98771f5106dc8630000000000","class":"incident","worknotes":[{"sys_id":"ta6fb235587fc71503efcec000000123","sys_created_by":"admin.user","sys_created_on":"2024-01-24T06:29:35Z","value":"worknote detailing progress on incident\r\nTest"}]}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"MyItRestException"},"message":{"type":"string","example":"No worknote found in request body."},"status":{"type":"integer","example":400}}}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":{"message":"User Not Authenticated","detail":"Required to provide Auth information"}},"status":{"type":"string","example":"failure"}}}}}}}}},"/incident/addComment":{"patch":{"summary":"add a comment","description":"adds a comment to an incident that already exists in myIT. 'partnerId' AND either 'incidentId' OR 'partnerIncidentId' must either be in the body or the query params.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"type":"string"},"incidentId":{"type":"string"},"partnerIncidentId":{"type":"string"},"comment":{"type":"string"}}}}}},"responses":{"200":{"description":"the updated incident","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","example":{"Caveat":"THIS IS PRE-ALPHA CODE AND SUBJECT TO CHANGE AT ANY TIM(E)!","git":"IncidentRestApi-0.0.1+70-dd86b01-dirty","build":"2023-10-24T14:54:24.706Z","config":"systemId","partnerId":"systemId","server_system_time":"2023-10-27T07:02:46.583Z"}},"message":{"type":"string","example":"Comment added to incident 43c569a98771f5106dc8630000000000."},"data":{"type":"object","example":{"number":"INC0000001","short_description":"short description","priority":4,"opened_by:":{"active":true,"sys_class_name":"sys_user","sys_id":"a6fb235587fc71503efcec000000000"},"severity":3,"opened_at":"2023-10-10T07:22:04Z","category":"service_request","incident_id":"43c569a98771f5106dc8630000000000","class":"incident","comments":[{"sys_id":"ta6fb235587fc71503efcec000000123","sys_created_by":"admin.user","sys_created_on":"2024-01-24T06:29:35Z","value":"Customer-facing comment, detailing progress on incident\r\nTest"}]}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"MyItRestException"},"message":{"type":"string","example":"comment must be of type string."},"status":{"type":"integer","example":400}}}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":{"message":"User Not Authenticated","detail":"Required to provide Auth information"}},"status":{"type":"string","example":"failure"}}}}}}}}},"/incident/resolve":{"patch":{"summary":"resolve an incident","description":"resolves an incident in myIT. Requires a worknote. PartnerId AND either IncidentId OR partnerIncidentId must either be in the body or the query params.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"type":"string"},"incidentId":{"type":"string"},"partnerIncidentId":{"type":"string"},"worknote":{"type":"string"}},"required":["partnerId","incidentId","partnerIncidentId","worknote"]}}}},"responses":{"200":{"description":"the resolved incident","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","example":{"Caveat":"THIS IS PRE-ALPHA CODE AND SUBJECT TO CHANGE AT ANY TIM(E)!","git":"IncidentRestApi-0.0.1+70-dd86b01-dirty","build":"2023-10-24T14:54:24.706Z","config":"systemId","partnerId":"systemId","server_system_time":"2023-10-27T07:02:46.583Z"}},"message":{"type":"string","example":"Incident 43c569a98771f5106dc8630000000000 resolved."},"data":{"type":"object","example":{"number":"INC0000001","short_description":"short description","priority":4,"opened_by:":{"active":true,"sys_class_name":"sys_user","sys_id":"a6fb235587fc71503efcec000000000"},"severity":3,"opened_at":"2023-10-10T07:22:04Z","category":"service_request","incident_id":"43c569a98771f5106dc8630000000000","class":"incident","worknotes":[{"sys_id":"ta6fb235587fc71503efcec000000123","sys_created_by":"admin.user","sys_created_on":"2024-01-24T06:29:35Z","value":"reason for reopening incident\r\nTest"}]}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"MyItRestException"},"message":{"type":"string","example":"No worknote found in request body."},"status":{"type":"integer","example":400}}}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":{"message":"User Not Authenticated","detail":"Required to provide Auth information"}},"status":{"type":"string","example":"failure"}}}}}}}}},"/incident/reopen":{"patch":{"summary":"reopen an incident","description":"Reopens an incident in myIT that has status 'resolved'. Requires a worknote. PartnerId AND either IncidentId OR partnerIncidentId must either be in the body or the query params.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"type":"string"},"incidentId":{"type":"string"},"partnerIncidentId":{"type":"string"},"worknote":{"type":"string"}},"required":["partnerId","incidentId","partnerIncidentId","worknote"]}}}},"responses":{"200":{"description":"the reopened incident","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","example":{"Caveat":"THIS IS PRE-ALPHA CODE AND SUBJECT TO CHANGE AT ANY TIM(E)!","git":"IncidentRestApi-0.0.1+70-dd86b01-dirty","build":"2023-10-24T14:54:24.706Z","config":"systemId","partnerId":"systemId","server_system_time":"2023-10-27T07:02:46.583Z"}},"message":{"type":"string","example":"Incident 43c569a98771f5106dc8630000000000 reopened."},"data":{"type":"object","example":{"number":"INC0000001","short_description":"short description","priority":4,"opened_by:":{"active":true,"sys_class_name":"sys_user","sys_id":"a6fb235587fc71503efcec000000000"},"severity":3,"opened_at":"2023-10-10T07:22:04Z","category":"service_request","incident_id":"43c569a98771f5106dc8630000000000","class":"incident","worknotes":[{"sys_id":"ta6fb235587fc71503efcec000000123","sys_created_by":"admin.user","sys_created_on":"2024-01-24T06:29:35Z","value":"reason for reopening incident\r\nTest"}]}}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"MyItRestException"},"message":{"type":"string","example":"No worknote found in request body."},"status":{"type":"integer","example":400}}}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","example":{"message":"User Not Authenticated","detail":"Required to provide Auth information"}},"status":{"type":"string","example":"failure"}}}}}}}}},"/callback":{"post":{"summary":"Notification via POST request","description":"Sends a POST request to the partner's callback URL when an incident changes containing the complete incident.","requestBody":{"description":"The incident data sent to the callback URL.","content":{"application/json":{"schema":{"type":"object","properties":{"metaData":{"type":"string","example":"The incident has changed. This is the newest state:"},"number":{"type":"string","example":"INC0000001"},"time_worked":{"type":"string","example":"1970-01-01 01:54:46"},"short_description":{"type":"string","example":"update"},"priority":{"type":"number","example":1},"severity":{"type":"number","example":2},"opened_at":{"type":"string","example":"2023-11-23T09:16:47Z"},"category":{"type":"string","example":"service_request"},"incident_id":{"type":"string","example":"f806607f87a6f9d03efcec0000000000"},"class":{"type":"string","example":"incident"}}}}}},"responses":{"200":{"description":"Callback request description. Actual response handling is managed by the receiving system."},"default":{"description":"General response. Actual response handling is managed by the receiving system."}}},"get":{"summary":"Notification via GET request","description":"Sends a GET request to the partner's callback URL with incidentId and callbackUrl as query parameters when an incident changes. This URL can be queried with GET to then receive the changed incident.","parameters":[{"name":"incidentId","in":"query","description":"The ID of the incident that changed.","schema":{"type":"string","example":"f806607f87a6f9d03efcec0000000000"}},{"name":"callbackUrl","in":"query","description":"The readymade URL leading to the changed incident.","schema":{"type":"string","example":"https://<MyIT-url>/api/x_ssagd_inc_rest/rest/incident?partnerId=systemX&incidentId=f806607f87a6f9d03efcec0000000000"}}],"responses":{"200":{"description":"Callback request description. Actual response handling is managed by the receiving system."},"default":{"description":"General response. Actual response handling is managed by the receiving system."}}}}},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}}}},"searchIndex":{"store":["/paths/~1incident/post","/paths/~1incident/get","/paths/~1incident/patch","/paths/~1incident~1addAttachment/patch","/paths/~1incident~1addWorknote/patch","/paths/~1incident~1addComment/patch","/paths/~1incident~1resolve/patch","/paths/~1incident~1reopen/patch","/paths/~1callback/post","/paths/~1callback/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,1.37,1,1.37,2,0.236]],["description/0",[0,1.803,1,1.803,2,0.442,3,0.466,4,1.803]],["title/1",[2,0.236,5,1.842,6,0.641]],["description/1",[2,0.389,4,1.733,7,1.34,8,0.448,9,0.302,10,0.448,11,2.331]],["title/2",[2,0.278,12,1.614]],["description/2",[2,0.354,3,0.388,6,0.702,8,0.388,9,0.261,10,0.388,12,1.501,13,0.906,14,0.533,15,0.388,16,0.533]],["title/3",[17,0.573,18,1.614]],["description/3",[2,0.228,3,0.342,6,0.62,8,0.342,9,0.23,10,0.342,13,0.799,14,0.47,15,0.342,16,0.47,17,0.47,18,1.883,19,1.781,20,1.781,21,1.781]],["title/4",[17,0.573,22,0.973]],["description/4",[2,0.25,3,0.376,6,0.68,8,0.376,9,0.253,10,0.376,13,0.876,14,0.516,15,0.376,16,0.516,17,0.516,22,0.876,23,1.954]],["title/5",[17,0.573,24,1.614]],["description/5",[2,0.25,3,0.376,6,0.68,8,0.376,9,0.253,10,0.376,13,0.876,14,0.516,15,0.376,16,0.516,17,0.516,24,1.453,25,1.954]],["title/6",[2,0.278,26,1.247]],["description/6",[2,0.258,3,0.388,7,1.16,8,0.388,9,0.261,10,0.388,14,0.533,15,0.388,16,0.533,22,0.906,26,1.16,27,2.019]],["title/7",[2,0.278,28,1.614]],["description/7",[2,0.242,3,0.364,7,1.088,8,0.364,9,0.245,10,0.364,14,0.5,15,0.364,16,0.5,22,0.849,26,1.088,28,1.407,29,1.893,30,1.893]],["title/8",[31,1.19,32,1.19,33,1.19,34,0.718]],["description/8",[2,0.354,33,1.501,34,0.906,35,1.501,36,1.501,37,2.056,38,1.501,39,1.501,40,2.019,41,2.019]],["title/9",[31,1.37,32,1.37,34,0.826]],["description/9",[2,0.317,9,0.224,15,0.477,34,0.776,35,1.286,36,1.286,37,1.845,38,1.845,39,1.845,42,1.73,43,1.73,44,1.73]]],"invertedIndex":[["add",{"_index":17,"title":{"3":{},"4":{},"5":{}},"description":{"3":{},"4":{},"5":{}}}],["alreadi",{"_index":13,"title":{},"description":{"2":{},"3":{},"4":{},"5":{}}}],["attach",{"_index":18,"title":{"3":{}},"description":{"3":{}}}],["base64",{"_index":19,"title":{},"description":{"3":{}}}],["bodi",{"_index":14,"title":{},"description":{"2":{},"3":{},"4":{},"5":{},"6":{},"7":{}}}],["callback",{"_index":37,"title":{},"description":{"8":{},"9":{}}}],["callbackurl",{"_index":42,"title":{},"description":{"9":{}}}],["chang",{"_index":39,"title":{},"description":{"8":{},"9":{}}}],["comment",{"_index":24,"title":{"5":{}},"description":{"5":{}}}],["complet",{"_index":41,"title":{},"description":{"8":{}}}],["contain",{"_index":40,"title":{},"description":{"8":{}}}],["correspond",{"_index":11,"title":{},"description":{"1":{}}}],["creat",{"_index":0,"title":{"0":{}},"description":{"0":{}}}],["encod",{"_index":20,"title":{},"description":{"3":{}}}],["exist",{"_index":6,"title":{"1":{}},"description":{"2":{},"3":{},"4":{},"5":{}}}],["fetch",{"_index":5,"title":{"1":{}},"description":{}}],["incid",{"_index":2,"title":{"0":{},"1":{},"2":{},"6":{},"7":{}},"description":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{}}}],["incident/addattach",{"_index":21,"title":{},"description":{"3":{}}}],["incident/addcom",{"_index":25,"title":{},"description":{"5":{}}}],["incident/addworknot",{"_index":23,"title":{},"description":{"4":{}}}],["incident/reopen",{"_index":30,"title":{},"description":{"7":{}}}],["incident/resolv",{"_index":27,"title":{},"description":{"6":{}}}],["incidentid",{"_index":9,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"9":{}}}],["myit",{"_index":3,"title":{},"description":{"0":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{}}}],["new",{"_index":1,"title":{"0":{}},"description":{"0":{}}}],["notif",{"_index":31,"title":{"8":{},"9":{}},"description":{}}],["param",{"_index":16,"title":{},"description":{"2":{},"3":{},"4":{},"5":{},"6":{},"7":{}}}],["paramet",{"_index":43,"title":{},"description":{"9":{}}}],["partner'",{"_index":36,"title":{},"description":{"8":{},"9":{}}}],["partnerid",{"_index":8,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{}}}],["partnerincidentid",{"_index":10,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{}}}],["post",{"_index":33,"title":{"8":{}},"description":{"8":{}}}],["queri",{"_index":15,"title":{},"description":{"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"9":{}}}],["receiv",{"_index":44,"title":{},"description":{"9":{}}}],["reopen",{"_index":28,"title":{"7":{}},"description":{"7":{}}}],["request",{"_index":34,"title":{"8":{},"9":{}},"description":{"8":{},"9":{}}}],["requir",{"_index":7,"title":{},"description":{"1":{},"6":{},"7":{}}}],["resolv",{"_index":26,"title":{"6":{}},"description":{"6":{},"7":{}}}],["return",{"_index":4,"title":{},"description":{"0":{},"1":{}}}],["send",{"_index":35,"title":{},"description":{"8":{},"9":{}}}],["statu",{"_index":29,"title":{},"description":{"7":{}}}],["updat",{"_index":12,"title":{"2":{}},"description":{"2":{}}}],["url",{"_index":38,"title":{},"description":{"8":{},"9":{}}}],["via",{"_index":32,"title":{"8":{},"9":{}},"description":{}}],["worknot",{"_index":22,"title":{"4":{}},"description":{"4":{},"6":{},"7":{}}}]],"pipeline":[]}},"options":{}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);
diff --git a/incidentRestAPI.yml b/incidentRestAPI.yml
index dc6ba30..8213602 100644
--- a/incidentRestAPI.yml
+++ b/incidentRestAPI.yml
@@ -1,7 +1,16 @@
 openapi: '3.0.2'
 info:
   title: Incident REST API
-  description: handles communication between the MyIT incident system and partner systems.
+  description: |
+    Handles communication between the MyIT incident system and partner systems.
+    
+    **State values:**
+    - New: 1
+    - In progress: 2
+    - On hold: 3
+    - Resolved: 6
+    - Closed: 7
+    - Cancelled: 8
   version: '1.0.0'
 
 servers:
