API Version 3.03
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"21083814","collectionId":"c5c220c2-6275-428e-ac56-b4ff6fac5e31","publishedId":"2s9YeLX8oD","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-12-04T11:42:32.000Z"},"item":[{"name":"Work orders & Work order lines","item":[{"name":"Create work orders & work order lines","item":[{"name":"Create WOLs without routing","id":"f22edf14-c765-470c-b452-1ea5fd137839","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Auth-Token"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": [\r\n {\r\n \"status\": \"new\",\r\n \"workorderline_id\": \"231317\",\r\n \"workorderline_code\": \"KL9899\",\r\n \"production_status\": \"production\",\r\n \"description\": \"Wooden Table 1200X800\",\r\n //\"overUnderPercentage\": \"50\",\r\n \"quantity\": \"200\",\r\n \"target_day\": \"2021-11-27\",\r\n \"comments\": \"taking care in transportation\",\r\n //\"workflow_id\":\"23\",\r\n \"wol_tag\" : [{\r\n \"id\": \"3432\",\r\n \"name\": \"order series 1\"\r\n }],\r\n \"files\": [{\r\n \"id\": \"1515\",\r\n \"name\": \"image_at_workorderline\",\r\n \"type\": \"jpg\",\r\n \"path\": \"https://epoptia.com/wp-content/uploads/2022/02/JPEG-Epopteia-04.jpg\"\r\n }],\r\n \"workorder\":{\r\n \"id\":\"2323\",\r\n \"code\":\"019580\",\r\n \"comments\": \"Call client before shipment\",\r\n \"files\": [{\r\n \t\"id\": \"1616\",\r\n \t\t\"name\": \"image_at_workorder\",\r\n \t\"type\": \"jpg\",\r\n \t\"path\": \"https://epoptia.com/wp-content/uploads/2021/12/welder-gb18d05173_1280.jpg\"\r\n }]\r\n },\r\n \"product\":{\r\n \"id\":\"5294\",\r\n \"name\":\"Wooden Table\",\r\n \"code\":\"01180\",\r\n \"category_tag\" : [{\r\n \"id\": \"4444\",\r\n \"name\": \"tables\"\r\n }],\r\n \"files\": [{\r\n \t\"id\": \"1717\",\r\n \t\"name\": \"product_design\",\r\n \t\"type\": \"jpg\",\r\n \t\"path\": \"https://epoptia.com/wp-content/uploads/2021/07/workstation3.jpg\"\r\n }],\r\n \"thumbnail\": {\r\n \t\"id\": \"123\",\r\n \t\"name\": \"product_thumbnail\",\r\n \t\"type\": \"jpg\",\r\n \t\"path\": \"https://epoptia.com/wp-content/uploads/2021/12/laser-ga5579cbb5_1280.jpg\"\r\n }\r\n },\r\n \"client\":{\r\n \"id\":\"320\",\r\n \"name\":\"John Bravos\",\r\n\t \t\"email\": \"jbravos@gmail.com\",\r\n \t \"phone_number\": \"003367876939\",\r\n \"code\":\"560307\",\r\n \"thumbnail\": {\r\n \t\"id\": \"1818\",\r\n \t\t\"name\": \"client_logo\",\r\n \t\"type\": \"jpg\",\r\n \t\"path\": \"https://epoptia.com/wp-content/uploads/2022/02/epoptia_logo_4.png\"\r\n }\r\n },\r\n \"customFields\":[\r\n {\r\n \"id\":\"501234\",\r\n \"name\": \"Width\",\r\n \"value\":\"2mm\",\r\n \"groupId\": \"\",\r\n \"groupName\": \"\",\r\n \"notUpdate\" : true,\r\n \"type\": \"text\"\r\n },\r\n {\r\n \"id\":\"9841108\",\r\n \"name\": \"material selection\",\r\n \"value\":\"Option 1\",\r\n \"groupId\": \"\",\r\n \"groupName\": \"\",\r\n \"type\": \"dropdown\",\r\n \"dropdown_options\": [\r\n \"Option 2\",\r\n \"Option 3\"\r\n ]\r\n }\r\n ],\r\n \"bom\":[ \r\n {\r\n \"id\":\"23234\",\r\n \"name\": \"drawer\",\r\n \"code\": \"23234\",\r\n \"value\":\"1\",\r\n \"groupId\": \"\",\r\n \"groupName\": \"\",\r\n \"notUpdate\" : true\r\n },\r\n {\r\n \"id\":\"32324\",\r\n \"name\": \"drawer2\",\r\n \"code\": \"32324\",\r\n \"value\":\"3\",\r\n \"groupId\": \"\",\r\n \"groupName\": \"\",\r\n \"notUpdate\" : true\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{baseUrl}}/api/3.03/synchronize","description":"Create work order lines
\nAll the necessary information is included in the JSON file for the creation of a complete WOL. No routing is included and custom fields are configured inside the Epoptia Software.
\nRequired fields and explanations.
\nAll the fields with the symbol (*) in front of them must be fulfilled.
All the other fields can be left blank, \"\", or not included at all.
* \"status\"
\n\"new\" for new wols
\n\"update\" for making changes to existing ones
\n* \"workorderline_id\" // Remote database id of wol id
\n\"workorderline_code\" // Remote code of wol
\n\"production_status\" // Set the status of the wol
\n\"production\"
\n\"standby\"
\n\"description\" // Remote description of wol
\n\"overUnderPercentage\" // Declare the percentage of Over & Under Production. Allowed values 1-99. It is not mandatory to be included at json files.
\n* \"quantity\" // Desired produced quantitzy
\n* \"target_day\" // WOL target completion date (yyyy-mm-dd)
\n\"comments\" // Remote WOL comments
\n\"workflow_id\" // Epoptia's Template Workflow Id. If not used, do not add it to the JSON file. If erp_routing is used, do not add it to the JSON file.
\n\"wol_tag\" // Can be used to separate different kinds of work order lines inside the same Manufacturing Board. We suggest using the wol_tags for your different series of production orders.
\n\"files\" // Add files to specific work order line. Do not include the whole object if there are no files, If more than one, include it in an array.
\n*id\" // Remote id
\n*\"name\" // Remote name
\n*\"type\" // Types supported jpg, png, pdf
\n*\"path\" // Public path
\n* \"workorder\"
\n* \"id\" // Remote WO id
\n* \"code\" // Remote WO code
\n\"comments\" // Remote WO comments
\n\"files\" // Add files to a specific work order. Do not include the whole object if there are no files, If more than one, include it in an array.
\n*id\" // Remote id
\n*\"name\" // Remote name
\n*\"type\" // Types supported jpg, png, pdf
\n*\"path\" // Public path
\n*\"product\"
\n* \"id\" // Remote id
\n* \"name\" // Remote product description
\n\"category_tag\" // It can be used to determine the different categories of products.
\n\"files\" // Add files directly to the product's master data. Do not include the whole object if there are no files, If more than one, include it in an array.
\n\"thumbnail\" // Add thumbnail directly to product's master data. Not include the whole object if there are no files
\n* id\" // Remote id
\n* \"name\" // Remote name
\n* \"type\" // Types supported jpg, png, pdf
\n* \"path\" // Public path
\n\"client\"
\n* \"id\" // Remote id
\n* \"name\" // Remote name
\n\"email\" // Client's email (Include only one)
\n\"phone_number\" // Client's phone number (Include only one)
\n\"code\" // Remote code
\n\"thumbnail\" // Add thumbnail directly to product's master data. Not include the whole object if there are no files
\n*id\" // Remote id
\n*\"name\" // Remote name
\n*\"type\" // Types supported jpg, png, pdf
\n*\"path\" // Public path
\n\"customFields\"
\n* \"id\" // Remote id
\n* \"name\" // Remote name
\n* \"value\" // Value
\n\"groupId\" // Used to acquire the category remote ID of the custom fields. Integer.
\n\"groupName\" // Used to acquire the category name of the custom fields. Integer.
\n\"notUpdate\" // Used to not update the specific value even if it is changed by administrators and operators at Epoptia MES. Only TRUE is accepted. If not used, do not include it in the JSON file.
\n* \"type\" // If not included type \"Text\" considered by default
\nCustom field types:
\n\"text\"
\n\"dropdown\"
\n\"bom\"
\n*\"id\" // Remote id
\n*\"name\" // Remote name
\n*\"value\" // Value
\n\"groupId\" // Used to acquire the category remote ID of the custom fields. Integer.
\n\"groupName\" // Used to acquire the category name of the custom fields. Integer.
\n\"notUpdate\" // Used to not update the specific value even if it is changed by administrators and operators at Epoptia MES. Only TRUE is accepted. If not used, do not include it in the JSON file.
\nImportant notes:
\nWO client, WOLs produced quantity, and workflow value can be updated only if the production orders have not started inside production.
\nIf they have already started, a system alarm is triggered providing information about the specific action.
\nBOMs, custom fields, and comments can be updated at any time.
\nResponses
\nstatus is missing
\nstatus value is invalid
\nworkorderline_id is missing
\ninvalid value for workorderline_id
\nid is missing from wol_tag
\nname is missing from wol_tag
\ninvalid value for workorder_line target_day
\ntarget_day is missing
\ninvalid value for production_status (must be
production or standby)
quantity is missing
\ninvalid value for quantity
\nchoose erp_routing or workflow_id
\ninvalid value for workflow_id
\nworkorder id is missing
\ninvalid value for workorder id
\nworkorder code is missing
\ninvalid value for workorder code
\ninvalid value for workorder
\nproduct id is missing
\ninvalid value for product id
\nproduct name is missing
\ninvalid value for product name
\nproduct is missing
\nid is missing from category_tag
\nname is missing from category_tag
\ninvalid value for client id
\nclient id is missing
\nclient name is missing
\ninvalid value for client name
\nclient is missing
\nid is missing at product thumbnail
\nname is missing at product thumbnail
\ntype is missing at product thumbnail
\npath is missing at product thumbnail
\ntype is invalid at product thumbnail
(png,jpg,jpeg,pdf are accepted)
id is missing at client thumbnail
\nname is missing at client thumbnail
\ntype is missing at client thumbnail
\npath is missing at client thumbnail
\ntype is invalid at client thumbnail
(png,jpg,jpeg,pdf are accepted)
For workorder_line_files, workorder_files & product_files
\nid is missing
\nname is missing
\ntype is missing
\ntype is invalid (png,jpg,jpeg,pdf are
accepted)
path is missing
\nFor customFields & bom
\ninvalid value for $cb id
\n$cb name is missing
\ninvalid value for $cb name
\ninvalid value for $cb notUpdate (must be only
true or ignored)
dropdown_options for $cb must be non empty
array
equation equation_form is invalid
\ninvalid type for $cb (text, dropdown only
accepted)
invalid type for $cb (type for custom field
$cb is >type) // In case of other type sent
Workorder line has started,
\n400 success
\nThe work order line has already been archived
\nCreate work order lines
\nAll the necessary information is included in the JSON file for the creation of a complete WOL. Serialized routing is included. BOMs and custom fields are configured inside the Epoptia Software.
\nRequired fields and explanations.
\nAll the fields with the symbol (*) in front of them must be fulfilled.
All the other fields can be left blank, \"\", or not included at all.
* \"status\"
\n\"new\" for new wols
\n\"update\" for making changes to existing ones
\n* \"workorderline_id\" // Remote wol id
\n\"production_status\" // Set the status of the wol
\n\"production\"
\n\"standby\"
\n\"description\" // Remote description of wol
\n\"overUnderPercentage\" // Declare the percentage of Over & Under Production. Allowed values 1-99. It is not mandatory to be included at json files.
\n* \"quantity\" // Desired produced quantity
\n* \"target_day\" // WOL target completion date (yyyy-mm-dd)
\n\"comments\" // Remote WOL comments
\n\"workflow_id\" // Epoptia's Template Workflow Id. If not used, do not add it to the JSON file. If erp_routing is used, do not add it to the JSON file.
\n\"wol_tag\" // Can be used to separate different kinds of work order lines inside the same Manufacturing Board. We suggest using the wol_tags for your different series of production orders.
\n\"files\" // Add files to specific work order line. Do not include the whole object if there are no files, If more than one, include it in an array.
\n*id\" // Remote id
\n*\"name\" // Remote name
\n*\"type\" // Types supported jpg, png, pdf
\n*\"path\" // Public path
\n* \"workorder\"
\n* \"id\" // Remote WO id
\n* \"code\" // Remote WO code
\n\"comments\" // Remote WO comments
\n\"files\" // Add files to a specific work order. Do not include the whole object if there are no files, If more than one, include it in an array.
\n*id\" // Remote id
\n*\"name\" // Remote name
\n*\"type\" // Types supported jpg, png, pdf
\n*\"path\" // Public path
\n*\"product\"
\n* \"id\" // Remote id
\n* \"name\" // Remote product description
\n\"category_tag\" // It can be used to determine the different categories of products.
\n\"files\" // Add files directly to the product's master data. Do not include the whole object if there are no files, If more than one, include it in an array.
\n\"thumbnail\" // Add thumbnail directly to product's master data. Not include the whole object if there are no files
\n* id\" // Remote id
\n* \"name\" // Remote name
\n* \"type\" // Types supported jpg, png, pdf
\n* \"path\" // Public path
\n\"client\"
\n* \"id\" // Remote id
\n* \"name\" // Remote name
\n\"email\" // Client's email (Include only one)
\n\"phone_number\" // Client's phone number (Include only one)
\n\"code\" // Remote code
\n\"thumbnail\" // Add thumbnail directly to product's master data. Not include the whole object if there are no files
\n*id\" // Remote id
\n*\"name\" // Remote name
\n*\"type\" // Types supported jpg, png, pdf
\n*\"path\" // Public path
\n\"customFields\"
\n* \"id\" // Remote id
\n* \"name\" // Remote name
\n* \"value\" // Value
\n\"groupId\" // Used to acquire the category remote ID of the custom fields. Integer.
\n\"groupName\" // Used to acquire the category name of the custom fields. Integer.
\n\"notUpdate\" // Used to not update the specific value even if it is changed by administrators and operators at Epoptia MES. Only TRUE is accepted. If not used, do not include it in the JSON file.
\n* \"type\" // If not included type \"Text\" considered by default
\nCustom field types:
\n\"text\"
\n\"dropdown\"
\n\"bom\"
\n*\"id\" // Remote id
\n*\"name\" // Remote name
\n*\"value\" // Value
\n\"groupId\" // Used to acquire the category remote ID of the custom fields. Integer.
\n\"groupName\" // Used to acquire the category name of the custom fields. Integer.
\n\"notUpdate\" // Used to not update the specific value even if it is changed by administrators and operators at Epoptia MES. Only TRUE is accepted. If not used, do not include it in the JSON file.
\nerp_routing
\n* workstationId // Remote workstation id
\nIf \"job_tag\" is used the following is required.
\nImportant notes:
\nWO client, WOLs produced quantity, and workflow value can be updated only if the production orders have not started inside production.
\nIf they have already started, a system alarm is triggered providing information about the specific action.
\nBOMs, custom fields, and comments can be updated at any time.
\nResponses
\nstatus is missing
\nstatus value is invalid
\nworkorderline_id is missing
\ninvalid value for workorderline_id
\nid is missing from wol_tag
\nname is missing from wol_tag
\ninvalid value for workorder_line target_day
\ntarget_day is missing
\ninvalid value for production_status (must be
production or standby)
quantity is missing
\ninvalid value for quantity
\nchoose erp_routing or workflow_id
\ninvalid value for workflow_id
\nworkorder id is missing
\ninvalid value for workorder id
\nworkorder code is missing
\ninvalid value for workorder code
\ninvalid value for workorder
\nproduct id is missing
\ninvalid value for product id
\nproduct name is missing
\ninvalid value for product name
\nproduct is missing
\nid is missing from category_tag
\nname is missing from category_tag
\ninvalid value for client id
\nclient id is missing
\nclient name is missing
\ninvalid value for client name
\nclient is missing
\nid is missing at product thumbnail
\nname is missing at product thumbnail
\ntype is missing at product thumbnail
\npath is missing at product thumbnail
\ntype is invalid at product thumbnail
(png,jpg,jpeg,pdf are accepted)
id is missing at client thumbnail
\nname is missing at client thumbnail
\ntype is missing at client thumbnail
\npath is missing at client thumbnail
\ntype is invalid at client thumbnail
(png,jpg,jpeg,pdf are accepted)
For workorder_line_files, workorder_files & product_files
\nid is missing
\nname is missing
\ntype is missing
\ntype is invalid (png,jpg,jpeg,pdf are
accepted)
path is missing
\nFor customFields & bom
\ninvalid value for $cb id
\n$cb name is missing
\ninvalid value for $cb name
\ninvalid value for $cb notUpdate (must be only
true or ignored)
dropdown_options for $cb must be non empty
array
equation equation_form is invalid
\ninvalid type for $cb (text, dropdown only
accepted)
invalid type for $cb (type for custom field
$cb is >type) // In case of other type sent
Workorder line has started
\nThe work order line has already been archived
\n400 success
\nchoose erp_routing or workflow_id
\ninvalid erp_routing
\nremoteId is missing from job_tag
\nThe same workstation can be used more than one,
only if job tasks are assigned
Create work order lines
\nAll the necessary information is included in the JSON file for the creation of a complete WOL. Parallel Routing is included and custom fields are configured inside the Epoptia Software.
\nThis method will create a specific workflow for the specific work order line, and if the product does not have any workflow assigned, it will assign the workflow to the product for future use.
\nJob_tasks can be used for providing separate tasks at the same workstation.
\nElement ids, are used to determine the unique identification of the remote database for the specific workstation in combination with the operation.
\nRequired fields and explanations.
\nAll the fields with the symbol (*) in front of them must be fulfilled.
All the other fields can be left blank, \"\", or not included at all.
* \"status\"
\n\"new\" for new wols
\n\"update\" for making changes to existing ones
\n* \"workorderline_id\" // Remote wol id
\n\"production_status\" // Set the status of the wol
\n\"production\"
\n\"standby\"
\n\"description\" // Remote description of wol
\n\"overUnderPercentage\" // Declare the percentage of Over & Under Production. Allowed values 1-99. It is not mandatory to be included at json files.
\n* \"quantity\" // Desired produced quantity
\n* \"target_day\" // WOL target completion date (yyyy-mm-dd)
\n\"comments\" // Remote WOL comments
\n\"workflow_id\" // Epoptia's Template Workflow Id. If not used, do not add it to the JSON file. If erp_routing is used, do not add it to the JSON file.
\n\"wol_tag\" // Can be used to separate different kinds of work order lines inside the same Manufacturing Board. We suggest using the wol_tags for your different series of production orders.
\n\"files\" // Add files to specific work order line. Do not include the whole object if there are no files, If more than one, include it in an array.
\n*id\" // Remote id
\n*\"name\" // Remote name
\n*\"type\" // Types supported jpg, png, pdf
\n*\"path\" // Public path
\n* \"workorder\"
\n* \"id\" // Remote WO id
\n* \"code\" // Remote WO code
\n\"comments\" // Remote WO comments
\n\"files\" // Add files to a specific work order. Do not include the whole object if there are no files, If more than one, include it in an array.
\n*id\" // Remote id
\n*\"name\" // Remote name
\n*\"type\" // Types supported jpg, png, pdf
\n*\"path\" // Public path
\n*\"product\"
\n* \"id\" // Remote id
\n* \"name\" // Remote product description
\n\"category_tag\" // It can be used to determine the different categories of products.
\n\"files\" // Add files directly to the product's master data. Do not include the whole object if there are no files, If more than one, include it in an array.
\n\"thumbnail\" // Add thumbnail directly to product's master data. Not include the whole object if there are no files
\n* id\" // Remote id
\n* \"name\" // Remote name
\n* \"type\" // Types supported jpg, png, pdf
\n* \"path\" // Public path
\n\"client\"
\n* \"id\" // Remote id
\n* \"name\" // Remote name
\n\"email\" // Client's email (Include only one)
\n\"phone_number\" // Client's phone number (Include only one)
\n\"code\" // Remote code
\n\"thumbnail\" // Add thumbnail directly to product's master data. Not include the whole object if there are no files
\n*id\" // Remote id
\n*\"name\" // Remote name
\n*\"type\" // Types supported jpg, png, pdf
\n*\"path\" // Public path
\n\"customFields\"
\n* \"id\" // Remote id
\n* \"name\" // Remote name
\n* \"value\" // Value
\n\"groupId\" // Used to acquire the category remote ID of the custom fields. Integer.
\n\"groupName\" // Used to acquire the category name of the custom fields. Integer.
\n\"notUpdate\" // Used to not update the specific value even if it is changed by administrators and operators at Epoptia MES. Only TRUE is accepted. If not used, do not include it in the JSON file.
\n* \"type\" // If not included type \"Text\" considered by default
\nCustom field types:
\n\"text\"
\n\"dropdown\"
\n\"bom\"
\n*\"id\" // Remote id
\n*\"name\" // Remote name
\n*\"value\" // Value
\n\"groupId\" // Used to acquire the category remote ID of the custom fields. Integer.
\n\"groupName\" // Used to acquire the category name of the custom fields. Integer.
\n\"notUpdate\" // Used to not update the specific value even if it is changed by administrators and operators at Epoptia MES. Only TRUE is accepted. If not used, do not include it in the JSON file.
\nerp_routing
\n* workstationId // Remote workstation id
\nworkstationName // Name of the workstation
\n* elementId // Unique identification for combination of the workstation and operation for the specific wol
\nprevious // the elementId of the previous operation, if exists
\npass // Determines the rule for proceeding the wol from one workstation to another. Available values: Str , SemiStr , Free
\ntarget // the target time in minutes
\nIf \"job_tag\" is used the following is required.
\nImportant notes:
\nWO client, WOLs produced quantity, and workflow value can be updated only if the production orders have not started inside production.
\nIf they have already started, a system alarm is triggered providing information about the specific action.
\nBOMs, custom fields, and comments can be updated at any time.
\nResponses
\nstatus is missing
\nstatus value is invalid
\nworkorderline_id is missing
\ninvalid value for workorderline_id
\nid is missing from wol_tag
\nname is missing from wol_tag
\ninvalid value for workorder_line target_day
\ntarget_day is missing
\ninvalid value for production_status (must be
production or standby)
quantity is missing
\ninvalid value for quantity
\nchoose erp_routing or workflow_id
\ninvalid value for workflow_id
\ninvalid erp_routing
\nremoteId is missing from job_tag
\nThe same workstation can be used more than one,
only if job tasks are assigned
elementId is missing
\nerp routing has cycle
\nworkorder id is missing
\ninvalid value for workorder id
\nworkorder code is missing
\ninvalid value for workorder code
\ninvalid value for workorder
\nproduct id is missing
\ninvalid value for product id
\nproduct name is missing
\ninvalid value for product name
\nproduct is missing
\nid is missing from category_tag
\nname is missing from category_tag
\ninvalid value for client id
\nclient id is missing
\nclient name is missing
\ninvalid value for client name
\nclient is missing
\nid is missing at product thumbnail
\nname is missing at product thumbnail
\ntype is missing at product thumbnail
\npath is missing at product thumbnail
\ntype is invalid at product thumbnail
(png,jpg,jpeg,pdf are accepted)
id is missing at client thumbnail
\nname is missing at client thumbnail
\ntype is missing at client thumbnail
\npath is missing at client thumbnail
\ntype is invalid at client thumbnail
(png,jpg,jpeg,pdf are accepted)
For workorder_line_files, workorder_files & product_files
\nid is missing
\nname is missing
\ntype is missing
\ntype is invalid (png,jpg,jpeg,pdf are
accepted)
path is missing
\nFor customFields & bom
\ninvalid value for $cb id
\n$cb name is missing
\ninvalid value for $cb name
\ninvalid value for $cb notUpdate (must be only
true or ignored)
dropdown_options for $cb must be non empty
array
equation equation_form is invalid
\ninvalid type for $cb (text, dropdown only
accepted)
invalid type for $cb (type for custom field
$cb is >type) // In case of other type sent
Workorder line has started,
\nErp route cannot change
\n400 success
\nchoose erp_routing or workflow_id
\ninvalid erp_routing
\nremoteId is missing from job_tag
\nThe same workstation can be used more than one,
only if job tasks are assigned
Specific changes to work order lines.
\nIn this link, a specific change can be sent in a specific work order line without affecting the rest (wol details, Routing, CustomFields, Boms.)
\nWhatever is sent from the available data will be updated. i.e. if there is a change to the target day, only the \"target_day\" may be sent.
\nIf the work order line does not exist, an error returns.
\nforce_qty is used to force the change of the quantity even if it has been started. The change will happen when the work order line is not working and only if the quantity that has been completed is less or equal with the quantity that is send at the field force_qty
\nResponses
\nThe same as the link /synchronize.
\nforce_qty cannot be applied, wol is working
\nforce_qty cannot be applied. Quantity done is more than forced qty change
\n","urlObject":{"protocol":"https","path":["api","3.03","workorderlines"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc7c61b2-d9e6-45c2-b0dc-e526d6144f27"},{"name":"Insert Extra or Update Custom Fields & BOMs","id":"cbb3bf84-d12a-4471-9d4f-c73e1445954b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Auth-Token"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": [\r\n {\r\n \"workorderline_id\": \"131320\",\r\n \"bom_id\": \"23234\",\r\n \"name\": \"drawer\",\r\n \"code\": \"23234\",\r\n \"notUpdate\": true,\r\n \"elements\": [\"204\"],\r\n \"rule\": {\r\n \"show\": true,\r\n \"mandatory_editable\": false,\r\n \"editable\": true,\r\n \"is_check\": false \r\n },\r\n \"attribute\": [{\r\n \"initial\": \"1\",\r\n \"friendlyName\": \"name1\",\r\n \"friedlyCode\": \"code1\",\r\n \"comments\": \"comment1\"\r\n },\r\n {\r\n \"initial\": \"2\",\r\n \"friendlyName\": \"name2\",\r\n \"friedlyCode\": \"code2\",\r\n \"comments\": \"comment2\"\r\n },\r\n {\r\n \"initial\": \"3\",\r\n \"friendlyName\": \"name3\",\r\n \"friedlyCode\": \"code3\",\r\n \"comments\": \"comment3\"\r\n }\r\n ] \r\n },\r\n {\r\n \"workorderline_id\": \"131320\",\r\n \"bom_id\": \"23234\",\r\n \"name\": \"drawer\",\r\n \"code\": \"23234\",\r\n \"notUpdate\": true,\r\n \"value\":\"1\",\r\n \"elements\": [\"208\",\"209\"],\r\n \"rule\": {\r\n \"show\": true,\r\n \"mandatory_editable\": false,\r\n \"editable\": false,\r\n \"is_check\": false \r\n } \r\n },\r\n {\r\n \"workorderline_id\": \"131320\",\r\n \"customField_id\": \"234\",\r\n \"name\": \"Width\",\r\n \"value\": \"2mm\",\r\n \"notUpdate\": true,\r\n \"type\": \"text\",\r\n \"elements\": [\"208\",\"209\"],\r\n \"rule\": {\r\n \"show\": true,\r\n \"mandatory_editable\": false,\r\n \"editable\": false,\r\n \"is_check\": false \r\n } \r\n },\r\n {\r\n \"workorderline_id\": \"131320\",\r\n \"customField_id\": \"9841108\",\r\n \"name\": \"material selection\",\r\n \"value\": \"Option 1\",\r\n \"notUpdate\": true,\r\n \"type\": \"dropdown\",\r\n \"elements\": [\"208\",\"209\"],\r\n \"dropdown_options\": [\r\n \"Option 2\",\r\n \"Option 3\"\r\n ],\r\n \"rule\": {\r\n \"show\": true,\r\n \"mandatory_editable\": false,\r\n \"editable\": false,\r\n \"is_check\": false \r\n }\r\n },\r\n {\r\n \"workorderline_id\": \"131320\",\r\n \"customField_id\": \"123013\",\r\n \"name\": \"Diameter calculation\",\r\n \"value\": null,\r\n \"type\": \"equation\",\r\n \"code\": \"DAH13\",\r\n \"elements\": [\"208\",\"209\"],\r\n \"equation_form\": \"(4*(((x**2)-(54**2))/7)* 789 *887*345)/800\",\r\n \"rule\": {\r\n \"show\": true,\r\n \"mandatory_editable\": false,\r\n \"editable\": false,\r\n \"is_check\": false \r\n }\r\n },\r\n {\r\n \"workorderline_id\": \"131320\",\r\n \"customField_id\": \"123016\",\r\n \"name\": \"Diameter measurement\",\r\n \"value\": null,\r\n \"type\": \"limit\",\r\n \"code\": \"DIAM\",\r\n \"elements\": [\"208\",\"209\"],\r\n \"limit_up\": \"250\",\r\n \"limit_down\": \"260\",\r\n \"rule\": {\r\n \"show\": true,\r\n \"mandatory_editable\": false,\r\n \"editable\": false,\r\n \"is_check\": false,\r\n \"strict_comparison\": true \r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{baseUrl}}/api/3.03/workorderlines/customfields","description":"Insert or Update specific customfields to workorderlines. This method does not affect the rest functions and objects of work order lines.
\nAt one post request, multiple work order lines, customfields & boms can be updated.
\nRequired Fields
\nResponses
\neither customfield_id or bom_id are required
customfield_id is missing
invalid customfield_id
bom_id is missing
invalid bom_id
invalid elements
invalid elements
Delete specific Custom Fields & BOMs from work order lines.
\nRequired fields and explanations.
\nAll the fields with the symbol (*) in front of them must be fulfilled.
\n\"workorderline_id // Remote work order line id
\n\"customfield_id\" // Remote custom field id
\n\"bom_id\" // Remote bom id
\nResponses
\nInsert or Update workstations at the workflows.
\nAn update to a specific workstation will be made, only if the workstation has not started.
\nWorkorderline must exist.
\nInserts and updates can be made even if the workstation does not exist. It will be created the exact same time
\nRequired fields:
\nResponses
\nworkorderline_id is missing
invalid workorderline_id
workorderline_id must have custom workflow
elementId is missing
element has hits
next is missing
previous is missing
workstationId is missing
invalid next or previous
erp routing has cycle
remoteId is missing from job_tag
invalid tag remoteId
Delete specific element ids at workflows.
\nRequired fields
\nResponses
\ninvalid element_ids is missing
element_ids must be a non empty array
invalid element_ids
elements have hits
Delete work orders
\nAll work order lines of the work order will be deleted, except those that have not stared
\nRequired fields
\nResponses
\nenter workorderline_id or workorder_id
invalid value for workorderline_id
unknown workorderline_id
invalid value for workorder_id
either workorderline_id or workorder_id is missing
Delete specific work order lines
\nRequired fields
\nSend work orders to Archive
\nAll work order lines of the work order will be sent to the Archive
\nRequired fields
\nResponses
\nenter workorderline_id or workorder_id
invalid value for workorderline_id
unknown workorderline_id
invalid value for workorder_id
either workorderline_id or workorder_id is missing
Send specific work order lines to the Archive
\nRequired fields
\nResponses
\nenter workorderline_id or workorder_id
invalid value for workorderline_id
unknown workorderline_id
invalid value for workorder_id
either workorderline_id or workorder_id is missing
The work order line has already been archived
\n","urlObject":{"protocol":"https","path":["api","3.03","send-to-archive"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b7bf3acc-0db4-42a3-8d03-3594476c975e"}],"id":"5d270027-6f40-465a-8df2-676ab6f4c10a","_postman_id":"5d270027-6f40-465a-8df2-676ab6f4c10a","description":""}],"id":"9a58389e-43bb-41be-9e6d-bffd3c43a415","description":"All available API requests for creation, update and management of Work Order Lines & Work Orders
\n","_postman_id":"9a58389e-43bb-41be-9e6d-bffd3c43a415"},{"name":"Users, Operators & Shifts","item":[{"name":"Add Users & Operators","id":"c3f868c4-a6b9-4e5c-a534-910e72fd7b6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Auth-Token"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": [{\r\n \"type\": \"admin\",\r\n \"name\": \"John Bravos\",\r\n \"username\": \"john_bravos\",\r\n \"password\": \"@dscsd2312\",\r\n \"id\": \"5845\",\r\n \"email\": \"johnb@gmail.com\",\r\n \"boards\": [\"5845\", \"5846\"],\r\n //\"shift_id\":\"23\",\r\n \"shift\": {\r\n \"shift_id\": \"23\",\r\n \"name\": \"Afternoon Shift\",\r\n \"start\": \"09:00:00\",\r\n \"end\": \"15:00:00\",\r\n \"break_start\": \"12:00:00\",\r\n \"break_end\": \"12:10:00\",\r\n \"working_days\": \"1,2,3,4\"\r\n },\r\n \"language\": \"en\"\r\n },\r\n {\r\n \"type\": \"admin\",\r\n \"name\": \"Pit Reyes\",\r\n \"username\": \"Pit\",\r\n \"password\": \"@dscsd2312\",\r\n \"id\": \"5845\",\r\n \"email\": \"pit34@gmail.com\",\r\n \"workstations\": [\"6985\"],\r\n //\"shift_id\":\"23\",\r\n \"shift\": {\r\n \"shift_id\": \"23\",\r\n \"name\": \"Afternoon Shift\",\r\n \"start\": \"09:00:00\",\r\n \"end\": \"15:00:00\",\r\n \"break_start\": \"12:00:00\",\r\n \"break_end\": \"12:10:00\",\r\n \"working_days\": \"1,2,3,4\"\r\n },\r\n \"language\": \"en\"\r\n }, \r\n {\r\n \"type\": \"operator\",\r\n \"name\": \"Jeff Benbar\",\r\n \"username\": \"Jeff\",\r\n \"pin\": \"123456\",\r\n \"id\": \"6853\",\r\n //\"shift_id\":\"23\",\r\n \"shift\": {\r\n \"shift_id\": \"23\",\r\n \"name\": \"Afternoon Shift\",\r\n \"start\": \"09:00:00\",\r\n \"end\": \"15:00:00\",\r\n \"break_start\": \"12:00:00\",\r\n \"break_end\": \"12:10:00\",\r\n \"working_days\": \"1,2,3,4\"\r\n },\r\n \"language\": \"en\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{baseUrl}}/api/3.03/synchronize-users","description":"Create users. Administrators and operators.
\nRequired fields.
\nAccepted values for \"language\" are (en, el, it) for English, Greek, Italian
\nCaution
\nThe username should not include special characters. Only english charactes are supported. I.e. pit_colins (Not pit colins)
\nThe same username & email cannot be used for more than 1 user.
\nOperator PIN is not mandatory.
\nBoards and Workstations must exist before sending them.
\nAnytime configuration is sent, replace the existing one
\nEither shift_id or shift object can be used. When sent to the shift object, the shift is created or updated.
\nResponses
\nid is missing
name is missing
username is missing
username already exists
username cannot contain special characters
invalid language
type is missing
invalid type (accepted admin, operator)
password is missing
invalid email
user email already exists
please set shift_id or shift
\n","urlObject":{"protocol":"https","path":["api","3.03","synchronize-users"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3f868c4-a6b9-4e5c-a534-910e72fd7b6d"},{"name":"Delete Users","id":"d1e0d813-13f3-4508-8760-ea10c77692ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Auth-Token"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": [\r\n {\r\n \"user_id\": \"5845\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{baseUrl}}/api/3.03/users","description":"Delete specific users.
\nSoft deletion is made if there are actions from the specific user.
\nRequired fields
\nResponses
\ninvalid user_id
\n","urlObject":{"protocol":"https","path":["api","3.03","users"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d1e0d813-13f3-4508-8760-ea10c77692ae"},{"name":"Login Operator","id":"d75325b1-1b06-4faa-b6b9-a0ea41598e62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Auth-Token"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": [\r\n {\r\n \"username\": \"john2\",\r\n \"password\": \"123\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{baseUrl}}/api/3.03/login-operator","description":"Login operators
\nRequired fields.
\nFor machine integration or virtual users, a token is generated for further use such as Logout
\nResponses
\nusername is required
password is required
user login failed
Logout operators
\nRequired fields.
\nResponses
\nuserId is missing
invalid userId
Create shifts
\nRequired fields
\nCaution
\nIf working days are not set, the defaults are 1,2,3,4,5
\n(Monday to Friday)
\nResponses
\nshift_id is missing
shift name is missing
start is missing
start value is invalid
end is missing
end value is invalid
end value must be greater than start value
break_start value is invalid
break_end value is invalid
break_end value must be greater than break_start value
working_days value is invalid
Delete specific shifts
\nSoft deletion is done, if the shift has been used.
\nRequired fields
\nResponses
\ninvalid shift_id
\n","urlObject":{"protocol":"https","path":["api","3.03","shifts"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5d786e1a-cbc6-4582-b993-0b74bd647197"}],"id":"5098b670-fc6d-43a5-8dde-7311c4a64642","_postman_id":"5098b670-fc6d-43a5-8dde-7311c4a64642","description":""},{"name":"Products","item":[{"name":"Add Products","id":"c3730669-3a44-4716-ad28-249f49870672","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Auth-Token"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\":[\r\n \t\t{\r\n \t \"name\": \"product10\",\r\n \t\t\t \"id\": \"11110\",\r\n \t \"code\": \"prod1\",\r\n \t \"comments\": \"remote_comments prod1\",\r\n \"category_tag\" : [\r\n {\r\n \"id\": \"44440\",\r\n \"name\": \"pumps\"\r\n },\r\n {\r\n \"id\": \"6597\",\r\n \t \"name\": \"plunger\"\r\n }],\r\n \"files\": [{\r\n \t\t\"id\": \"9898\",\r\n \t\t\"name\": \"test_image_at_product\",\r\n \t\t\"type\": \"jpg\",\r\n \t\t\"path\": \"https://epoptia.com/wp-content/uploads/2021/07/workstation3.jpg\"\r\n }],\r\n \t\t\"thumbnail\": {\r\n \t\t\"id\": \"8989\",\r\n \t\t\"name\": \"test_thumbnail_at_product\",\r\n \t\t\"type\": \"jpg\",\r\n \t\t\"path\": \"https://epoptia.com/wp-content/uploads/2021/12/laser-ga5579cbb5_1280.jpg\"\r\n \t}\r\n \t},\r\n \t\t\t{\r\n \t\t\t\"name\": \"product77\",\r\n \t\t\t \"id\": \"343775\",\r\n \t\t\t\"code\": \"prod7\",\r\n \t\t\t\"comments\": \"remote_comments73\",\r\n \"category_tag\" : [{\r\n \t\"id\": \"2379\",\r\n \t\"name\": \"valve\"\r\n }\r\n ],\r\n \"bom\":[ \r\n {\r\n \"id\":\"767676\",\r\n \"name\": \"drawer76\",\r\n \"value\":\"1\",\r\n \"code\": \"767676\",\r\n \"groupId\": \"\",\r\n \"groupName\": \"\",\r\n \"notUpdate\" : true\r\n },\r\n {\r\n \"id\":\"7676777\",\r\n \"name\": \"drawer72\",\r\n \"code\": \"7676777\",\r\n \"value\":\"3\",\r\n \"groupId\": \"\",\r\n \"groupName\": \"\",\r\n \"notUpdate\" : true\r\n }\r\n ],\r\n \"files\": [{\r\n \t\t\"id\": \"4534456\",\r\n \t\t\"name\": \"test2_image_at_product\",\r\n \t\t\"type\": \"jpg\",\r\n \t\t\"path\": \"https://epoptia.com/wp-content/uploads/2021/07/workstation3.jpg\"\r\n }],\r\n \t\t\"thumbnail\": {\r\n \t\t\"id\": \"45657567\",\r\n \t\t\"name\": \"test_thumbnail2_at_product\",\r\n \t\t\"type\": \"jpg\",\r\n \t\t\"path\": \"https://epoptia.com/wp-content/uploads/2021/12/laser-ga5579cbb5_1280.jpg\"\r\n \t}\r\n \t}\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{baseUrl}}/api/3.03/synchronize-products","description":"Create products as master data.
\nRequired fields
\nResponses
\nproduct id is missing
invalid value for product id
product name is missing
invalid value for product name
invalid value for workflow_id
invalid value for workflow_id
Create Clients as master data
\nRequired fields.
\nResponses
\ninvalid value for id
id is missing
invalid value for name
name is missing
Get request retrieving Epoptia's workflow templates
\n","urlObject":{"protocol":"https","path":["api","3.03","workflows-get"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e2af8849-4979-45c1-b204-fa0250c7c6a8"},{"name":"Get Test API Connection","id":"930106e5-f17b-4575-8b17-9e842765c436","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Auth-Token"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{baseUrl}}/api/3.03/test-connection","description":"Get request for connection test
\n","urlObject":{"protocol":"https","path":["api","3.03","test-connection"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"930106e5-f17b-4575-8b17-9e842765c436"},{"name":"Get Workorderlines info. Array of wols","id":"4ab39ba0-14f3-446a-977b-f51232e33090","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Auth-Token"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{baseUrl}}/api/3.03/workorderlines?ids=46154&page=1&limit=20","description":"Get request, for retrieving information about work order lines in an array.
\nInformation can be very large. The data will be sent with pagination per 20s. The response will also include how many there are in total, now it's the current page, the previous, and the next.
\nTo have access to the information you should send the page parameter to the query.
\nYou can set how many will come per page with the limit parameter. Max limit = 100.
\n","urlObject":{"protocol":"https","path":["api","3.03","workorderlines"],"host":["{{baseUrl}}"],"query":[{"key":"ids","value":"46154"},{"key":"page","value":"1"},{"key":"limit","value":"20"}],"variable":[]}},"response":[],"_postman_id":"4ab39ba0-14f3-446a-977b-f51232e33090"},{"name":"Get Workorderlines info. Created date","id":"2f8bee16-5b75-49c0-bd83-31bc5551fdef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Auth-Token"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{baseUrl}}/api/3.03/workorderlines?createdAtStart=2023-09-28&createdAtEnd=2023-09-28&page=1&limit=20","description":"The date refers to the creation date of the work order lines, which is when it was first sent to the API.
\nInformation can be very large. The data will be sent with pagination per 20s. The response will also include how many there are in total, now it's the current page, the previous, and the next.
\nTo have access to the information you should send the page parameter to the query.
\nYou can set how many will come per page with the limit parameter. Max limit = 100.
\nανά page με τη παράμετρο limit. Max limit = 100.
\n","urlObject":{"protocol":"https","path":["api","3.03","workorderlines"],"host":["{{baseUrl}}"],"query":[{"key":"createdAtStart","value":"2023-09-28"},{"key":"createdAtEnd","value":"2023-09-28"},{"key":"page","value":"1"},{"key":"limit","value":"20"}],"variable":[]}},"response":[],"_postman_id":"2f8bee16-5b75-49c0-bd83-31bc5551fdef"},{"name":"Get Workorderlines info. Completed","id":"a5a9adeb-7312-4d80-8b92-e31f653dac7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Auth-Token"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{baseUrl}}/api/3.03/workorderlines?hitStart=2025-01-29&hitEnd=2025-01-29&limit=50&operatorIds=1015&workstationIds=9058","description":"hitStart date refers to the date that the action started.
\nhitEnd date refers to the date that the action completed.
\noperatorsIds refers to the remote id of the operator that did the actions
\nworkstationIds refers to the remote id of the workstation that the action was undertook.
\nInformation can be very large. The data will be sent with pagination per 20s. The response will also include how many there are in total, now it's the current page, the previous, and the next.
\nTo have access to the information you should send the page parameter to the query.
\nYou can set how many will come per page with the limit parameter. Max limit = 100.
\n","urlObject":{"protocol":"https","path":["api","3.03","workorderlines"],"host":["{{baseUrl}}"],"query":[{"key":"hitStart","value":"2025-01-29"},{"key":"hitEnd","value":"2025-01-29"},{"key":"limit","value":"50"},{"key":"operatorIds","value":"1015"},{"key":"workstationIds","value":"9058"}],"variable":[]}},"response":[],"_postman_id":"a5a9adeb-7312-4d80-8b92-e31f653dac7a"},{"name":"Get Workstations","id":"77208375-eed0-4d89-aac6-8a17eff1103f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Auth-Token"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://{{baseUrl}}/api/3.03/workstations-get","description":"Get request retrieving workstations details
\n","urlObject":{"protocol":"https","path":["api","3.03","workstations-get"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"77208375-eed0-4d89-aac6-8a17eff1103f"},{"name":"Get Boards","id":"ea7efc62-3ee4-497d-b9a6-ce73ff902f6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Auth-Token"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://{{baseUrl}}/api/3.03/workstations-get","description":"Get request retrieving boards details
\n","urlObject":{"protocol":"https","path":["api","3.03","workstations-get"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea7efc62-3ee4-497d-b9a6-ce73ff902f6e"},{"name":"Get Users","id":"82b01da2-c587-4f88-b5c7-2c32050646f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Auth-Token"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://{{baseUrl}}/api/3.03/users-get","description":"Get request retrieving users details
\n","urlObject":{"protocol":"https","path":["api","3.03","users-get"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"82b01da2-c587-4f88-b5c7-2c32050646f7"},{"name":"Get Failed Webhooks","id":"dbc03d90-203f-413a-9eaa-4a004a1c5c8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Auth-Token"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{baseUrl}}/api/3.03/failed-webhooks?dateFrom=2025-15-12&dateTo=2025-15-12&resend=false&page=1&limit=20","description":"Get request, for retrieving information about failed webhooks in an array, with the capability of resend them.
\nInformation can be very large. The data will be sent with pagination with maximum limit 100. The response will also include how many there are in total, now it's the current page, the previous, and the next.
\nTo have access to the information you should send the page parameter to the query.
\nYou can set how many will come per page with the limit parameter. Max limit = 100.
\nParameters dateFrom & dateTo are required for providing the failed webhooks inside the specific range.
\nParameter eventId is not required. It is used to filter specific webhook events:
\n'1', 100% work order line completion
\n'2', Workorderline send to historical
\n'3', Button pressed manually from work order line
\n'4', Specific workstation finish job
\n'5', Change work order line completion date
\n'6', Alarm start/end
\n'7', Work In Progress (Workorderline Start)
\n'8', Work In Progress (Specific Workstation Start)
\n'10', Delete an Epoptia work order line manually
\nParameter resend is not required. It is used to trigger the webhook mechanism.
\nWhen resend=true the mechanism will resend the requested webhooks with a priority.
\nWhen resend=false the mechanism will not resend the requested webhooks.
\n","urlObject":{"protocol":"https","path":["api","3.03","failed-webhooks"],"host":["{{baseUrl}}"],"query":[{"key":"dateFrom","value":"2025-15-12"},{"key":"dateTo","value":"2025-15-12"},{"key":"resend","value":"false"},{"key":"page","value":"1"},{"key":"limit","value":"20"}],"variable":[]}},"response":[],"_postman_id":"dbc03d90-203f-413a-9eaa-4a004a1c5c8e"}],"id":"cd7fd853-e2f3-4259-9a1b-3dd338b4ca30","_postman_id":"cd7fd853-e2f3-4259-9a1b-3dd338b4ca30","description":""},{"name":"Manufacturing Boards","item":[{"name":"Add Manufacturing Boards","id":"e6dc58c5-bba0-4188-8010-5899fe24580d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Auth-Token"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"data\": [\r\n{\r\n \"id\": \"5845\",\r\n \"name\": \"Factory 1\",\r\n \"code\": \"F100\",\r\n \"wol_tag\" : [{\r\n \"id\": \"3432\",\r\n \"name\": \"order series 1\"\r\n }]\r\n},\r\n{\r\n \"id\": \"5846\",\r\n \"name\": \"Factory 2\",\r\n \"code\": \"F102\",\r\n \"wol_tag\" : [{\r\n \"id\": \"4432\",\r\n \"name\": \"order series 2\"\r\n }]\r\n}\r\n]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{baseUrl}}/api/3.03/synchronize-boards","description":"Create Manufacturing Boards
\nRequired fields
\nResponses:
\nBoard limitation. Please check your licence
\nYou don' t have access to boards api. Please check your licence
\n","urlObject":{"protocol":"https","path":["api","3.03","synchronize-boards"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e6dc58c5-bba0-4188-8010-5899fe24580d"},{"name":"Delete manufacturing boards","id":"966fa26e-1e93-4722-87a7-23b0d1142300","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Auth-Token"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": [\r\n {\r\n \"board_id\": \"5846\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{baseUrl}}/api/3.03/boards","description":"Delete Manufacturing Boards
\nSoft deletion is made
\nRequired fields
\nCreate workstations
\nRequired fields
\nDelete workstations
\nSoft deletion is made if the workstation had been used
\nRequired fields
\nControl Workstation Remotely
\nWorkstations can be controlled remotely from external software, machine, or a PLC controller.
\nRequired fields and explanations.
\nAll the fields with the symbol (*) in front of them must be fulfilled.
All the fields that are not used, should not be included.
*\"action\"
\nAvailable actions are
\n\"start\"
\n\"pause\"
\n\"cancel\"
\n\"complete\"
\n*\"workstation_id\"
\n*\"element_id\"
\n*\"workorderline_id\"
\n\"quantity\"
\n\"timestamp\": \"2024-02-22 12:35:50\"
\n\"duration\"
\nFor external software integration, the following scenario is suggested
\nThis scenario is mostly used when the external software is aware of the work order line ids. Such as an ERP.
\nThese are the steps:
\nCreate an operator in the software.
\nLogin via API.
\nGrab the generated token.
\nHave full control by sending the proper actions and having the Operator-Token at the Headers.
\nExample of Headers
\nOperator-Token: 2ntVRn16z3Y+MsfJIEzZrJUR+hw3moWoqQ==
\nHere are some examples of controlling workstations remotely.
\nExample of partial completion
\n {\n \"data\": [\n {\n \"action\": \"start\",\n \"timestamp\": \"2024-02-22 13:35:50\",\n \"workstation_id\": \"19\",\n \"workorderline_id\": \"20001\"\n },\n {\n \"action\": \"complete\",\n \"timestamp\": \"2024-02-22 13:37:50\",\n \"workstation_id\": \"19\",\n \"workorderline_id\": \"20001\",\n \"quantity\": \"2\",\n \"duration\": \"120\"\n },\n {\n \"action\": \"pause\",\n \"workstation_id\": \"19\",\n \"workorderline_id\": \"20001\"\n }\n ]\n}\n\nNote: If the workstation is not set to Pause status, the workstation will remain In Progress.
\nExample of total completion
\nIf the work order line has quantity = 200
\n {\n \"data\": [\n {\n \"action\": \"start\",\n \"timestamp\": \"2024-02-22 13:40:00\",\n \"workstation_id\": \"19\",\n \"workorderline_id\": \"20001\"\n },\n {\n \"action\": \"complete\",\n \"timestamp\": \"2024-02-22 13:57:50\",\n \"workstation_id\": \"19\",\n \"workorderline_id\": \"20001\",\n \"quantity\": \"200\",\n \"duration\": \"1070\"\n }\n ]\n}\n\nExample of total completion
\nIf the work order line has quantity = 200
\n {\n \"data\": [\n {\n \"action\": \"start\",\n \"timestamp\": \"2024-02-22 13:40:00\",\n \"workstation_id\": \"19\",\n \"workorderline_id\": \"20001\"\n },\n {\n \"action\": \"complete\",\n \"timestamp\": \"2024-02-22 13:57:50\",\n \"workstation_id\": \"19\",\n \"workorderline_id\": \"20001\",\n \"quantity\": \"200\",\n \"duration\": \"1070\"\n }\n ]\n}\n\nExample of total completion without the workflow restrictions.
\nIn the scenario that you have a workstation, and you want to complete the quantity without taking into consideration the previous and the next workstations, or any of the other workflow restrictions, you can use a \"Force\" command.
\n {\n \"data\": [\n {\n \"action\": \"complete\",\n \"timestamp\": \"2025-02-22 13:57:50\",\n \"workstation_id\": \"19\",\n \"workorderline_id\": \"20001\",\n \"element_id\":\"235646602\",\n \"quantity\": \"200\",\n \"duration\": \"1070\",\n \"force\": true\n }\n ]\n}\n\nExample of inserting duration without completion
\nIf the external source gathers information and time, then you can send this time to the specific workstation.
\n {\n \"data\": [\n {\n \"action\": \"start\",\n \"workstation_id\": \"19\",\n \"workorderline_id\": \"20001\"\n },\n {\n \"action\": \"pause\",\n \"workstation_id\": \"19\",\n \"workorderline_id\": \"20001\",\n \"duration\": \"2000\"\n }\n ]\n}\n\nthen you can send a \"complete\" action with the respective quantity and duration when a quantity completion happens.
\nFor machine integration and If the machine does not know the work order line, the following scenario is suggested
\nOperators logged in to the workstations and started one work order line.
\nThen the controller of the machine should inform the software about the action \"Complete\", without the need to know the work order line ID.
\nWorkstation id and quantity are required. Example below:
\n {\n \"data\": [\n {\n \"action\": \"start\",\n \"workstation_id\": \"19\",\n \"quantity\": \"200\"\n }\n ]\n}\n\nResponses
\nunknown workstation
\nquantity is required when action is complete
\nstamp must be greater than start time of hit (2024-02-22 12:34:13)
\nQuantity exceeds the available quantity that can be completed
\nWork order line cannot be completed. Mandatory fields have not been fulfilled.
\nWork order line cannot be started // Previous workstations have not completed quantity
\nStart of work order line cannot be canceled. 1 min threshold has been exceeded.
\nWork order line cannot be completed. Mandatory fields have not been fulfilled.
\nworkorderline_id \"XXXX\" is already working in workstation \"XX\"
\neither element_id or workstation_id are required
\nWorkstation is presented more than 1 time in the workflow. Please use element_id to control the workstations
\n","urlObject":{"protocol":"https","path":["api","3.03","ws-remote-control"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"47a34b42-133d-4ad1-a818-3b03c9f8cb45"}],"id":"f13524ed-db30-4ea5-bbef-63b8b01054f1","_postman_id":"f13524ed-db30-4ea5-bbef-63b8b01054f1","description":""}]}