{"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 progress of current model sampler run.</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 body</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 \\\n  http://localhost:8080/api/simulations/model-sampler/eb8d46a9-878e-4556-a3f3-19ac9b7e858d</code></pre></div>\n<h2 id=\"response\"><a href=\"#response\" 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>Response</h2>\n<p>A double value between 0 and 1 where 0 is a model sampler that hasn't begun and 1 is a model sampler that whose runs have completed.</p>\n<h3 id=\"response-schema\"><a href=\"#response-schema\" 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>Response Schema</h3>\n<p>Status Code <strong>200</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<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>id</td>\n<td>string(uuid)</td>\n<td>true</td>\n<td></td>\n</tr>\n<tr>\n<td>progress</td>\n<td>float</td>\n<td>true</td>\n<td>Progress of running model sampler process</td>\n</tr>\n<tr>\n<td>timestamp</td>\n<td>Long</td>\n<td>true</td>\n<td>When the simulation run started</td>\n</tr>\n<tr>\n<td>metadata</td>\n<td>object</td>\n<td>true</td>\n<td></td>\n</tr>\n<tr>\n<td>dataExportPath</td>\n<td>String</td>\n<td>true</td>\n<td>Where the data is exported</td>\n</tr>\n</tbody>\n</table>\n<p class=\"code-header\">Example 200 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\">\"id\"</span><span class=\"token operator\">:</span><span class=\"token string\">\"9bdf5359-cddf-45e9-a93a-7b92ab08c700\"</span><span class=\"token punctuation\">,</span>\n    <span class=\"token property\">\"progress\"</span><span class=\"token operator\">:</span><span class=\"token number\">1.0</span><span class=\"token punctuation\">,</span>\n    <span class=\"token property\">\"timestamp\"</span><span class=\"token operator\">:</span><span class=\"token number\">1549622408454</span><span class=\"token punctuation\">,</span>\n    <span class=\"token property\">\"metadata\"</span><span class=\"token operator\">:</span><span class=\"token punctuation\">{</span>\n      <span class=\"token property\">\"kind\"</span><span class=\"token operator\">:</span> <span class=\"token string\">\"pojo\"</span><span class=\"token punctuation\">,</span>\n      <span class=\"token property\">\"schema\"</span><span class=\"token operator\">:</span> <span class=\"token punctuation\">{</span>...<span class=\"token punctuation\">}</span>\n    <span class=\"token punctuation\">}</span><span class=\"token punctuation\">,</span>\n    <span class=\"token property\">\"dataExportPath\"</span><span class=\"token operator\">:</span><span class=\"token string\">\"/tmp/sampler/runs\"</span>\n<span class=\"token punctuation\">}</span></code></pre></div>\n<br> \nStatus Code **404**\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\">\"Could not find simulation '5af75d69-1926-4ef2-a56f-07ad5f85673b'\"</span>\n<span class=\"token punctuation\">}</span></code></pre></div>","headings":[{"value":"GET","depth":1},{"value":"Request","depth":2},{"value":"Response","depth":2},{"value":"Response Schema","depth":3}],"frontmatter":{"title":"/api/simulations/model-sampler/{id}","toc":null,"experimental":null}},"site":{"siteMetadata":{"title":"Simudyne Docs","latestVersion":"2.6"}}},"pageContext":{"absolutePath":"/home/vsts/work/1/s/content/2.2/rest_api/model_sampler/api_simulations_model-sampler_id.md","versioned":true,"version":"2.2","kind":"rest_api","pagePath":"/rest_api/model_sampler/api_simulations_model-sampler_id","chronology":{"prev":{"name":"/api/simulations/model-sampler","path":"/rest_api/model_sampler/api_simulations_model-sampler"}},"lastUpdated":"2026-04-21T13:56:54.839Z"}}