{"info":{"_postman_id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","name":"ifm mate API - v1","description":"<html><head></head><body><blockquote>\n<p><strong>Note:</strong> <code>ifm mate software version v1.2.0</code> or higher is required to use <code>ifm mate API v1</code></p>\n</blockquote>\n<blockquote>\n<p><strong>Note:</strong> Enable <code>control interface</code> service in the <code>network</code> section of ifm mate system configuration.  </p>\n</blockquote>\n<blockquote>\n<p><strong>Note:</strong> IP address and port used in this documentation are the ifm mate default settings and need to be adjusted according to custom settings made under the <code>network</code> section of ifm mate system configuration.  </p>\n</blockquote>\n<blockquote>\n<p><strong>Note:</strong> Authorization is optional. Enable/disable in the <code>network</code> section of ifm mate system configuration.</p>\n</blockquote>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10741504","collectionId":"91f9d8fe-4d37-4348-870a-faefc1b85f45","publishedId":"UVXknuue","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6E00"},"publishDate":"2022-04-07T14:05:48.000Z"},"item":[{"name":"Workflows","item":[{"name":"Get workflows","id":"a14b1653-491e-4f8b-b005-2c740cecd362","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/workflows/","description":"<p><strong>Description:</strong></p>\n<p>Returns a list (possibly empty) of all available workflows.</p>\n<p><strong>Response JSON Object:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Parameter</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code> (string)</td>\n<td>the id of the workflow</td>\n</tr>\n<tr>\n<td><code>customId</code> (string)</td>\n<td>the custom id of the workflow</td>\n</tr>\n<tr>\n<td><code>name</code> (string)</td>\n<td>the name of the workflow</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>HTTP status codes:</strong></p>\n<p><code>200 OK</code></p>\n<p><strong>Response Header:</strong></p>\n<p>Content-Type: <code>application/json</code></p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","name":"ifm mate API - v1","type":"collection"}},"urlObject":{"path":["mate","api","v1","workflows",""],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"3fbe1888-001a-4f48-bdf5-03b4940a650f","name":"Sample request","originalRequest":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/workflows/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n    {\n        \"id\": \"16239937444698221789063893\",\n        \"customId\": \"1234\",\n        \"name\":\"Workflow 1\"\n    },\n    {\n        \"id\":\"16291139420811871136022682\",\n        \"customId\":\"5678\",\n        \"name\":\"Workflow 2\"\n    }\n]"}],"_postman_id":"a14b1653-491e-4f8b-b005-2c740cecd362"},{"name":"Get workflow","id":"4680d553-ffdf-4e2d-baf9-5ebad39ede55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/workflows/{id}","description":"<p><strong>Description:</strong></p>\n<p>Returns the specific workflow based on the supplied <code>{id}</code>.</p>\n<p><strong>Response JSON Object:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Parameter</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code> (string)</td>\n<td>the id of the workflow</td>\n</tr>\n<tr>\n<td><code>customId</code> (string)</td>\n<td>the custom id of the workflow</td>\n</tr>\n<tr>\n<td><code>name</code> (string)</td>\n<td>the name of the workflow</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>HTTP status codes:</strong></p>\n<p><code>200 OK</code></p>\n<p><code>404 NOT FOUND: requested workflow does not exists</code></p>\n<p><strong>Response Header:</strong></p>\n<p>Content-Type: <code>application/json</code></p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","name":"ifm mate API - v1","type":"collection"}},"urlObject":{"path":["mate","api","v1","workflows","{id}"],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"22965341-11d1-46ea-b3ab-c09fae186694","name":"Sample request","originalRequest":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/workflows/{id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"{id}\",\n    \"customId\": \"1234\",\n    \"name\": \"Workflow 1\"\n}"}],"_postman_id":"4680d553-ffdf-4e2d-baf9-5ebad39ede55"},{"name":"Get fields","id":"0284e98e-0a6f-4df6-839d-07097cceb324","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/workflows/{id}/fields","description":"<p><strong>Description:</strong></p>\n<p>Returns a list of all fields in a specific workflow based on the supplied <code>{id}</code>.</p>\n<p><strong>Response JSON Object:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Parameter</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code> (string)</td>\n<td>the id of the field</td>\n</tr>\n<tr>\n<td><code>customId</code> (string)</td>\n<td>the custom id of the field</td>\n</tr>\n<tr>\n<td><code>name</code> (string)</td>\n<td>the name of the field</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>HTTP status codes:</strong></p>\n<p><code>200 OK</code></p>\n<p><code>404 NOT FOUND: workflow does not exists</code></p>\n<p><strong>Response Header:</strong></p>\n<p>Content-Type: <code>application/json</code></p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","name":"ifm mate API - v1","type":"collection"}},"urlObject":{"path":["mate","api","v1","workflows","{id}","fields"],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"a58bddca-b579-4cd9-819a-e882d0d92f11","name":"Sample request","originalRequest":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/workflows/{id}/fields"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n    {\n        \"id\": \"16239937444698221789063893\",\n        \"customId\": \"1234\",\n        \"name\":\"Field 1\"\n    },\n    {\n        \"id\":\"16291139420811871136022682\",\n        \"customId\":\"5678\",\n        \"name\":\"Field 2\"\n    }\n]"}],"_postman_id":"0284e98e-0a6f-4df6-839d-07097cceb324"},{"name":"Get sequence","id":"f1a046f7-49c7-445c-8ac9-5ba32bee0835","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/workflows/{id}/sequence","description":"<p><strong>Description:</strong></p>\n<p>Returns the sequence of fields in a specific workflow based on the supplied <code>{id}</code>.</p>\n<p><strong>Response JSON Object:</strong></p>\n<p>Array of field ids in their sequential order. Subarrays define non-sequential sequence blocks.</p>\n<p><strong>HTTP status codes:</strong></p>\n<p><code>200 OK</code></p>\n<p><code>404 NOT FOUND: workflow does not exists</code></p>\n<p><strong>Response Header:</strong></p>\n<p>Content-Type: <code>application/json</code></p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","name":"ifm mate API - v1","type":"collection"}},"urlObject":{"path":["mate","api","v1","workflows","{id}","sequence"],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"6e5b856f-7738-4b27-a30e-e5af91268c3e","name":"Sample request","originalRequest":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/workflows/{id}/sequence"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n    \"16239937444698221789063893\",\n    \"16239937444698221534789753\",\n    \"16239937444437583592948759\",\n    [\n        \"16239937444698221789063893\",\n        \"16239937444690896459873425\"\n    ],\n    \"16239937444698221534789753\",\n    \"16239937444437583497865737\"\n]"}],"_postman_id":"f1a046f7-49c7-445c-8ac9-5ba32bee0835"}],"id":"eba942e6-29ab-419d-9bd4-319f9c1dd194","_postman_id":"eba942e6-29ab-419d-9bd4-319f9c1dd194","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","name":"ifm mate API - v1","type":"collection"}}},{"name":"Order","item":[{"name":"Get order information","id":"68afe96f-4e65-4a3a-bacb-dc8f01ee6091","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/order/","description":"<p><strong>Description:</strong></p>\n<p>Returns the current order if exists.</p>\n<p><strong>Response JSON Object:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Parameter</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>workflowId</code> (string)</td>\n<td>the workflow id of the order</td>\n</tr>\n<tr>\n<td><code>customId</code> (string)</td>\n<td>the workflow's custom id</td>\n</tr>\n<tr>\n<td><code>batchSize</code> (integer)</td>\n<td>the expected number of correctly performed iterations.</td>\n</tr>\n<tr>\n<td><code>completed</code> (integer)</td>\n<td>the number of correctly performed iterations so far</td>\n</tr>\n<tr>\n<td><code>currentStep</code> (integer)</td>\n<td>the current step in the workflow</td>\n</tr>\n<tr>\n<td><code>activeFields</code> (string array)</td>\n<td>(possibly empty) list of ids of current active fields</td>\n</tr>\n<tr>\n<td><code>status</code> (integer)</td>\n<td>the order status code</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>HTTP status codes:</strong></p>\n<p><code>200 OK</code></p>\n<p><code>404 NOT FOUND: no order exists</code></p>\n<p><strong>Response Header:</strong></p>\n<p>Content-Type: <code>application/json</code></p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","name":"ifm mate API - v1","type":"collection"}},"urlObject":{"path":["mate","api","v1","order",""],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"210611ea-528c-471a-b1a5-77aeca491b16","name":"Sample request","originalRequest":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/order/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"workflowId\": \"16239937444698221789063893\",\n    \"customId\": \"1234\",\n    \"batchSize\": 10,\n    \"completed\": 0,\n    \"currentStep\": 0,\n    \"activeFields\": \n    [\n        \"16291139420811871136022682\",\n        \"16239937444698221534789753\"\n    ],\n    \"status\": 1\n}"}],"_postman_id":"68afe96f-4e65-4a3a-bacb-dc8f01ee6091"},{"name":"Add/Replace order by id","id":"54689e1c-b8f2-49e7-8ddf-d4113077f01e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"workflowId\": \"16239937444698221789063893\",\n    \"batchSize\":10,\n    \"status\":1\n}","options":{"raw":{"language":"json"}}},"url":"http://192.168.0.100:8228/mate/api/v1/order/","description":"<p><strong>Description:</strong></p>\n<p>Creates a new order by a workflow's id. If another order already exists, it will be terminated and replaced by the new order.</p>\n<p><strong>Request JSON Object:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Parameter</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Required</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>workflowId</code> (string)</td>\n<td>the workflow id of the order</td>\n<td>Y</td>\n</tr>\n<tr>\n<td><code>batchSize</code> (integer)</td>\n<td>the expected number of correctly performed iterations. Once the number of iterations is reached, the job is automatically stopped (<code>status = 0</code>). For infinite iterations set <code>batchSize = -1</code>.  <br />  <br /><code>default: -1</code></td>\n<td>N</td>\n</tr>\n<tr>\n<td><code>status</code> (integer)</td>\n<td>the order status code  <br />  <br /><code>default: 0</code></td>\n<td>N</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>HTTP status codes:</strong></p>\n<p><code>200 OK</code></p>\n<p><code>400 BAD REQUEST: missing or wrong parameters</code></p>\n<p><code>503 SERVICE UNAVAILABLE: camera missing or not ready</code></p>\n<p><strong>Request Header:</strong></p>\n<p>Content-Type: <code>application/json</code></p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","name":"ifm mate API - v1","type":"collection"}},"urlObject":{"path":["mate","api","v1","order",""],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"70e79c28-660e-482f-a28e-22444f89cd6b","name":"Sample request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"workflowId\": \"{id}\",\n    \"batchSize\":10,\n    \"status\":1\n}","options":{"raw":{"language":"json"}}},"url":"http://192.168.0.100:8228/mate/api/v1/order/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"54689e1c-b8f2-49e7-8ddf-d4113077f01e"},{"name":"Add/Replace order by custom id","id":"da9f7efa-130e-4d79-aa7d-ef1c8483a771","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"customId\": \"1234\",\n    \"batchSize\":10,\n    \"status\":1\n}","options":{"raw":{"language":"json"}}},"url":"http://192.168.0.100:8228/mate/api/v1/order/","description":"<p><strong>Description:</strong></p>\n<p>Creates a new order by a workflow's custom id. If another order already exists, it will be terminated and replaced by the new order.</p>\n<p><strong>Request JSON Object:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Parameter</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Required</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>customId</code> (string)</td>\n<td>the customId id of the order</td>\n<td>Y</td>\n</tr>\n<tr>\n<td><code>batchSize</code> (integer)</td>\n<td>the expected number of correctly performed iterations. Once the number of iterations is reached, the job is automatically stopped (<code>status = 0</code>). For infinite iterations set <code>batchSize = -1</code>.  <br />  <br /><code>default: -1</code></td>\n<td>N</td>\n</tr>\n<tr>\n<td><code>status</code> (integer)</td>\n<td>the order status code  <br />  <br /><code>default: 0</code></td>\n<td>N</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>HTTP status codes:</strong></p>\n<p><code>200 OK</code></p>\n<p><code>400 BAD REQUEST: missing or wrong parameters</code></p>\n<p><code>503 SERVICE UNAVAILABLE: camera missing or not ready</code></p>\n<p><strong>Request Header:</strong></p>\n<p>Content-Type: <code>application/json</code></p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","name":"ifm mate API - v1","type":"collection"}},"urlObject":{"path":["mate","api","v1","order",""],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"ac4ac926-be56-4e51-a296-4ad55ac59b89","name":"Sample request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"customId\": \"1234\",\n    \"batchSize\":10,\n    \"status\":1\n}","options":{"raw":{"language":"json"}}},"url":"http://192.168.0.100:8228/mate/api/v1/order/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"da9f7efa-130e-4d79-aa7d-ef1c8483a771"},{"name":"End order","id":"dc54e8de-52bf-480f-83a6-650178e9232a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/order/","description":"<p><strong>Description:</strong></p>\n<p>Stopps and ends the current order.</p>\n<blockquote>\n<p><strong>Note:</strong> If HTTP-DELETE is not supported by the client (e.g. Siemens S7 PLC), the order can alternatively be terminated via the <a href=\"#54689e1c-b8f2-49e7-8ddf-d4113077f01e\">Add/Replace order by id</a> endpoint by passing an empty request body. </p>\n</blockquote>\n<p><strong>HTTP status codes:</strong></p>\n<p><code>200 OK</code></p>\n<p><code>404 NOT FOUND: no order exists</code></p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","name":"ifm mate API - v1","type":"collection"}},"urlObject":{"path":["mate","api","v1","order",""],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"6ce5678b-30d6-417f-8a92-987d1c531902","name":"Sample request","originalRequest":{"method":"DELETE","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/order/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"dc54e8de-52bf-480f-83a6-650178e9232a"},{"name":"Get order status","id":"b3971dbc-83e0-49db-a042-4cf6545704ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/order/status","description":"<p><strong>Description:</strong></p>\n<p>Returns the status of the current order</p>\n<p><strong>Response JSON Object:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Parameter</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>status</code> (integer)</td>\n<td>the order status code</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>HTTP status codes:</strong></p>\n<p><code>200 OK</code></p>\n<p><code>404 NOT FOUND: no order exists</code></p>\n<p><strong>Response Header:</strong></p>\n<p>Content-Type: <code>application/json</code></p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","name":"ifm mate API - v1","type":"collection"}},"urlObject":{"path":["mate","api","v1","order","status"],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"aad24f60-f0f0-4161-aed8-e6dcc452d07a","name":"Sample request","originalRequest":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/order/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"status\": 1\n}"}],"_postman_id":"b3971dbc-83e0-49db-a042-4cf6545704ae"},{"name":"Set order status","id":"1305d161-9e4e-4119-b4ea-d3db82555a95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"status\": 1\n}","options":{"raw":{"language":"json"}}},"url":"http://192.168.0.100:8228/mate/api/v1/order/status","description":"<p><strong>Description:</strong></p>\n<p>set the status of the current order.</p>\n<p><strong>Request JSON Object:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Parameter</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Required</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>status</code> (integer)</td>\n<td>the order status code</td>\n<td>Y</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>HTTP status codes:</strong></p>\n<p><code>200 OK</code></p>\n<p><code>400 BAD REQUEST: missing or wrong parameter</code></p>\n<p><code>404 NOT FOUND: no order exists</code></p>\n<p><code>503 SERVICE UNAVAILABLE: camera missing or not ready</code></p>\n<p><strong>Request Header:</strong></p>\n<p>Content-Type: <code>application/json</code></p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","name":"ifm mate API - v1","type":"collection"}},"urlObject":{"path":["mate","api","v1","order","status"],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"ba721a89-8587-4fa2-87dd-86bea611e71f","name":"Sample request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"status\": 1\n}","options":{"raw":{"language":"json"}}},"url":"http://192.168.0.100:8228/mate/api/v1/order/status"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"1305d161-9e4e-4119-b4ea-d3db82555a95"}],"id":"299d836a-5401-423c-8dd2-5d1705f93d52","description":"<p>Status codes:</p>\n<p><code>0: stopped</code></p>\n<p><code>1: running</code></p>\n<p><code>2: paused</code></p>\n<p><code>3: error</code></p>\n","_postman_id":"299d836a-5401-423c-8dd2-5d1705f93d52","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","name":"ifm mate API - v1","type":"collection"}}},{"name":"System API","item":[{"name":"Shutdown system","id":"d317e1de-937c-4f29-92da-401ce84c9d93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/system/shutdown","description":"<p><strong>Description:</strong></p>\n<p>Shuts down the ifm mate system.</p>\n<p><strong>HTTP status codes:</strong></p>\n<p><code>200 OK</code></p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","name":"ifm mate API - v1","type":"collection"}},"urlObject":{"path":["mate","api","v1","system","shutdown"],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"038ca5ee-8469-4350-bf70-9441ca3631ac","name":"Sample Request","originalRequest":{"method":"POST","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/system/shutdown"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d317e1de-937c-4f29-92da-401ce84c9d93"},{"name":"Get camera status","id":"f24c0304-d0de-414a-a77f-9e8e49d53f32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/system/cameras","description":"<p><strong>Description:</strong></p>\n<p>Returns a list (possibly empty) of all connected cameras and their connection status.</p>\n<blockquote>\n<p><strong>Note:</strong> Currently \"ifm mate\" supports a maximum of one camera.</p>\n</blockquote>\n<p><strong>Response JSON Object:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Parameter</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code> (string)</td>\n<td>the id of the camera</td>\n</tr>\n<tr>\n<td><code>status</code> (int)</td>\n<td>the camera connection status (<code>0</code>: connecting, <code>1</code>: connected)</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>HTTP status codes:</strong></p>\n<p><code>200 OK</code></p>\n<p><strong>Response Header:</strong></p>\n<p>Content-Type: <code>application/json</code></p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","name":"ifm mate API - v1","type":"collection"}},"urlObject":{"path":["mate","api","v1","system","cameras"],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"1e42b93c-ed22-4b8b-af7d-c0fa44abc4f3","name":"Sample request","originalRequest":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v1/system/cameras"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n    {\n        \"id\": \"037522250784\",\n        \"status\": 1\n    }\n]"}],"_postman_id":"f24c0304-d0de-414a-a77f-9e8e49d53f32"}],"id":"88d7402d-86f0-48ae-b2ab-aca238773edc","_postman_id":"88d7402d-86f0-48ae-b2ab-aca238773edc","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","id":"91f9d8fe-4d37-4348-870a-faefc1b85f45","name":"ifm mate API - v1","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]}},"event":[{"listen":"prerequest","script":{"id":"ac20825d-e118-4a95-a7c3-1b7316a0b8eb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a85844a4-ba9b-492a-9f5b-249b30c26958","type":"text/javascript","exec":[""]}}],"variable":[{"key":"mate_server","value":"http://192.168.0.100:8228"},{"key":"version_tag","value":"v1"},{"key":"workflow_id","value":"{id}"},{"key":"custom_id","value":"1234"}]}