{"data":{"markdownRemark":{"html":"<h1 id=\"get\"><a href=\"#get\" aria-hidden=\"true\" class=\"anchor\"><svg aria-hidden=\"true\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>GET</h1>\n<p>Returns the schema and initial data associated to a particular model.</p>\n<h2 id=\"request\"><a href=\"#request\" aria-hidden=\"true\" class=\"anchor\"><svg aria-hidden=\"true\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Request</h2>\n<p class=\"code-header\">Example request</p>\n<div class=\"gatsby-highlight\" data-language=\"bash\"><pre class=\"language-bash\"><code class=\"language-bash\"><span class=\"token function\">curl</span> -X GET http://localhost:8080/api/models/schema\\?name<span class=\"token operator\">=</span><span class=\"token operator\">&lt;</span>model_name<span class=\"token operator\">></span> -H <span class=\"token string\">'Accept: application/json'</span></code></pre></div>\n<p>Status Code <strong>200</strong></p>\n<div class=\"ui segment info message\">\nThis REST-ful call returns a schema, and data representing the simulation. By default the avro schema is not returned, if you require this include the query parameter `format=avro`. For more information on the avro schema, see  <a href=\":version/reference/data_output/avro_schema\">here</href>.</a>\n</div>\n<p>Status Code <strong>404</strong></p>\n<table class=\"ui basic table\">\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Required</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>message</td>\n<td>string</td>\n<td>true</td>\n</tr>\n</tbody>\n</table>\n<p class=\"code-header\">Example 404 response body</p>\n<div class=\"gatsby-highlight\" data-language=\"json\"><pre class=\"language-json\"><code class=\"language-json\"><span class=\"token punctuation\">{</span>\n  <span class=\"token property\">\"message\"</span><span class=\"token operator\">:</span> <span class=\"token string\">\"SimulationRegistry: Could not find requested simulation '&lt;model_name>'\"</span>\n<span class=\"token punctuation\">}</span></code></pre></div>","headings":[{"value":"GET","depth":1},{"value":"Request","depth":2}],"frontmatter":{"title":"/api/models/schema","toc":null,"experimental":null}},"site":{"siteMetadata":{"title":"Simudyne Docs","latestVersion":"2.6"}}},"pageContext":{"absolutePath":"/home/vsts/work/1/s/content/2.6/rest_api/server/api_models_schema.md","versioned":false,"version":"2.6","kind":"rest_api","pagePath":"/rest_api/server/api_models_schema","chronology":{"prev":{"name":"/api/models","path":"/rest_api/server/api_models"},"next":{"name":"/api/server-info","path":"/rest_api/server/api_server_info"}},"lastUpdated":"2026-04-21T13:56:54.871Z"}}