{"id":2414,"date":"2020-09-25T07:18:30","date_gmt":"2020-09-25T07:18:30","guid":{"rendered":"https:\/\/support.itscope.hostpress.me\/?post_type=kb&#038;p=2414"},"modified":"2026-02-28T01:16:38","modified_gmt":"2026-02-27T23:16:38","slug":"ready2go-api-clients-and-data-model-generation","status":"publish","type":"kb","link":"https:\/\/guide.itscope.com\/en\/kb\/ready2go-api-clients-and-data-model-generation\/","title":{"rendered":"Ready-to-go API clients and data model generation"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\" id=\"1\">Data Model from XML Schema (XSD)<\/h2>\n\n\n\n<p>The data model for the ITscope data formats can be retrieved in XML Schema (XSD) using the <a href=\"https:\/\/api.itscope.com\/api-doc\/2.1\/index.html#!\/info\/schema\">interactive API<\/a>, via the <a href=\"https:\/\/guide.itscope.com\/en\/kb\/info-method\/\">API method <strong>info<\/strong><\/a>. No <a href=\"https:\/\/guide.itscope.com\/en\/kb\/authentication-via-api-credentials\/\">API key<\/a>&nbsp;is required for this retrieval. Simply set the <a href=\"https:\/\/guide.itscope.com\/en\/kb\/data-formats-and-output-formats\/\">data output format<\/a>&nbsp;as the URL path.<\/p>\n\n\n\n<p>URL for schema definition of the&nbsp;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/format-description-for-products-data-format-standard\/\">standard<\/a> data output format:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>https:&#47;&#47;api.itscope.com\/2.1\/info\/schema\/standard.xsd<\/code><\/pre>\n\n\n\n<p><br>URL for schema definition of the&nbsp;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/format-description-for-product-data-format-standardupdate\/\">standard update<\/a> data output format:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>https:&#47;&#47;api.itscope.com\/2.1\/info\/schema\/standardupdate.xsd<\/code><\/pre>\n\n\n\n<p><br><\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Instructions for&nbsp;Java<\/h3>\n\n\n\n<p>The result of the API retrieval for the schema depending on the data format, i.e. the XML definition, can then be stored locally on the hard disk, e.g. under c:\\temp\\itscope_api.xsd<\/p>\n\n\n\n<p>The Java&nbsp;<a href=\"http:\/\/docs.oracle.com\/javase\/7\/docs\/technotes\/tools\/share\/xjc.html\" target=\"_blank\" rel=\"noreferrer noopener\">binding compiler<\/a>&nbsp;(xjc.exe) can now create a Java class model using to the XML definition.<\/p>\n\n\n\n<p><br>This call creates a package named en.itscope.api.<br><em>&#8216;c:\\Program Files\\Java\\jdk1.7.0_51\\bin\\xjc.exe&#8217; -p en.itscope.api c:\\temp\\itscope_api.xml<\/em><br><\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Instructions for C#, .NET and VB.NET<\/h3>\n\n\n\n<p>These are some example tools or instructions for generating schemas.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>XML schema definition tool (Xsd.exe) directly in VisualStudio.&nbsp;See the following links for instructions:&nbsp;<a href=\"https:\/\/msdn.microsoft.com\/de-de\/library\/x6c1kb0s(v%3Dvs.120).aspx\">https:\/\/msdn.microsoft.com\/de-de\/library\/x6c1kb0s%28v=vs.120%29.aspx<\/a><br>or <a href=\"https:\/\/msdn.microsoft.com\/en-us\/library\/x6c1kb0s(v%3DVS.100).aspx\">https:\/\/msdn.microsoft.com\/en-us\/library\/x6c1kb0s%28v=VS.100%29.aspx<\/a><\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">API client for different developer languages<\/h2>\n\n\n\n<p>API clients can be generated using the openAPI specification issued by ITscope. This generates the necessary API data models and API documentation. These clients are intended to serve as a framework for an application, saving work but not yet providing a complete client. This means that individual customisation will be necessary. If the XML format is used, a function for deserialising an XML string must also be implemented.<\/p>\n\n\n\n<p>With the help of the <a href=\"https:\/\/github.com\/OpenAPITools\/openapi-generator\">openapi generator<\/a>, a client can be easily translated into different languages.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>openapi-generator generate -i https:\/\/api.itscope.com\/2.1\/openapi.json -g java -o .\/client<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\">Postman<\/h2>\n\n\n\n<p>For users of Postman, we have created a project that contains all the endpoints of our API version 2.1. The requests are documented in Postman.<\/p>\n\n\n\n<p>Postman can be&nbsp;<a href=\"https:\/\/www.getpostman.com\/apps\">downloaded here<\/a>.<\/p>\n\n\n\n<p>After downloading, Postman will ask you if you want to register. You can also skip the registration process: &#8216;Skip signing in and take me straight to the app&#8217;.<\/p>\n\n\n\n<p>You can find the dowload of the Postman Project at the bottom of this page.<\/p>\n\n\n\n<p>In Postman, choose a workspace and press the Import button.<\/p>\n\n\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/guide.itscope.com\/wp-content\/uploads\/2021\/12\/grafik-1024x626.png\" alt=\"\" class=\"wp-image-11433\"\/><\/figure>\n\n\n\n<p><\/p>\n\n\n\n<p>The following variables are already created in Postman and can be filled with your API credentials.<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td><strong>Variable<\/strong><\/td><td><strong>Description<\/strong><\/td><td><strong>Example<\/strong><\/td><\/tr><tr><td>baseUrl<\/td><td>The ITscope API url and version<\/td><td>https:\/\/api.itscope.com\/2.1<\/td><\/tr><tr><td>Account_ID<\/td><td>The <a href=\"https:\/\/guide.itscope.com\/en\/kb\/authentication-via-api-credentials\/\">ITscope account ID<\/a> (as username)<\/td><td>m123456<\/td><\/tr><tr><td>API_KEY<\/td><td>The <a href=\"https:\/\/guide.itscope.com\/en\/kb\/authentication-via-api-credentials\/\">API key<\/a> (as a password)<\/td><td>abc123de_f456&#8230;<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<figure class=\"wp-block-image size-large\"><img decoding=\"async\" src=\"https:\/\/guide.itscope.com\/wp-content\/uploads\/2021\/12\/grafik-2-1024x335.png\" alt=\"\" class=\"wp-image-11439\"\/><\/figure>\n\n\n\n<p>Save the variables. Postman is now ready to start.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Data Model from XML Schema (XSD) The data model for the ITscope data formats can be retrieved in XML Schema (XSD) using the interactive API, via the API method info. &#8230;<\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"kbtopic":[172],"kbtag":[],"class_list":["post-2414","kb","type-kb","status-publish","hentry","kbtopic-api-export-connection"],"_links":{"self":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/2414","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb"}],"about":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/types\/kb"}],"author":[{"embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/comments?post=2414"}],"version-history":[{"count":30,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/2414\/revisions"}],"predecessor-version":[{"id":20184,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/2414\/revisions\/20184"}],"wp:attachment":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/media?parent=2414"}],"wp:term":[{"taxonomy":"kbtopic","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtopic?post=2414"},{"taxonomy":"kbtag","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtag?post=2414"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}