{"id":36576,"date":"2025-08-13T11:11:08","date_gmt":"2025-08-13T09:11:08","guid":{"rendered":"https:\/\/pomoc.comarch.pl\/cee\/640\/?post_type=ht_kb&#038;p=36576"},"modified":"2025-08-13T13:03:42","modified_gmt":"2025-08-13T11:03:42","slug":"wprowadzenie-interfejsow-rest-api-w-cee","status":"publish","type":"ht_kb","link":"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/documentation\/wprowadzenie-interfejsow-rest-api-w-cee\/","title":{"rendered":"Wprowadzenie interfejs\u00f3w REST API w CEE"},"content":{"rendered":"<div id=\"ez-toc-container\" class=\"ez-toc-v2_0_82_2 ez-toc-wrap-left counter-hierarchy ez-toc-counter ez-toc-custom ez-toc-container-direction\">\n<div class=\"ez-toc-title-container\">\n<p class=\"ez-toc-title\" style=\"cursor:inherit\">Spis tre\u015bci<\/p>\n<span class=\"ez-toc-title-toggle\"><a href=\"#\" class=\"ez-toc-pull-right ez-toc-btn ez-toc-btn-xs ez-toc-btn-default ez-toc-toggle\" aria-label=\"Prze\u0142\u0105cznik Spisu Tre\u015bci\"><span class=\"ez-toc-js-icon-con\"><span class=\"\"><span class=\"eztoc-hide\" style=\"display:none;\">Toggle<\/span><span class=\"ez-toc-icon-toggle-span\"><svg style=\"fill: #999;color:#999\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" class=\"list-377408\" width=\"20px\" height=\"20px\" viewBox=\"0 0 24 24\" fill=\"none\"><path d=\"M6 6H4v2h2V6zm14 0H8v2h12V6zM4 11h2v2H4v-2zm16 0H8v2h12v-2zM4 16h2v2H4v-2zm16 0H8v2h12v-2z\" fill=\"currentColor\"><\/path><\/svg><svg style=\"fill: #999;color:#999\" class=\"arrow-unsorted-368013\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"10px\" height=\"10px\" viewBox=\"0 0 24 24\" version=\"1.2\" baseProfile=\"tiny\"><path d=\"M18.2 9.3l-6.2-6.3-6.2 6.3c-.2.2-.3.4-.3.7s.1.5.3.7c.2.2.4.3.7.3h11c.3 0 .5-.1.7-.3.2-.2.3-.5.3-.7s-.1-.5-.3-.7zM5.8 14.7l6.2 6.3 6.2-6.3c.2-.2.3-.5.3-.7s-.1-.5-.3-.7c-.2-.2-.4-.3-.7-.3h-11c-.3 0-.5.1-.7.3-.2.2-.3.5-.3.7s.1.5.3.7z\"\/><\/svg><\/span><\/span><\/span><\/a><\/span><\/div>\n<nav><ul class='ez-toc-list ez-toc-list-level-1 ' ><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-1\" href=\"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/documentation\/wprowadzenie-interfejsow-rest-api-w-cee\/#Wprowadzone_interfejsy\" >Wprowadzone interfejsy<\/a><ul class='ez-toc-list-level-4' ><li class='ez-toc-heading-level-4'><a class=\"ez-toc-link ez-toc-heading-2\" href=\"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/documentation\/wprowadzenie-interfejsow-rest-api-w-cee\/#Swagger_Service\" >Swagger Service<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-4'><a class=\"ez-toc-link ez-toc-heading-3\" href=\"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/documentation\/wprowadzenie-interfejsow-rest-api-w-cee\/#Swagger_UI\" >Swagger UI<\/a><\/li><\/ul><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-4\" href=\"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/documentation\/wprowadzenie-interfejsow-rest-api-w-cee\/#Wyswietlane_endpointy\" >Wy\u015bwietlane endpointy<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-5\" href=\"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/documentation\/wprowadzenie-interfejsow-rest-api-w-cee\/#Struktura\" >Struktura<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-6\" href=\"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/documentation\/wprowadzenie-interfejsow-rest-api-w-cee\/#Endpointy_API\" >Endpointy API<\/a><ul class='ez-toc-list-level-4' ><li class='ez-toc-heading-level-4'><a class=\"ez-toc-link ez-toc-heading-7\" href=\"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/documentation\/wprowadzenie-interfejsow-rest-api-w-cee\/#Sciezka_zapytania\" >\u015acie\u017cka zapytania<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-4'><a class=\"ez-toc-link ez-toc-heading-8\" href=\"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/documentation\/wprowadzenie-interfejsow-rest-api-w-cee\/#Parametry_zapytania\" >Parametry zapytania<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-4'><a class=\"ez-toc-link ez-toc-heading-9\" href=\"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/documentation\/wprowadzenie-interfejsow-rest-api-w-cee\/#Tresc_zapytania\" >Tre\u015b\u0107 zapytania<\/a><\/li><\/ul><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-10\" href=\"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/documentation\/wprowadzenie-interfejsow-rest-api-w-cee\/#Format_tresci_odpowiedzi\" >Format tre\u015bci odpowiedzi<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-11\" href=\"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/documentation\/wprowadzenie-interfejsow-rest-api-w-cee\/#Schematy\" >Schematy\u00a0<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-12\" href=\"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/documentation\/wprowadzenie-interfejsow-rest-api-w-cee\/#Wymagane_uprawnienia\" >Wymagane uprawnienia<\/a><\/li><\/ul><\/nav><\/div>\n<p data-start=\"45\" data-end=\"136\">Aby umo\u017cliwi\u0107 generowanie i wy\u015bwietlanie REST API w CEE, wprowadzono dwa nowe interfejsy:<\/p>\n<ul data-start=\"138\" data-end=\"180\">\n<li data-start=\"138\" data-end=\"161\">\n<p data-start=\"140\" data-end=\"161\">Swagger Service<\/p>\n<\/li>\n<li data-start=\"138\" data-end=\"161\">\n<p data-start=\"140\" data-end=\"161\"><span style=\"font-size: revert; color: initial;\">Swagger UI<br \/><\/span><\/p>\n<\/li>\n<\/ul>\n<h3 id=\"wprowadzone-interfejsy\" ><span class=\"ez-toc-section\" id=\"Wprowadzone_interfejsy\"><\/span><span style=\"font-size: revert; color: initial;\"><span style=\"color: revert; font-size: revert; font-weight: revert;\">Wprowadzone interfejsy<\/span><br \/><\/span><span class=\"ez-toc-section-end\"><\/span><\/h3>\n<h4 data-start=\"215\" data-end=\"235\" id=\"swagger-service\" ><span class=\"ez-toc-section\" id=\"Swagger_Service\"><\/span><strong>Swagger Service<\/strong><span class=\"ez-toc-section-end\"><\/span><\/h4>\n<p>Us\u0142uga sieciowa z endpointem do generowania pliku swagger.json, dost\u0119pna pod \u015bcie\u017ck\u0105:<\/p>\n<p>&#8222;\/services\/rest\/com.cisag.sys.tools.swagger.rest.SwaggerService\/swagger&#8221;\u00a0<\/p>\n<ul>\n<li>Endpoint zwraca dokumentacj\u0119 wszystkich dost\u0119pnych endpoint\u00f3w REST API w formacie okre\u015blonym przez specyfikacj\u0119 <a href=\"https:\/\/swagger.io\/specification\/\">OpenAPI<\/a>.<\/li>\n<\/ul>\n<h4 data-start=\"543\" data-end=\"558\" id=\"swagger-ui\" ><span class=\"ez-toc-section\" id=\"Swagger_UI\"><\/span>Swagger UI<span class=\"ez-toc-section-end\"><\/span><\/h4>\n<p>Aplikacja internetowa dost\u0119pna pod \u015bcie\u017ck\u0105:<\/p>\n<p>\/swagger<\/p>\n<p>Aplikacja pobiera dokumentacj\u0119 w formacie JSON z Swagger Service i wy\u015bwietla j\u0105 w formie graficznej.<\/p>\n<figure id=\"attachment_36479\" aria-describedby=\"caption-attachment-36479\" style=\"width: 1533px\" class=\"wp-caption alignnone\"><a href=\"https:\/\/pomoc.comarch.pl\/cee\/wp-content\/uploads\/2025\/08\/Swagger1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"wp-image-36479 size-full\" src=\"https:\/\/pomoc.comarch.pl\/cee\/wp-content\/uploads\/2025\/08\/Swagger1.png\" alt=\"\" width=\"1533\" height=\"641\" srcset=\"https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Swagger1.png 1533w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Swagger1-300x125.png 300w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Swagger1-1024x428.png 1024w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Swagger1-768x321.png 768w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Swagger1-50x21.png 50w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Swagger1-920x385.png 920w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Swagger1-600x251.png 600w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Swagger1-320x134.png 320w\" sizes=\"auto, (max-width: 1533px) 100vw, 1533px\" \/><\/a><figcaption id=\"caption-attachment-36479\" class=\"wp-caption-text\">Przyk\u0142adowa dokumentacja Swagger<\/figcaption><\/figure>\n<h3 id=\"wyswietlane-endpointy\" ><span class=\"ez-toc-section\" id=\"Wyswietlane_endpointy\"><\/span>Wy\u015bwietlane endpointy<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>Do wygenerowanej dokumentacji w\u0142\u0105czane s\u0105 wszystkie endpointy, kt\u00f3re wyst\u0119puj\u0105 w aplikacjach z kategorii <em>Web Service<\/em>, z okre\u015blonym specjalnym przeznaczeniem <em>REST Service<\/em>.<\/p>\n<section class=\"document-alert-box warning\"><div class=\"document-alert-title\">Uwaga<\/div><div class=\"document-alert-content\">Swagger nie dokumentuje punkt\u00f3w BIS ani innych automatycznie generowanych endpoint\u00f3w.<\/div><\/section>\n<h3 data-start=\"1042\" data-end=\"1055\" id=\"struktura\" ><span class=\"ez-toc-section\" id=\"Struktura\"><\/span>Struktura<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>Sekcja Servers zawiera list\u0119 adres\u00f3w serwer\u00f3w u\u017cywanych jako prefiksy do wysy\u0142ania zapyta\u0144 przez Swagger API.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter size-full wp-image-36615\" src=\"https:\/\/pomoc.comarch.pl\/cee\/wp-content\/uploads\/2025\/08\/Swaggera.png\" alt=\"\" width=\"746\" height=\"146\" srcset=\"https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Swaggera.png 746w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Swaggera-300x59.png 300w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Swaggera-50x10.png 50w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Swaggera-600x117.png 600w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Swaggera-320x63.png 320w\" sizes=\"auto, (max-width: 746px) 100vw, 746px\" \/><br \/>W obecnej wersji ka\u017cdy adres serwera zawiera wbudowan\u0105 baz\u0119 danych OLTP, kt\u00f3ra obs\u0142uguje wysy\u0142ane zapytania.<\/p>\n<p><section class=\"document-alert-box warning\"><div class=\"document-alert-title\">Uwaga<\/div><div class=\"document-alert-content\">Przed wys\u0142aniem zapyta\u0144 nale\u017cy:<\/p>\n<ul>\n<li>uruchomi\u0107 aktywn\u0105 sesj\u0119 w danej bazie danych z poziomu Comarch ERP Enterprise UI<\/li>\n<li>w przypadku braku aktywnej sesji zwracany jest b\u0142\u0105d:<br \/><em data-start=\"1477\" data-end=\"1544\">Cannot set OLTP database for an existing session without database<\/em><\/div><\/section><\/li>\n<\/ul>\n<h3 data-start=\"1551\" data-end=\"1573\" id=\"endpointy-api\" ><span class=\"ez-toc-section\" id=\"Endpointy_API\"><\/span>Endpointy API<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>Endpointy REST s\u0105 pogrupowane wed\u0142ug swoich us\u0142ug. Ka\u017cdy punkt zawiera:<\/p>\n<ul data-start=\"1655\" data-end=\"1773\">\n<li data-start=\"1655\" data-end=\"1686\">\n<p data-start=\"1657\" data-end=\"1686\">wzgl\u0119dn\u0105 \u015bcie\u017ck\u0119 zapytania,<\/p>\n<\/li>\n<li data-start=\"1687\" data-end=\"1711\">\n<p data-start=\"1689\" data-end=\"1711\">parametry zapytania,<\/p>\n<\/li>\n<li data-start=\"1712\" data-end=\"1749\">\n<p data-start=\"1714\" data-end=\"1749\">tre\u015b\u0107 zapytania\u00a0<\/p>\n<\/li>\n<li data-start=\"1750\" data-end=\"1773\">\n<p data-start=\"1752\" data-end=\"1773\">mo\u017cliwe odpowiedzi<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter size-full wp-image-36616\" src=\"https:\/\/pomoc.comarch.pl\/cee\/wp-content\/uploads\/2025\/08\/swaggerb.png\" alt=\"\" width=\"1612\" height=\"970\" srcset=\"https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerb.png 1612w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerb-300x181.png 300w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerb-1024x616.png 1024w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerb-768x462.png 768w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerb-50x30.png 50w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerb-1536x924.png 1536w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerb-920x554.png 920w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerb-600x361.png 600w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerb-320x193.png 320w\" sizes=\"auto, (max-width: 1612px) 100vw, 1612px\" \/><\/p>\n<\/li>\n<\/ul>\n<h4 data-start=\"1775\" data-end=\"1797\" id=\"sciezka-zapytania\" ><span class=\"ez-toc-section\" id=\"Sciezka_zapytania\"><\/span>\u015acie\u017cka zapytania<span class=\"ez-toc-section-end\"><\/span><\/h4>\n<p>Reprezentuje wzgl\u0119dn\u0105 \u015bcie\u017ck\u0119 endpointu \u2013 jest po\u0142\u0105czeniem \u015bcie\u017cki us\u0142ugi i \u015bcie\u017cki endpointu.<\/p>\n<ul>\n<li>\/services\/rest\/com.cisag.sys.tools.swagger.rest.SwaggerService\/swagger\n<p><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter size-full wp-image-36622\" src=\"https:\/\/pomoc.comarch.pl\/cee\/wp-content\/uploads\/2025\/08\/swaggerc.png\" alt=\"\" width=\"1781\" height=\"235\" srcset=\"https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerc.png 1781w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerc-300x40.png 300w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerc-1024x135.png 1024w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerc-768x101.png 768w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerc-50x7.png 50w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerc-1536x203.png 1536w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerc-920x121.png 920w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerc-600x79.png 600w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerc-320x42.png 320w\" sizes=\"auto, (max-width: 1781px) 100vw, 1781px\" \/><\/p>\n<\/li>\n<\/ul>\n<h4 data-start=\"1995\" data-end=\"2019\" id=\"parametry-zapytania\" ><span class=\"ez-toc-section\" id=\"Parametry_zapytania\"><\/span>Parametry zapytania<span class=\"ez-toc-section-end\"><\/span><\/h4>\n<p data-start=\"2020\" data-end=\"2140\">Je\u017celi endpoint przyjmuje parametry, s\u0105 one wy\u015bwietlane w sekcji <em data-start=\"2090\" data-end=\"2102\">Parameters<\/em>. Dla ka\u017cdego parametru podawane s\u0105:<\/p>\n<ul data-start=\"2142\" data-end=\"2238\">\n<li data-start=\"2142\" data-end=\"2152\">\n<p data-start=\"2144\" data-end=\"2152\">nazwa,<\/p>\n<\/li>\n<li data-start=\"2153\" data-end=\"2161\">\n<p data-start=\"2155\" data-end=\"2161\">typ,<\/p>\n<\/li>\n<li data-start=\"2162\" data-end=\"2203\">\n<p data-start=\"2164\" data-end=\"2203\">\u017ar\u00f3d\u0142o (path, query, header, cookie),<\/p>\n<\/li>\n<li data-start=\"2204\" data-end=\"2238\">\n<p data-start=\"2206\" data-end=\"2238\">informacja, czy jest wymagany.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter size-full wp-image-36624\" src=\"https:\/\/pomoc.comarch.pl\/cee\/wp-content\/uploads\/2025\/08\/swaggerd.png\" alt=\"\" width=\"1782\" height=\"827\" srcset=\"https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerd.png 1782w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerd-300x139.png 300w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerd-1024x475.png 1024w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerd-768x356.png 768w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerd-50x23.png 50w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerd-1536x713.png 1536w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerd-920x427.png 920w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerd-600x278.png 600w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerd-320x149.png 320w\" sizes=\"auto, (max-width: 1782px) 100vw, 1782px\" \/><\/p>\n<\/li>\n<\/ul>\n<p data-start=\"2206\" data-end=\"2238\"><section class=\"document-alert-box example\"><div class=\"document-alert-title\">Przyk\u0142ad<\/div><div class=\"document-alert-content\">Obecnie w Swagger ka\u017cdy zadeklarowany parametr jest oznaczony jako wymagany.<\/div><\/section><\/p>\n<p data-start=\"2336\" data-end=\"2468\">Parametry nie wymagaj\u0105 dodatkowych adnotacji. Implementacja Swagger wykorzystuje adnotacje ju\u017c u\u017cywane w definicjach parametr\u00f3w w us\u0142ugach sieciowych.<\/p>\n<h4 data-start=\"2470\" data-end=\"2507\" id=\"tresc-zapytania\" ><span class=\"ez-toc-section\" id=\"Tresc_zapytania\"><\/span>Tre\u015b\u0107 zapytania<span class=\"ez-toc-section-end\"><\/span><\/h4>\n<p>Ta sekcja przedstawia struktur\u0119 i format tre\u015bci zapytania przekazywanego do endpointu<\/p>\n<ul>\n<li>Tre\u015b\u0107 zapytania nie wymaga dodatkowych adnotacji.<\/li>\n<li>Implementacja zawiera dodatkow\u0105 adnotacj\u0119: com.cisag.sys.tools.swagger.annotations.RequestBody, kt\u00f3ra mo\u017ce by\u0107 u\u017cyta do opisu tre\u015bci zapytania.<\/li>\n<li>Adnotacj\u0119 nale\u017cy stosowa\u0107 dla parametru reprezentuj\u0105cego tre\u015b\u0107 zapytania.<\/li>\n<\/ul>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter size-full wp-image-36625\" src=\"https:\/\/pomoc.comarch.pl\/cee\/wp-content\/uploads\/2025\/08\/rest-body.png\" alt=\"\" width=\"1816\" height=\"753\" srcset=\"https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/rest-body.png 1816w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/rest-body-300x124.png 300w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/rest-body-1024x425.png 1024w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/rest-body-768x318.png 768w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/rest-body-50x21.png 50w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/rest-body-1536x637.png 1536w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/rest-body-920x381.png 920w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/rest-body-600x249.png 600w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/rest-body-320x133.png 320w\" sizes=\"auto, (max-width: 1816px) 100vw, 1816px\" \/><\/p>\n<p><strong>Odpowiedzi<\/strong><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter size-full wp-image-36629\" src=\"https:\/\/pomoc.comarch.pl\/cee\/wp-content\/uploads\/2025\/08\/swaggere.png\" alt=\"\" width=\"1426\" height=\"859\" srcset=\"https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggere.png 1426w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggere-300x181.png 300w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggere-1024x617.png 1024w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggere-768x463.png 768w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggere-50x30.png 50w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggere-920x554.png 920w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggere-600x361.png 600w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggere-320x193.png 320w\" sizes=\"auto, (max-width: 1426px) 100vw, 1426px\" \/><br \/>Ta sekcja przedstawia mo\u017cliwe odpowiedzi, kt\u00f3re u\u017cytkownik mo\u017ce otrzyma\u0107 z endpointu.<br data-start=\"85\" data-end=\"88\" \/>Ka\u017cda odpowied\u017a musi zawiera\u0107:<\/p>\n<ul data-start=\"122\" data-end=\"151\">\n<li data-start=\"122\" data-end=\"141\">\n<p data-start=\"124\" data-end=\"141\">kod odpowiedzi,<\/p>\n<\/li>\n<li data-start=\"142\" data-end=\"151\">\n<p data-start=\"144\" data-end=\"151\">opis.<\/p>\n<\/li>\n<\/ul>\n<p data-start=\"153\" data-end=\"323\">Odpowied\u017a mo\u017ce r\u00f3wnie\u017c zawiera\u0107 przyk\u0142ad tre\u015bci odpowiedzi.<\/p>\n<p data-start=\"153\" data-end=\"323\">Definiowanie odpowiedzi, w tym dodanie przyk\u0142adu tre\u015bci, wymaga zdefiniowania w kodzie z u\u017cyciem dodatkowych adnotacji.<\/p>\n<p data-start=\"2913\" data-end=\"2938\"><strong data-start=\"2913\" data-end=\"2936\">Wymagane adnotacje:<\/strong><\/p>\n<p data-start=\"2913\" data-end=\"2938\"><em style=\"font-size: revert; color: initial;\">io.swagger.annotations.ApiResponses<\/em><span style=\"font-size: revert; color: initial;\"> &#8212; kontener wszystkich definicji odpowiedzi dla endpointu<\/span><\/p>\n<p><em>io.swagger.annotations.ApiResponse<\/em> &#8212; definicja pojedynczej odpowiedzi API<\/p>\n<p data-start=\"2913\" data-end=\"2938\">Wykorzystywane pola<strong><br \/><\/strong><\/p>\n<table style=\"width: 100.357%; height: 157px;\">\n<thead>\n<tr>\n<td scope=\"rowgroup\"><strong>Pole<\/strong><\/td>\n<td scope=\"rowgroup\"><strong>Typ<\/strong><\/td>\n<td scope=\"rowgroup\"><strong>Opis<\/strong><\/td>\n<td scope=\"rowgroup\"><strong>Wymagane\u00a0<\/strong><\/td>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td scope=\"rowgroup\">code<\/td>\n<td scope=\"rowgroup\">int<\/td>\n<td scope=\"rowgroup\">Kod odpowiedzi<\/td>\n<td scope=\"rowgroup\">Nie<\/td>\n<\/tr>\n<tr>\n<td scope=\"rowgroup\">message<\/td>\n<td scope=\"rowgroup\">string<\/td>\n<td scope=\"rowgroup\">Opis odpowiedzi<\/td>\n<td scope=\"rowgroup\">Nie<\/td>\n<\/tr>\n<tr>\n<td scope=\"rowgroup\">response<\/td>\n<td scope=\"rowgroup\">class<\/td>\n<td scope=\"rowgroup\">Typ tre\u015bci odpowiedzi<\/td>\n<td scope=\"rowgroup\">Tak<\/td>\n<\/tr>\n<tr>\n<td scope=\"rowgroup\">responseContainer<\/td>\n<td scope=\"rowgroup\">string<\/td>\n<td scope=\"rowgroup\">Kontener tre\u015bci odpowiedzi (warto\u015bci: Set, List)<\/td>\n<td scope=\"rowgroup\">Tak<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p data-start=\"2913\" data-end=\"2938\"><strong>\u00a0<\/strong><\/p>\n<p>Przyk\u0142ad u\u017cycia:<\/p>\n<div class=\"line number1 index0 alt2\" data-bidi-marker=\"true\"><section class=\"document-alert-box example\"><div class=\"document-alert-title\">Przyk\u0142ad<\/div><div class=\"document-alert-content\">@GET<br data-start=\"102\" data-end=\"105\" \/>@Path(&#8222;swagger&#8221;)<br data-start=\"121\" data-end=\"124\" \/>@ApiResponses({<br data-start=\"139\" data-end=\"142\" \/>\u2003\u2003@ApiResponse(code=200, message = <em data-start=\"177\" data-end=\"213\">Successful generation of json file<\/em>, response = Specification.class),<br data-start=\"247\" data-end=\"250\" \/>\u2003\u2003@ApiResponse(code=403, message = <em data-start=\"285\" data-end=\"308\">Not enough privileges<\/em>),<br data-start=\"310\" data-end=\"313\" \/>\u2003\u2003@ApiResponse(code=500, message = <em data-start=\"348\" data-end=\"387\">Error occurred during loading classes<\/em>)<br data-start=\"388\" data-end=\"391\" \/>})<br data-start=\"393\" data-end=\"396\" \/>@Produces(&#8222;application\/json&#8221;)<br data-start=\"425\" data-end=\"428\" \/>public Response exampleMethod(){<br data-start=\"460\" data-end=\"463\" \/>\u2003\u2003\/\/ Method definition<br data-start=\"485\" data-end=\"488\" \/>}<\/div><\/section><\/div>\n<h3 data-start=\"4230\" data-end=\"4258\" id=\"format-tresci-odpowiedzi\" ><span class=\"ez-toc-section\" id=\"Format_tresci_odpowiedzi\"><\/span>Format tre\u015bci odpowiedzi<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<ul>\n<li data-start=\"4259\" data-end=\"4384\">Przypisywany z adnotacji <em data-start=\"4483\" data-end=\"4505\">javax.ws.rs.Produces<\/em>.<\/li>\n<li data-start=\"4259\" data-end=\"4384\">Je\u015bli brak adnotacji, domy\u015blnie ustawiany jest format <em data-start=\"2141\" data-end=\"2159\">application\/json<\/em>.<\/li>\n<\/ul>\n<h3 data-start=\"4391\" data-end=\"4415\" id=\"schematy\" ><span class=\"ez-toc-section\" id=\"Schematy\"><\/span>Schematy\u00a0<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p data-start=\"4416\" data-end=\"4592\">Je\u017celi generator napotka obiekt z\u0142o\u017cony, jest on zapisywany jako obiekt schematu, a w innych miejscach odwo\u0142uje si\u0119 do niego przez referencj\u0119.<br data-start=\"4760\" data-end=\"4763\" \/>Obiekt schematu zawiera pe\u0142n\u0105 rekurencyjn\u0105 struktur\u0119 obiektu.<br data-start=\"4522\" data-end=\"4525\" \/>Oznaczenie [] przy typie pola (np. [string]) definiuje tablic\u0119.<img loading=\"lazy\" decoding=\"async\" class=\"aligncenter size-full wp-image-36632\" src=\"https:\/\/pomoc.comarch.pl\/cee\/wp-content\/uploads\/2025\/08\/Zrzut-ekranu-2025-07-25-140700.png\" alt=\"\" width=\"1635\" height=\"450\" srcset=\"https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Zrzut-ekranu-2025-07-25-140700.png 1635w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Zrzut-ekranu-2025-07-25-140700-300x83.png 300w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Zrzut-ekranu-2025-07-25-140700-1024x282.png 1024w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Zrzut-ekranu-2025-07-25-140700-768x211.png 768w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Zrzut-ekranu-2025-07-25-140700-50x14.png 50w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Zrzut-ekranu-2025-07-25-140700-1536x423.png 1536w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Zrzut-ekranu-2025-07-25-140700-920x253.png 920w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Zrzut-ekranu-2025-07-25-140700-600x165.png 600w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/Zrzut-ekranu-2025-07-25-140700-320x88.png 320w\" sizes=\"auto, (max-width: 1635px) 100vw, 1635px\" \/><br \/><strong>Tryb testowy\u00a0<\/strong><\/p>\n<p data-start=\"4630\" data-end=\"4725\">Swagger UI udost\u0119pnia tryb testowania endpointu, aktywowany przyciskiem [<strong>Try it out<\/strong>].<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter size-full wp-image-36633\" src=\"https:\/\/pomoc.comarch.pl\/cee\/wp-content\/uploads\/2025\/08\/swaggerf.png\" alt=\"\" width=\"1422\" height=\"851\" srcset=\"https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerf.png 1422w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerf-300x180.png 300w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerf-1024x613.png 1024w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerf-768x460.png 768w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerf-50x30.png 50w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerf-920x551.png 920w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerf-600x359.png 600w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerf-320x192.png 320w\" sizes=\"auto, (max-width: 1422px) 100vw, 1422px\" \/><\/p>\n<p data-start=\"4729\" data-end=\"4803\">Po uruchomieniu trybu testowego zar\u00f3wno tre\u015b\u0107 zapytania, jak i wszystkie parametry staj\u0105 si\u0119 edytowalne.<\/p>\n<ul>\n<li data-start=\"4804\" data-end=\"4860\">\n<p data-start=\"4806\" data-end=\"4860\">Wys\u0142anie zapytania odbywa si\u0119 przyciskiem [<strong>Execute<\/strong>].<\/p>\n<\/li>\n<li data-start=\"4861\" data-end=\"4950\">\n<p data-start=\"4863\" data-end=\"4950\">Bazowy URL zapytania jest ustalany na podstawie wybranego serwera w sekcji <em data-start=\"4938\" data-end=\"4947\">Servers<\/em>.<\/p>\n<\/li>\n<li data-start=\"4951\" data-end=\"5005\">\n<p data-start=\"4953\" data-end=\"5005\">Wszystkie wymagane parametry musz\u0105 by\u0107 uzupe\u0142nione przed wys\u0142aniem zapytania.<\/p>\n<\/li>\n<li>Anulowanie trybu testowego odbywa si\u0119 przyciskiem [<strong>Cancel<\/strong>].<\/li>\n<\/ul>\n<p><strong style=\"font-size: revert; color: initial;\"><br \/>Przyk\u0142ad trybu testowego<\/strong><\/p>\n<p data-start=\"5008\" data-end=\"5069\">Endpoint bez parametr\u00f3w ani tre\u015bci zapytania:<br \/><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter size-full wp-image-36636\" src=\"https:\/\/pomoc.comarch.pl\/cee\/wp-content\/uploads\/2025\/08\/swaggerg.png\" alt=\"\" width=\"1415\" height=\"278\" srcset=\"https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerg.png 1415w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerg-300x59.png 300w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerg-1024x201.png 1024w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerg-768x151.png 768w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerg-50x10.png 50w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerg-920x181.png 920w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerg-600x118.png 600w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerg-320x63.png 320w\" sizes=\"auto, (max-width: 1415px) 100vw, 1415px\" \/><br data-start=\"76\" data-end=\"79\" \/>Endpoint z parametrami i tre\u015bci\u0105 zapytania:<br \/><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter size-full wp-image-36639\" src=\"https:\/\/pomoc.comarch.pl\/cee\/wp-content\/uploads\/2025\/08\/try_it_out_with_bosy_n_params.png\" alt=\"\" width=\"1418\" height=\"710\" srcset=\"https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/try_it_out_with_bosy_n_params.png 1418w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/try_it_out_with_bosy_n_params-300x150.png 300w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/try_it_out_with_bosy_n_params-1024x513.png 1024w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/try_it_out_with_bosy_n_params-768x385.png 768w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/try_it_out_with_bosy_n_params-50x25.png 50w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/try_it_out_with_bosy_n_params-920x461.png 920w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/try_it_out_with_bosy_n_params-600x300.png 600w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/try_it_out_with_bosy_n_params-320x160.png 320w\" sizes=\"auto, (max-width: 1418px) 100vw, 1418px\" \/><br data-start=\"125\" data-end=\"128\" \/>Przyk\u0142adowa odpowied\u017a:<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter size-full wp-image-36641\" src=\"https:\/\/pomoc.comarch.pl\/cee\/wp-content\/uploads\/2025\/08\/swaggerh.png\" alt=\"\" width=\"1417\" height=\"908\" srcset=\"https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerh.png 1417w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerh-300x192.png 300w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerh-1024x656.png 1024w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerh-768x492.png 768w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerh-50x32.png 50w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerh-920x590.png 920w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerh-600x384.png 600w, https:\/\/pomoc.comarch.pl\/cee\/640\/wp-content\/uploads\/2025\/08\/swaggerh-320x205.png 320w\" sizes=\"auto, (max-width: 1417px) 100vw, 1417px\" \/><\/p>\n<h3 data-start=\"5076\" data-end=\"5100\" id=\"wymagane-uprawnienia\" ><span class=\"ez-toc-section\" id=\"Wymagane_uprawnienia\"><\/span>Wymagane uprawnienia<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p data-start=\"5101\" data-end=\"5193\">Aby korzysta\u0107 z wbudowanego w Comarch ERP Enterprise interfejsu Swagger UI, u\u017cytkownik musi mie\u0107 dost\u0119p do:<\/p>\n<ul>\n<li data-start=\"5195\" data-end=\"5238\">\n<p data-start=\"5197\" data-end=\"5238\"><em data-start=\"5197\" data-end=\"5236\">com.cisag.sys.tools.swagger.SwaggerUI<\/em><\/p>\n<\/li>\n<li data-start=\"5241\" data-end=\"5292\"><em data-start=\"5241\" data-end=\"5290\"><em data-start=\"5241\" data-end=\"5290\">com.cisag.sys.tools.swagger.rest.SwaggerService<\/em><\/em><\/li>\n<\/ul>\n<p data-start=\"5241\" data-end=\"5292\">Bez tych uprawnie\u0144 dost\u0119p zostanie odrzucony.<em data-start=\"5241\" data-end=\"5290\"><br \/><\/em><\/p>\n<p data-start=\"5294\" data-end=\"5356\">Dodatkowo u\u017cytkownik musi posiada\u0107 przypisane prawo dost\u0119pu:<\/p>\n<ul data-start=\"5358\" data-end=\"5424\">\n<li data-start=\"5358\" data-end=\"5424\">\n<p data-start=\"5360\" data-end=\"5424\"><em data-start=\"5360\" data-end=\"5422\">com.cisag.sys.tools.swagger.rest.GetRESTSwaggerDocumentation<\/em><\/p>\n<\/li>\n<\/ul>\n<p data-start=\"5426\" data-end=\"5487\">W przypadku braku uprawnie\u0144 zwracany jest kod odpowiedzi 403.<\/p>\n<p data-start=\"2913\" data-end=\"2938\"><strong>\u00a0<\/strong><\/p>\n\n\n<p><\/p>\n","protected":false},"author":34,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","meta":{"footnotes":""},"class_list":["post-36576","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-swagger"],"_links":{"self":[{"href":"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/wp-json\/wp\/v2\/ht_kb\/36576","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/wp-json\/wp\/v2\/ht_kb"}],"about":[{"href":"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/wp-json\/wp\/v2\/users\/34"}],"replies":[{"embeddable":true,"href":"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/wp-json\/wp\/v2\/comments?post=36576"}],"version-history":[{"count":31,"href":"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/wp-json\/wp\/v2\/ht_kb\/36576\/revisions"}],"predecessor-version":[{"id":36789,"href":"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/wp-json\/wp\/v2\/ht_kb\/36576\/revisions\/36789"}],"wp:attachment":[{"href":"https:\/\/pomoc.comarch.pl\/cee\/640\/index.php\/wp-json\/wp\/v2\/media?parent=36576"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}