{"info":{"_postman_id":"fae2664d-7808-46cd-b78d-2f2c6d315719","name":"ifm mate API - v2","description":"
\n

Note: ifm mate software version v1.4.0 or higher is required to use ifm mate API v2 as described. You can also use the ifm mate API v2 endpoints with ifm mate software version v1.3.0 with a limited set of response parameters.

\n
\n
\n

Note: Enable control interface service in the network section of ifm mate system configuration.

\n
\n
\n

Note: 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 network section of ifm mate system configuration.

\n
\n
\n

Note: Authorization is optional. Enable/disable in the network section of ifm mate system configuration.

\n
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10741504","collectionId":"fae2664d-7808-46cd-b78d-2f2c6d315719","publishedId":"2s935kQ6Q1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-02-02T08:38:20.000Z"},"item":[{"name":"Workflows","item":[{"name":"Get workflows","id":"6d87802b-b48c-4e0a-b131-15295d438a6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/workflows/","description":"

Description:

\n

Returns an array (possibly empty) of all available workflows.

\n

Response JSON Object:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescription
id (string)the id of the workflow
customId (string)the custom id of the workflow. From version 1.5.0, ifm mate supports multiple custom ids. Individual ids are seperated by \"|\" in the customId string.
group (bool)is workflow group
name (string)the name of the workflow
allowRePicking (bool)whether re-picking in the last field is allowed or not
disableErrorConfirmation (bool)whether error confirmation by the user (touching screen) is disabled or not
restartWorkflowOnError (bool)whether the workflow restarts or continues from current step after an error occurs
autoHighlightWorkInstructions (bool)whether work instructions will be enlarged by default
mandatoryFieldCheck (string)workflow start behaviour
\n

HTTP status codes:

\n

200 OK

\n

Response Header:

\n

Content-Type: application/json

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fae2664d-7808-46cd-b78d-2f2c6d315719","id":"fae2664d-7808-46cd-b78d-2f2c6d315719","name":"ifm mate API - v2","type":"collection"}},"urlObject":{"path":["mate","api","v2","workflows",""],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"1d9adbd3-e49a-498e-b6bb-55d90543fbcc","name":"Sample request","originalRequest":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/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 \"group\": false,\n \"allowRePicking\" : true,\n \"disableErrorConfirmation\" : false,\n \"restartWorkflowOnError\" : false,\n \"autoHighlightWorkInstructions\": true,\n \"mandatoryFieldCheck\": \"NO_FIELD_VALIDATION\"\n },\n {\n \"id\":\"16291139420811871136022682\",\n \"customId\":\"5678\",\n \"name\":\"Workflow 2\",\n \"group\": false,\n \"allowRePicking\" : true,\n \"disableErrorConfirmation\" : false,\n \"restartWorkflowOnError\" : false,\n \"autoHighlightWorkInstructions\": true,\n \"mandatoryFieldCheck\": \"NO_FIELD_VALIDATION\"\n }\n]"}],"_postman_id":"6d87802b-b48c-4e0a-b131-15295d438a6c"},{"name":"Get workflow","id":"8eeedb5d-2111-43ee-92f7-cdd8ebf4c280","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/workflows/{id}","description":"

Description:

\n

Returns the specific workflow based on the passed {id} of the workflow.

\n

Response JSON Object:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescription
id (string)the id of the workflow
customId (string)the custom id of the workflow. From version 1.5.0, ifm mate supports multiple custom ids. Individual ids are seperated by \"|\" in the customId string.
group (bool)is workflow group
name (string)the name of the workflow
allowRePicking (bool)whether re-picking in the last field is allowed or not
disableErrorConfirmation (bool)whether error confirmation by the user (touching screen) is disabled or not
restartWorkflowOnError (bool)whether the workflow restarts or continues from current step after an error occurs
autoHighlightWorkInstructions (bool)whether work instructions will be enlarged by default
mandatoryFieldCheck (string)workflow start behaviour
\n

HTTP status codes:

\n

200 OK

\n

404 NOT FOUND: requested workflow does not exists

\n

Response Header:

\n

Content-Type: application/json

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fae2664d-7808-46cd-b78d-2f2c6d315719","id":"fae2664d-7808-46cd-b78d-2f2c6d315719","name":"ifm mate API - v2","type":"collection"}},"urlObject":{"path":["mate","api","v2","workflows","{id}"],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"f87865d5-38bb-4a55-b510-ed4ff8b73b6f","name":"Sample request","originalRequest":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/workflows/{id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"16239937444698221789063893\",\n \"customId\": \"1234\",\n \"name\":\"Workflow 1\",\n \"group\": false,\n \"allowRePicking\" : true,\n \"disableErrorConfirmation\" : false,\n \"restartWorkflowOnError\" : false,\n \"autoHighlightWorkInstructions\": true,\n \"mandatoryFieldCheck\": \"NO_FIELD_VALIDATION\"\n}"}],"_postman_id":"8eeedb5d-2111-43ee-92f7-cdd8ebf4c280"},{"name":"Get fields","id":"976f4863-8a76-44dd-bc6f-7ff2c88c5211","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/workflows/{id}/fields","description":"

Description:

\n

Returns an array of all fields in a specific workflow based on the passed {id} of the workflow.

\n

Response JSON Object:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescription
id (string)the id of the field
customId (string)the custom id of the field
name (string)the name of the field
depthThreshold (int)the depth threshold for the field in cm
ignoreUnexpectedGripping (bool)whether an unexpected pick in this field will be ignored or throws an error
tapFieldToResumeProcess (bool)whether a field the be used as a virtual button to confirm an error
\n

HTTP status codes:

\n

200 OK

\n

404 NOT FOUND: workflow does not exists

\n

Response Header:

\n

Content-Type: application/json

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fae2664d-7808-46cd-b78d-2f2c6d315719","id":"fae2664d-7808-46cd-b78d-2f2c6d315719","name":"ifm mate API - v2","type":"collection"}},"urlObject":{"path":["mate","api","v2","workflows","{id}","fields"],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"68489510-21bd-4679-80ba-2f1ee153edb8","name":"Sample request","originalRequest":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/workflows/{id}/fields"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"16239937444698221789063893\",\n \"customId\": \"1234\",\n \"name\": \"Field 1\",\n \"depthThreshold\": 15,\n \"ignoreUnexpectedGripping\": false,\n \"tapFieldToResumeProcess\": false\n },\n {\n \"id\":\"16291139420811871136022682\",\n \"customId\":\"5678\",\n \"name\":\"Field 2\",\n \"depthThreshold\": 15,\n \"ignoreUnexpectedGripping\": false,\n \"tapFieldToResumeProcess\": false\n },\n {\n \"id\":\"16239937444690896459873425\",\n \"customId\":\"0987\",\n \"name\":\"Field 3\",\n \"depthThreshold\": -1,\n \"ignoreUnexpectedGripping\": false,\n \"tapFieldToResumeProcess\": false\n }\n]"}],"_postman_id":"976f4863-8a76-44dd-bc6f-7ff2c88c5211"},{"name":"Get sequence","id":"a266b3fa-cb6d-437d-9634-c7742ea3fcb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/workflows/{id}/sequence","description":"

Description:

\n

Returns the sequence of fields in a specific workflow based on the passed {id} of the workflow.

\n

Response JSON Object:

\n

Array of sequence steps:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescription
step (int)index in the sequence order
numberOfSteps (int)Number of non-sequential sub steps
instructionFile (string)name of the instruction video or image file linked to this step
elements (array)active elements in this steps
\n

Element object:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescription
type (string)Type of active element. Currently supported types are: pick, o2d5
data (array)data object for element type
\n

Data object for type pick:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescription
id (string)the id of the field
customId (string)the custom id of the field
name (string)the name of the field
depthThreshold (int)the depth threshold for the field in cm
ignoreUnexpectedGripping (bool)whether an unexpected pick in this field will be ignored or throws an error
tapFieldToResumeProcess (bool)whether a field the be used as a virtual button to confirm an error
\n

Data object for type o2d5:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescription
macAddress (string)MAC address of the linked O2D5xx sensor
name (string)Name of the linked O2D5xx sensor
applicationId (string)ID of the application to be activated
attempts (int)Defines how often the sensor is triggered to obtain a positive result. When this number is reached, an error is indicated. -1 means infinite attempts.
\n

HTTP status codes:

\n

200 OK

\n

404 NOT FOUND: workflow does not exists

\n

Response Header:

\n

Content-Type: application/json

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fae2664d-7808-46cd-b78d-2f2c6d315719","id":"fae2664d-7808-46cd-b78d-2f2c6d315719","name":"ifm mate API - v2","type":"collection"}},"urlObject":{"path":["mate","api","v2","workflows","{id}","sequence"],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"ffb14275-9346-4bc7-877d-79adb65c23af","name":"Sample request","originalRequest":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/workflows/{id}/sequence"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"step\": 0,\n \"numberOfSteps\": 1,\n \"instructionFile\" : \"\",\n \"elements\": \n [\n {\n \"type\": \"pick\",\n \"data\": \n {\n \"id\": \"16239937444698221789063893\",\n \"customId\": \"1111\",\n \"name\": \"Field 1\",\n \"depthThreshold\": 15,\n \"ignoreUnexpectedPicks\": false,\n \"tapFieldToResumeProcess\": false\n }\n }\n ]\n },\n {\n \"step\": 1,\n \"numberOfSteps\": 1,\n \"instructionFile\" : \"\",\n \"elements\": \n [\n {\n \"type\": \"pick\",\n \"data\": \n {\n \"id\": \"16239937444698221534789753\",\n \"customId\": \"2222\",\n \"name\": \"Field 2\",\n \"depthThreshold\": 20,\n \"ignoreUnexpectedPicks\": false,\n \"tapFieldToResumeProcess\": false\n }\n }\n ]\n },\n {\n \"step\": 2,\n \"numberOfSteps\": 2,\n \"instructionFile\" : \"\",\n \"elements\": \n [\n {\n \"type\": \"pick\",\n \"data\": \n {\n \"id\": \"16239937444690896459873425\",\n \"customId\": \"3333\",\n \"name\": \"Field 3\",\n \"depthThreshold\": 20,\n \"ignoreUnexpectedPicks\": false,\n \"tapFieldToResumeProcess\": false\n }\n },\n {\n \"type\": \"pick\",\n \"data\": \n {\n \"id\": \"162399374446985849300540506\",\n \"customId\": \"4444\",\n \"name\": \"Field 4\",\n \"depthThreshold\": 15,\n \"ignoreUnexpectedPicks\": false,\n \"tapFieldToResumeProcess\": false\n }\n }\n ]\n },\n {\n \"step\": 3,\n \"numberOfSteps\": 1,\n \"instructionFile\" : \"\",\n \"elements\": \n [\n {\n \"type\": \"o2d5\",\n \"instructionFile\" : \"\",\n \"data\": \n {\n \"macAddress\" : \"00::02::01::42::b9::cf\",\n \"name\" : \"O2D500 - New sensor\",\n \"applicationId\" : \"01\",\n \"attempts\" : 10\n }\n }\n ]\n }\n]"}],"_postman_id":"a266b3fa-cb6d-437d-9634-c7742ea3fcb3"}],"id":"2d37fedc-c959-4c23-bb4c-12c36caf6a0c","_postman_id":"2d37fedc-c959-4c23-bb4c-12c36caf6a0c","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fae2664d-7808-46cd-b78d-2f2c6d315719","id":"fae2664d-7808-46cd-b78d-2f2c6d315719","name":"ifm mate API - v2","type":"collection"}}},{"name":"Order","item":[{"name":"Add/Replace order by id","id":"ec3a2ab5-0ba1-4a89-a729-4be3c13e38d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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/v2/order/","description":"

Description:

\n

Creates a new order by a workflow's id. If another order already exists, it will be terminated and replaced by the new order.

\n

Request JSON Object:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionRequired
workflowId (string)the workflow id of the orderY
batchSize (integer)the expected number of correctly performed iterations. Once the number of iterations is reached, the job is automatically stopped (status = 0). For infinite iterations set batchSize = -1.

default: -1		N
status (integer)the order status code as described in Order

default: 0		N
\n

HTTP status codes:

\n

200 OK

\n

400 BAD REQUEST: missing or wrong parameters

\n

503 SERVICE UNAVAILABLE: camera missing or not ready

\n

Request Header:

\n

Content-Type: application/json

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fae2664d-7808-46cd-b78d-2f2c6d315719","id":"fae2664d-7808-46cd-b78d-2f2c6d315719","name":"ifm mate API - v2","type":"collection"}},"urlObject":{"path":["mate","api","v2","order",""],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"60e97e60-4ab0-483e-8e16-eb939c199dde","name":"Sample request","originalRequest":{"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/v2/order/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ec3a2ab5-0ba1-4a89-a729-4be3c13e38d9"},{"name":"Add/Replace order by custom id","id":"61b91a46-d6a5-42a4-994c-dff109e60e43","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/v2/order/","description":"

Description:

\n

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.

\n

Request JSON Object:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionRequired
customId (string)the customId id of the orderY
batchSize (integer)the expected number of correctly performed iterations. Once the number of iterations is reached, the job is automatically stopped (status = 0). For infinite iterations set batchSize = -1.

default: -1		N
status (integer)the order status code as described in Order

default: 0		N
\n

HTTP status codes:

\n

200 OK

\n

400 BAD REQUEST: missing or wrong parameters

\n

503 SERVICE UNAVAILABLE: camera missing or not ready

\n

Request Header:

\n

Content-Type: application/json

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fae2664d-7808-46cd-b78d-2f2c6d315719","id":"fae2664d-7808-46cd-b78d-2f2c6d315719","name":"ifm mate API - v2","type":"collection"}},"urlObject":{"path":["mate","api","v2","order",""],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"4719916d-fb66-49cb-b79b-554e3118a4bc","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/v2/order/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"61b91a46-d6a5-42a4-994c-dff109e60e43"},{"name":"Set order status","id":"492d675d-d14b-41bd-aa24-2193a2ee68db","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/v2/order/status","description":"

Description:

\n

Sets the status of the current order.

\n

Request JSON Object:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionRequired
status (integer)the order status code as described in OrderY
\n

HTTP status codes:

\n

200 OK

\n

400 BAD REQUEST: missing or wrong parameter

\n

404 NOT FOUND: no order exists

\n

503 SERVICE UNAVAILABLE: camera missing or not ready

\n

Request Header:

\n

Content-Type: application/json

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fae2664d-7808-46cd-b78d-2f2c6d315719","id":"fae2664d-7808-46cd-b78d-2f2c6d315719","name":"ifm mate API - v2","type":"collection"}},"urlObject":{"path":["mate","api","v2","order","status"],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"55fc5f99-4fef-4c4d-9029-c1ffc04f552a","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/v2/order/status"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"492d675d-d14b-41bd-aa24-2193a2ee68db"},{"name":"End order","id":"e2458960-c69b-48bd-97ba-a703253de84d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/order/","description":"

Description:

\n

Stopps and ends the current order.

\n
\n

Note: If HTTP-DELETE is not supported by the client (e.g. Siemens S7 PLC), the order can alternatively be terminated via the Add/Replace order by id endpoint by passing an empty request body.

\n
\n

HTTP status codes:

\n

200 OK

\n

404 NOT FOUND: no order exists

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fae2664d-7808-46cd-b78d-2f2c6d315719","id":"fae2664d-7808-46cd-b78d-2f2c6d315719","name":"ifm mate API - v2","type":"collection"}},"urlObject":{"path":["mate","api","v2","order",""],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"303a617c-16ca-4e4f-918a-d1657ee9641a","name":"Sample request","originalRequest":{"method":"DELETE","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/order/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e2458960-c69b-48bd-97ba-a703253de84d"},{"name":"Get order information","id":"10f86d81-ed84-48f3-8a6e-18688a4be609","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/order/","description":"

Description:

\n

Returns the current order if exists.

\n

Response JSON Object:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescription
workflowId (string)the workflow id of the order
customId (string)the workflow's custom id. From version 1.5.0, ifm mate supports multiple custom ids. Individual ids are seperated by \"|\" in the customId string.
batchSize (integer)the expected number of correctly performed iterations. As defined in add/replace order
completed (integer)the number of correctly performed iterations so far
currentStep (integer)the current step in the workflow
status (integer)the order status code as described in Order
activeElements (array)array of elements (pick or o2d5) as described in get sequence.
\n

HTTP status codes:

\n

200 OK

\n

404 NOT FOUND: no order exists

\n

Response Header:

\n

Content-Type: application/json

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fae2664d-7808-46cd-b78d-2f2c6d315719","id":"fae2664d-7808-46cd-b78d-2f2c6d315719","name":"ifm mate API - v2","type":"collection"}},"urlObject":{"path":["mate","api","v2","order",""],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"929cac5a-82d1-4887-8a66-1383fa5ed38b","name":"Sample request","originalRequest":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/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 \"status\": 1,\n \"activeElements\": \n [\n {\n \"type\": \"pick\",\n \"data\": \n {\n \"id\": \"16239937444690896459873425\",\n \"customId\": \"3333\",\n \"name\": \"Field 3\",\n \"depthThreshold\": 20,\n \"ignoreUnexpectedPicks\": false,\n \"tapFieldToResumeProcess\": false\n }\n },\n {\n \"type\": \"pick\",\n \"data\": \n {\n \"id\": \"162399374446985849300540506\",\n \"customId\": \"4444\",\n \"name\": \"Field 4\",\n \"depthThreshold\": 15,\n \"ignoreUnexpectedPicks\": false,\n \"tapFieldToResumeProcess\": false\n }\n }\n ]\n}"}],"_postman_id":"10f86d81-ed84-48f3-8a6e-18688a4be609"},{"name":"Get order status","id":"5d801171-05ff-4759-b15d-e89deb1087fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/order/status","description":"

Description:

\n

Returns the status of the current order

\n

Response JSON Object:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescription
status (integer)the order status code as described in Order
\n

HTTP status codes:

\n

200 OK

\n

404 NOT FOUND: no order exists

\n

Response Header:

\n

Content-Type: application/json

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fae2664d-7808-46cd-b78d-2f2c6d315719","id":"fae2664d-7808-46cd-b78d-2f2c6d315719","name":"ifm mate API - v2","type":"collection"}},"urlObject":{"path":["mate","api","v2","order","status"],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"c0ce13d7-8eca-43be-9d6b-b0e8ac7fd712","name":"Sample request","originalRequest":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/order/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 1\n}"}],"_postman_id":"5d801171-05ff-4759-b15d-e89deb1087fb"}],"id":"09f3dda9-0be7-4e2e-904d-e26422461f2a","description":"

Status codes:

\n

0: stopped

\n

1: running

\n

2: paused

\n

3: error

\n","_postman_id":"09f3dda9-0be7-4e2e-904d-e26422461f2a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fae2664d-7808-46cd-b78d-2f2c6d315719","id":"fae2664d-7808-46cd-b78d-2f2c6d315719","name":"ifm mate API - v2","type":"collection"}}},{"name":"System API","item":[{"name":"Shutdown system","id":"544b8942-e758-4584-8694-96b9a6fe5d9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/system/shutdown","description":"

Description:

\n

Shuts down the ifm mate system.

\n

HTTP status codes:

\n

200 OK

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fae2664d-7808-46cd-b78d-2f2c6d315719","id":"fae2664d-7808-46cd-b78d-2f2c6d315719","name":"ifm mate API - v2","type":"collection"}},"urlObject":{"path":["mate","api","v2","system","shutdown"],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"7acd519a-3865-48b1-a62a-69605c293960","name":"Sample request","originalRequest":{"method":"POST","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/system/shutdown"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"544b8942-e758-4584-8694-96b9a6fe5d9b"},{"name":"Get camera status","id":"2b49e302-789f-467f-a1de-176c90203207","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/system/cameras","description":"

Description:

\n

Returns a list (possibly empty) of all connected cameras and their connection status.

\n
\n

Note: Currently \"ifm mate\" supports a maximum of one camera.

\n
\n

Response JSON Object:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescription
id (string)the id of the camera
status (int)the camera connection status (0: connecting, 1: connected)
\n

HTTP status codes:

\n

200 OK

\n

Response Header:

\n

Content-Type: application/json

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fae2664d-7808-46cd-b78d-2f2c6d315719","id":"fae2664d-7808-46cd-b78d-2f2c6d315719","name":"ifm mate API - v2","type":"collection"}},"urlObject":{"path":["mate","api","v2","system","cameras"],"host":["http://192.168.0.100:8228"],"query":[],"variable":[]}},"response":[{"id":"c2a2222a-2fc3-49d9-ab71-0eb583311a59","name":"Sample request","originalRequest":{"method":"GET","header":[],"url":"http://192.168.0.100:8228/mate/api/v2/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":"2b49e302-789f-467f-a1de-176c90203207"}],"id":"3b604a19-9d6e-477d-baed-ac692a03f178","_postman_id":"3b604a19-9d6e-477d-baed-ac692a03f178","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"fae2664d-7808-46cd-b78d-2f2c6d315719","id":"fae2664d-7808-46cd-b78d-2f2c6d315719","name":"ifm mate API - v2","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"1aa7bef4-b48b-4a69-81ba-189ebafe4fc1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f3b3d0aa-e673-4715-852d-c5f7278a5339","type":"text/javascript","exec":[""]}}],"variable":[{"key":"mate_server","value":"http://192.168.0.100:8228"},{"key":"version_tag","value":"v2"},{"key":"workflow_id","value":"{id}"},{"key":"custom_id","value":"1234"}]}