{ "openapi" : "3.0.2", "info" : { "contact" : { "email" : "support@boschrexroth.com", "name" : "Bosch Rexroth AG", "url" : "https://www.boschrexroth.com" }, "description" : "The PLC Engineering API is used to generate and edit **ctrlX CORE PLC projects** that are used in automatic commissioning. \nRefer [Online Documentation](https://developer.community.boschrexroth.com/t5/Store-and-How-to/Generate-API-client-libraries-from-Engineering-API/ba-p/52314) for API client library generation.\n", "title" : "ctrlX WORKS - PLC Engineering API", "version" : "2.11.0" }, "servers" : [ { "description" : "processes the REST calls", "url" : "http://localhost:{port}/plc/engineering/api/v2", "variables" : { "port" : { "default" : "##port##", "description" : "webserver port number" } } } ], "tags" : [ { "description" : "This is the Devices view. Here you organize elements for the special devices of the current project.", "name" : "Devices" }, { "description" : "Here you can read and edit the Device repository.", "name" : "Device Repositories" }, { "description" : "Jobs are used to execute and check long running operations such as project open, close.", "name" : "Jobs" }, { "description" : "Here you can configure memory reserves for the function blocks during the online change.", "name" : "Online Change Memory Settings" }, { "description" : "This is the POUs view. Here you organize general elements of the current project.", "name" : "POUs" }, { "description" : "To get detailed version information of the installed product.", "name" : "Product" }, { "description" : "Here you have general commands for projects.", "name" : "Project" }, { "description" : "This path handles the recipes in the current project.", "name" : "Recipes" }, { "description" : "Here you can read and edit the library repository.", "name" : "Repositories" }, { "description" : "Here you can read and select public symbol variables that will be exported.", "name" : "Symbol Configuration" }, { "description" : "Here you can read and edit the task configuration and task.", "name" : "Task Configuration" }, { "description" : "Here you can configure the user management for the current project.", "name" : "Users and Groups" } ], "paths" : { "/library-repositories" : { "get" : { "operationId" : "getLibraryRepositories", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RepositoryList" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get the available library repositories\n", "tags" : [ "Repositories" ] } }, "/library-repositories/{repositoryName}" : { "get" : { "operationId" : "getLibraryRepositoryByName", "parameters" : [ { "example" : "System", "explode" : false, "in" : "path", "name" : "repositoryName", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "To get installed devices matching the query\n", "example" : "Standard", "explode" : true, "in" : "query", "name" : "find", "required" : false, "schema" : { "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryList" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get the libraries installed in the library repository \n- without query parameter: all libraries installed in the library repository\n- with query parameter: the libraries installed in the library repository matching the query\n", "tags" : [ "Repositories" ] }, "post" : { "operationId" : "addLibraryRepositoryByName", "parameters" : [ { "example" : "System", "explode" : false, "in" : "path", "name" : "repositoryName", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Path" } } }, "required" : true }, "responses" : { "201" : { "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to install a library to the library repository \n", "tags" : [ "Repositories" ] } }, "/library-repositories/{repositoryName}/{libraryDisplayName}" : { "delete" : { "operationId" : "deleteLibraryRepositoryByName", "parameters" : [ { "example" : "System", "explode" : false, "in" : "path", "name" : "repositoryName", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Displayname of the library to uninstall. Must be given with installed version!\nExample:\n MyTest, 1.0.0.0 (Testcompany)\n", "explode" : false, "in" : "path", "name" : "libraryDisplayName", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to uninstall the library from the library repository \n", "tags" : [ "Repositories" ] } }, "/device-repositories" : { "get" : { "operationId" : "getDeviceRepositories", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeviceRepositoryList" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get the available device repositories \n", "tags" : [ "Device Repositories" ] } }, "/device-repositories/{repositoryName}" : { "get" : { "operationId" : "getDeviceRepositoryByName", "parameters" : [ { "example" : "System Repository", "explode" : false, "in" : "path", "name" : "repositoryName", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "To get installed devices matching the query\n", "example" : "S20", "explode" : true, "in" : "query", "name" : "find", "required" : false, "schema" : { "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeviceList" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get the devices installed in the device repository \n- without query parameter: all devices installed in the device repository\n- with query parameter: the devices installed in the device repository matching the query\n", "tags" : [ "Device Repositories" ] }, "post" : { "operationId" : "addDeviceRepositoryByName", "parameters" : [ { "example" : "System Repository", "explode" : false, "in" : "path", "name" : "repositoryName", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeviceFilePath" } } }, "required" : true }, "responses" : { "201" : { "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to install devices to the device repository\n", "tags" : [ "Device Repositories" ] } }, "/device-repositories/{repositoryName}/{deviceName}" : { "delete" : { "operationId" : "deleteDeviceRepositoryByName", "parameters" : [ { "example" : "System Repository", "explode" : false, "in" : "path", "name" : "repositoryName", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "name of the device to uninstall .\n", "example" : "IndraDrive MPC08 (1 CCD Master +5 CCD Slaves)", "explode" : false, "in" : "path", "name" : "deviceName", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "example" : "Revision=16%230000000C", "explode" : true, "in" : "query", "name" : "version", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Examples:65\n", "explode" : false, "in" : "query", "name" : "categories", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" }, "style" : "form" } ], "responses" : { "200" : { "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "- to uninstall the device from the device repository \n- without query parameter: all devices matching the deviceName are uninstalled from the device repository \n- with query parameter: the devices matching the deviceName and query parameter are uninstalled from the device repository \n", "tags" : [ "Device Repositories" ] } }, "/jobs" : { "get" : { "operationId" : "getJobs", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/JobList" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get all jobs", "tags" : [ "Jobs" ] }, "post" : { "operationId" : "addJobs", "requestBody" : { "content" : { "application/json" : { "examples" : { "addLibCatFromDescFileJob" : { "$ref" : "#/components/examples/addLibraryCategoriesFromDescFileRequest" }, "addLibCatFromOtherLibJob" : { "$ref" : "#/components/examples/addLibraryCategoriesFromotherLibRequest" }, "applicationLoginJob" : { "$ref" : "#/components/examples/applicationLoginJobRequest" }, "applicationLogoutJob" : { "$ref" : "#/components/examples/applicationLogoutJobRequest" }, "applicationStartJob" : { "$ref" : "#/components/examples/applicationStartJobRequest" }, "applicationStopJob" : { "$ref" : "#/components/examples/applicationStopJobRequest" }, "buildJobGenerateCode" : { "$ref" : "#/components/examples/buildJobGenerateCodeRequest" }, "buildJobGenerateRuntimeSystemFiles" : { "$ref" : "#/components/examples/buildJobGenerateRuntimeSystemFilesRequest" }, "communicationSettingsJob" : { "$ref" : "#/components/examples/communicationSettingsJobRequest" }, "declarationsJobAddAllInstancePaths" : { "$ref" : "#/components/examples/declarationsJobAddAllInstancePathsRequest" }, "deviceRepositoryJobSaveDevice" : { "$ref" : "#/components/examples/deviceRepositoryJobSaveDeviceRequest" }, "deviceUserLoginJob" : { "$ref" : "#/components/examples/deviceUserLoginJobRequest" }, "deviceUserLogoutJob" : { "$ref" : "#/components/examples/deviceUserLogoutJobRequest" }, "eplanJobCreateNewProject" : { "$ref" : "#/components/examples/eplanJobCreateNewProjectRequest" }, "eplanJobImport" : { "$ref" : "#/components/examples/eplanJobImportRequest" }, "eplanJobImportEthercatParameter" : { "$ref" : "#/components/examples/eplanJobImportEthercatParameterRequest" }, "exportJob" : { "$ref" : "#/components/examples/exportJobRequest" }, "exportPlcOpenXmlJob" : { "$ref" : "#/components/examples/exportPlcOpenXmlJobRequest" }, "exportUsersAndGroupsJob" : { "$ref" : "#/components/examples/exportUsersAndGroupsJobRequest" }, "findElementsJob" : { "$ref" : "#/components/examples/findElementsJobRequest" }, "importFieldbusConfigJob" : { "$ref" : "#/components/examples/importFieldbusConfigJobRequest" }, "importJob" : { "$ref" : "#/components/examples/importJobRequest" }, "importOfflineFieldbusConfigJob" : { "$ref" : "#/components/examples/importOfflineFieldbusConfigJobRequest" }, "importPlcOpenXmlJob" : { "$ref" : "#/components/examples/importPlcOpenXmlJobRequest" }, "importUsersAndGroupsJob" : { "$ref" : "#/components/examples/importUsersAndGroupsJobRequest" }, "moveElementsJob" : { "$ref" : "#/components/examples/moveElementsJobRequest" }, "newProjectJob" : { "$ref" : "#/components/examples/newProjectJobRequest" }, "openEditorJob" : { "$ref" : "#/components/examples/openEditorJobRequest" }, "preCompileJobDisable" : { "$ref" : "#/components/examples/preCompileJobDisableRequest" }, "preCompileJobEnable" : { "$ref" : "#/components/examples/preCompileJobEnableRequest" }, "projectJobClose" : { "$ref" : "#/components/examples/projectJobCloseRequest" }, "projectJobOpen" : { "$ref" : "#/components/examples/projectJobOpenRequest" }, "projectJobSave" : { "$ref" : "#/components/examples/projectJobSaveRequest" }, "projectJobSaveAndInstallIntoLibraryRepository" : { "$ref" : "#/components/examples/projectJobSaveAndInstallIntoLibraryRepositoryRequest" }, "projectJobSaveAs" : { "$ref" : "#/components/examples/projectJobSaveAsRequest" }, "projectJobSaveAsCompiledLibrary" : { "$ref" : "#/components/examples/projectJobSaveAsCompiledLibraryRequest" }, "publishMarkedMethodsJob" : { "$ref" : "#/components/examples/publishMarkedMethodsJobRequest" }, "pubSubJobSetAsPublisher" : { "$ref" : "#/components/examples/pubSubJobSetAsPublisherRequest" }, "pubSubJobSetAsSubscriber" : { "$ref" : "#/components/examples/pubSubJobSetAsSubscriberRequest" }, "removeLibraryCategoriesJob" : { "$ref" : "#/components/examples/removeLibraryCategoriesRequest" }, "resetColdJob" : { "$ref" : "#/components/examples/resetColdRequest" }, "resetOriginJob" : { "$ref" : "#/components/examples/resetOriginRequest" }, "resetWarmJob" : { "$ref" : "#/components/examples/resetWarmRequest" }, "userManagementLogInJob" : { "$ref" : "#/components/examples/userManagementLogInJobRequest" }, "userManagementLogOutJob" : { "$ref" : "#/components/examples/userManagementLogOutJobRequest" } }, "schema" : { "$ref" : "#/components/schemas/Jobs" } } }, "required" : true }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Jobs" } } }, "description" : "Created" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to create a new job", "tags" : [ "Jobs" ] } }, "/jobs/{jobId}" : { "get" : { "operationId" : "getJobsById", "parameters" : [ { "description" : "job id", "explode" : false, "in" : "path", "name" : "jobId", "required" : true, "schema" : { "example" : "123", "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "addLibCatFromDescFileJob" : { "$ref" : "#/components/examples/addLibraryCategoriesFromDescFileResponse" }, "addLibCatFromOtherLibJob" : { "$ref" : "#/components/examples/addLibraryCategoriesFromotherLibResponse" }, "applicationLoginJob" : { "$ref" : "#/components/examples/applicationLoginJobResponse" }, "applicationLogoutJob" : { "$ref" : "#/components/examples/applicationLogoutJobResponse" }, "applicationStartJob" : { "$ref" : "#/components/examples/applicationStartJobResponse" }, "applicationStopJob" : { "$ref" : "#/components/examples/applicationStopJobResponse" }, "buildJobGenerateCode" : { "$ref" : "#/components/examples/buildJobGenerateCodeResponse" }, "buildJobGenerateRuntimeSystemFiles" : { "$ref" : "#/components/examples/buildJobGenerateRuntimeSystemFilesResponse" }, "communicationSettingsJob" : { "$ref" : "#/components/examples/communicationSettingsJobResponse" }, "declarationsJobAddAllInstancePaths" : { "$ref" : "#/components/examples/declarationsJobAddAllInstancePathsResponse" }, "deviceRepositoryJobSaveDevice" : { "$ref" : "#/components/examples/deviceRepositoryJobSaveDeviceResponse" }, "deviceUserLoginJob" : { "$ref" : "#/components/examples/deviceUserLoginJobResponse" }, "deviceUserLogoutJob" : { "$ref" : "#/components/examples/deviceUserLogoutJobResponse" }, "eplanJobCreateNewProject" : { "$ref" : "#/components/examples/eplanJobCreateNewProjectResponse" }, "eplanJobImport" : { "$ref" : "#/components/examples/eplanJobImportResponse" }, "eplanJobImportEthercatParameter" : { "$ref" : "#/components/examples/eplanJobImportEthercatParameterResponse" }, "exportJob" : { "$ref" : "#/components/examples/exportJobResponse" }, "exportPlcOpenXmlJob" : { "$ref" : "#/components/examples/exportPlcOpenXmlJobResponse" }, "exportUsersAndGroupsJob" : { "$ref" : "#/components/examples/exportUsersAndGroupsJobResponse" }, "findElementsJob" : { "$ref" : "#/components/examples/findElementsJobResponse" }, "importFieldbusConfigJob" : { "$ref" : "#/components/examples/importFieldbusConfigJobResponse" }, "importJob" : { "$ref" : "#/components/examples/importJobResponse" }, "importOfflineFieldbusConfigJob" : { "$ref" : "#/components/examples/importOfflineFieldbusConfigJobResponse" }, "importPlcOpenXmlJob" : { "$ref" : "#/components/examples/importPlcOpenXmlJobResponse" }, "importUsersAndGroupsJob" : { "$ref" : "#/components/examples/importUsersAndGroupsJobResponse" }, "moveElementsJob" : { "$ref" : "#/components/examples/moveElementsJobResponse" }, "newProjectJob" : { "$ref" : "#/components/examples/newProjectJobResponse" }, "openEditorJob" : { "$ref" : "#/components/examples/openEditorJobResponse" }, "preCompileJobDisable" : { "$ref" : "#/components/examples/preCompileJobDisableResponse" }, "preCompileJobEnable" : { "$ref" : "#/components/examples/preCompileJobEnableResponse" }, "projectJobClose" : { "$ref" : "#/components/examples/projectJobCloseResponse" }, "projectJobOpen" : { "$ref" : "#/components/examples/projectJobOpenResponse" }, "projectJobSave" : { "$ref" : "#/components/examples/projectJobSaveResponse" }, "projectJobSaveAndInstallIntoLibraryRepository" : { "$ref" : "#/components/examples/projectJobSaveAndInstallIntoLibraryRepositoryResponse" }, "projectJobSaveAs" : { "$ref" : "#/components/examples/projectJobSaveAsResponse" }, "projectJobSaveAsCompiledLibrary" : { "$ref" : "#/components/examples/projectJobSaveAsCompiledLibraryResponse" }, "publishMarkedMethodsJob" : { "$ref" : "#/components/examples/publishMarkedMethodsJobResponse" }, "pubSubJobSetAsPublisher" : { "$ref" : "#/components/examples/pubSubJobSetAsPublisherResponse" }, "pubSubJobSetAsSubscriber" : { "$ref" : "#/components/examples/pubSubJobSetAsSubscriberResponse" }, "removeLibraryCategoriesJob" : { "$ref" : "#/components/examples/removeLibraryCategoriesResponse" }, "resetColdJob" : { "$ref" : "#/components/examples/resetColdResponse" }, "resetOriginJob" : { "$ref" : "#/components/examples/resetOriginResponse" }, "resetWarmJob" : { "$ref" : "#/components/examples/resetWarmResponse" }, "userManagementLogInJob" : { "$ref" : "#/components/examples/userManagementLogInJobResponse" }, "userManagementLogOutJob" : { "$ref" : "#/components/examples/userManagementLogOutJobResponse" } }, "schema" : { "$ref" : "#/components/schemas/Jobs" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get information of an existing job", "tags" : [ "Jobs" ] } }, "/product/info" : { "get" : { "operationId" : "getProductInfo", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Product" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get the product information", "tags" : [ "Product" ] } }, "/projects/current" : { "get" : { "operationId" : "getCurrentProject", "parameters" : [ { "description" : "kind of data of the current project", "explode" : true, "in" : "query", "name" : "option", "required" : false, "schema" : { "default" : "meta", "enum" : [ "meta", "extended" ], "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Project" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get the meta information or a list of elements of the current project", "tags" : [ "Project" ] } }, "/pous" : { "get" : { "operationId" : "getPous", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PousTopLevel" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get the root element of the POUs view", "tags" : [ "POUs" ] }, "post" : { "operationId" : "addPous", "requestBody" : { "content" : { "application/json" : { "examples" : { "dut" : { "$ref" : "#/components/examples/dutRequest" }, "folder" : { "$ref" : "#/components/examples/folderRequest" }, "gvl" : { "$ref" : "#/components/examples/gvlRequest" }, "pou" : { "$ref" : "#/components/examples/pouRequest" }, "interface" : { "$ref" : "#/components/examples/interfaceRequest" }, "libraryManager" : { "$ref" : "#/components/examples/libraryManagerRequest" }, "projectInfo" : { "$ref" : "#/components/examples/projectInfoRequest" } }, "schema" : { "$ref" : "#/components/schemas/PousRootElements" } } }, "required" : true }, "responses" : { "201" : { "content" : { "application/json" : { "examples" : { "dut" : { "$ref" : "#/components/examples/dutResponse" }, "folder" : { "$ref" : "#/components/examples/folderResponse" }, "gvl" : { "$ref" : "#/components/examples/gvlResponse" }, "pou" : { "$ref" : "#/components/examples/pouResponse" }, "interface" : { "$ref" : "#/components/examples/interfaceResponse" }, "libraryManager" : { "$ref" : "#/components/examples/libraryManagerResponse" }, "projectInfo" : { "$ref" : "#/components/examples/projectInfoResponse" } }, "schema" : { "$ref" : "#/components/schemas/PousRootElements" } } }, "description" : "Created" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to create a new element and append it to the root element of the POUs view", "tags" : [ "POUs" ] } }, "/pous/{path}" : { "delete" : { "operationId" : "deletePousByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to delete an existing element with all sub-elements", "tags" : [ "POUs" ] }, "get" : { "operationId" : "getPousByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "dut" : { "$ref" : "#/components/examples/dutResponse" }, "folder" : { "$ref" : "#/components/examples/folderResponse" }, "gvl" : { "$ref" : "#/components/examples/gvlResponse" }, "pou" : { "$ref" : "#/components/examples/pouResponse" }, "interface" : { "$ref" : "#/components/examples/interfaceResponse" }, "libraryManager" : { "$ref" : "#/components/examples/libraryManagerResponse" }, "projectSettings" : { "$ref" : "#/components/examples/projectSettingsResponse" }, "projectInfo" : { "$ref" : "#/components/examples/projectInfoResponse" }, "action" : { "$ref" : "#/components/examples/actionResponse" }, "pouMethod" : { "$ref" : "#/components/examples/pouMethodResponse" }, "pouProperty" : { "$ref" : "#/components/examples/pouPropertyResponse" }, "pouPropertyGet" : { "$ref" : "#/components/examples/pouPropertyGetResponse" }, "pouPropertySet" : { "$ref" : "#/components/examples/pouPropertySetResponse" }, "sfcEditor" : { "$ref" : "#/components/examples/sfcEditorResponse" }, "compileOptionsEditor" : { "$ref" : "#/components/examples/compileOptionsEditorResponse" }, "usersAndGroupsEditor" : { "$ref" : "#/components/examples/usersAndGroupsEditorResponse" }, "interfaceMethod" : { "$ref" : "#/components/examples/interfaceMethodResponse" }, "interfaceProperty" : { "$ref" : "#/components/examples/interfacePropertyResponse" }, "interfacePropertyGet" : { "$ref" : "#/components/examples/interfacePropertyGetResponse" }, "interfacePropertySet" : { "$ref" : "#/components/examples/interfacePropertySetResponse" } }, "schema" : { "$ref" : "#/components/schemas/PousElements" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get an existing element", "tags" : [ "POUs" ] }, "post" : { "operationId" : "addPousByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "dut" : { "$ref" : "#/components/examples/dutRequest" }, "folder" : { "$ref" : "#/components/examples/folderRequest" }, "gvl" : { "$ref" : "#/components/examples/gvlRequest" }, "pou" : { "$ref" : "#/components/examples/pouRequest" }, "interface" : { "$ref" : "#/components/examples/interfaceRequest" }, "libraryManager" : { "$ref" : "#/components/examples/libraryManagerRequest" }, "addLibrary" : { "$ref" : "#/components/examples/addLibraryRequest" }, "action" : { "$ref" : "#/components/examples/actionRequest" }, "pouMethod" : { "$ref" : "#/components/examples/pouMethodRequest" }, "pouProperty" : { "$ref" : "#/components/examples/pouPropertyRequest" }, "pouPropertyGet" : { "$ref" : "#/components/examples/pouPropertyGetRequest" }, "pouPropertySet" : { "$ref" : "#/components/examples/pouPropertySetRequest" }, "interfaceMethod" : { "$ref" : "#/components/examples/interfaceMethodRequest" }, "interfaceProperty" : { "$ref" : "#/components/examples/interfacePropertyRequest" }, "interfacePropertyGet" : { "$ref" : "#/components/examples/interfacePropertyGetRequest" }, "interfacePropertySet" : { "$ref" : "#/components/examples/interfacePropertySetRequest" } }, "schema" : { "$ref" : "#/components/schemas/PousElements" } } }, "required" : true }, "responses" : { "201" : { "content" : { "application/json" : { "examples" : { "dut" : { "$ref" : "#/components/examples/dutResponse" }, "folder" : { "$ref" : "#/components/examples/folderResponse" }, "gvl" : { "$ref" : "#/components/examples/gvlResponse" }, "pou" : { "$ref" : "#/components/examples/pouResponse" }, "interface" : { "$ref" : "#/components/examples/interfaceResponse" }, "libraryManager" : { "$ref" : "#/components/examples/libraryManagerResponse" }, "addLibrary" : { "$ref" : "#/components/examples/addLibraryResponse" }, "action" : { "$ref" : "#/components/examples/actionResponse" }, "pouMethod" : { "$ref" : "#/components/examples/pouMethodResponse" }, "pouProperty" : { "$ref" : "#/components/examples/pouPropertyResponse" }, "pouPropertyGet" : { "$ref" : "#/components/examples/pouPropertyGetResponse" }, "pouPropertySet" : { "$ref" : "#/components/examples/pouPropertySetResponse" }, "interfaceMethod" : { "$ref" : "#/components/examples/interfaceMethodResponse" }, "interfaceProperty" : { "$ref" : "#/components/examples/interfacePropertyResponse" }, "interfacePropertyGet" : { "$ref" : "#/components/examples/interfacePropertyGetResponse" }, "interfacePropertySet" : { "$ref" : "#/components/examples/interfacePropertySetResponse" } }, "schema" : { "$ref" : "#/components/schemas/PousElements" } } }, "description" : "Created" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to create a new element", "tags" : [ "POUs" ] }, "put" : { "operationId" : "updatePousByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "dut" : { "$ref" : "#/components/examples/dutRequest" }, "folder" : { "$ref" : "#/components/examples/folderRequest" }, "gvl" : { "$ref" : "#/components/examples/gvlRequest" }, "pou" : { "$ref" : "#/components/examples/pouRequest" }, "interface" : { "$ref" : "#/components/examples/interfaceRequest" }, "libraryManager" : { "$ref" : "#/components/examples/libraryManagerRequest" }, "action" : { "$ref" : "#/components/examples/actionRequest" }, "projectInfo" : { "$ref" : "#/components/examples/projectInfoRequest" }, "pouMethod" : { "$ref" : "#/components/examples/pouMethodRequest" }, "pouProperty" : { "$ref" : "#/components/examples/pouPropertyRequest" }, "pouPropertyGet" : { "$ref" : "#/components/examples/pouPropertyGetRequest" }, "pouPropertySet" : { "$ref" : "#/components/examples/pouPropertySetRequest" }, "interfaceMethod" : { "$ref" : "#/components/examples/interfaceMethodRequest" }, "interfaceProperty" : { "$ref" : "#/components/examples/interfacePropertyRequest" }, "interfacePropertyGet" : { "$ref" : "#/components/examples/interfacePropertyGetRequest" }, "interfacePropertySet" : { "$ref" : "#/components/examples/interfacePropertySetRequest" }, "sfcEditor" : { "$ref" : "#/components/examples/sfcEditorRequest" }, "compileOptionsEditor" : { "$ref" : "#/components/examples/compileOptionsEditorRequest" }, "usersAndGroupsEditor" : { "$ref" : "#/components/examples/usersAndGroupsEditorRequest" } }, "schema" : { "$ref" : "#/components/schemas/PousElements" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "dut" : { "$ref" : "#/components/examples/dutResponse" }, "folder" : { "$ref" : "#/components/examples/folderResponse" }, "gvl" : { "$ref" : "#/components/examples/gvlResponse" }, "pou" : { "$ref" : "#/components/examples/pouResponse" }, "interface" : { "$ref" : "#/components/examples/interfaceResponse" }, "libraryManager" : { "$ref" : "#/components/examples/libraryManagerResponse" }, "action" : { "$ref" : "#/components/examples/actionResponse" }, "projectInfo" : { "$ref" : "#/components/examples/projectInfoResponse" }, "pouMethod" : { "$ref" : "#/components/examples/pouMethodResponse" }, "pouProperty" : { "$ref" : "#/components/examples/pouPropertyResponse" }, "pouPropertyGet" : { "$ref" : "#/components/examples/pouPropertyGetResponse" }, "pouPropertySet" : { "$ref" : "#/components/examples/pouPropertySetResponse" }, "interfaceMethod" : { "$ref" : "#/components/examples/interfaceMethodResponse" }, "interfaceProperty" : { "$ref" : "#/components/examples/interfacePropertyResponse" }, "interfacePropertyGet" : { "$ref" : "#/components/examples/interfacePropertyGetResponse" }, "interfacePropertySet" : { "$ref" : "#/components/examples/interfacePropertySetResponse" }, "sfcEditor" : { "$ref" : "#/components/examples/sfcEditorResponse" }, "compileOptionsEditor" : { "$ref" : "#/components/examples/compileOptionsEditorResponse" }, "usersAndGroupsEditor" : { "$ref" : "#/components/examples/usersAndGroupsEditorResponse" } }, "schema" : { "$ref" : "#/components/schemas/PousElements" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to modify an existing element", "tags" : [ "POUs" ] } }, "/pous/project-settings/users-groups/user" : { "post" : { "operationId" : "addUser", "requestBody" : { "content" : { "application/json" : { "examples" : { "user" : { "$ref" : "#/components/examples/addUserRequest" } }, "schema" : { "$ref" : "#/components/schemas/User" } } }, "required" : true }, "responses" : { "201" : { "content" : { "application/json" : { "examples" : { "user" : { "$ref" : "#/components/examples/userResponse" } }, "schema" : { "$ref" : "#/components/schemas/User" } } }, "description" : "Created" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to create new user account in the current project\n", "tags" : [ "Users and Groups" ] } }, "/pous/project-settings/users-groups/user/{userName}" : { "delete" : { "operationId" : "deleteUserByName", "parameters" : [ { "explode" : false, "in" : "path", "name" : "userName", "required" : true, "schema" : { "example" : "Owner", "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to delete user account from the current project", "tags" : [ "Users and Groups" ] }, "get" : { "operationId" : "getUserByName", "parameters" : [ { "explode" : false, "in" : "path", "name" : "userName", "required" : true, "schema" : { "example" : "Owner", "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "user" : { "$ref" : "#/components/examples/userResponse" } }, "schema" : { "$ref" : "#/components/schemas/User" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get user properties", "tags" : [ "Users and Groups" ] }, "put" : { "operationId" : "updateUserByName", "parameters" : [ { "explode" : false, "in" : "path", "name" : "userName", "required" : true, "schema" : { "example" : "Owner", "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "user" : { "$ref" : "#/components/examples/editUserRequest" } }, "schema" : { "$ref" : "#/components/schemas/User" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "user" : { "$ref" : "#/components/examples/userResponse" } }, "schema" : { "$ref" : "#/components/schemas/User" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to update the properties of the user .", "tags" : [ "Users and Groups" ] } }, "/pous/project-settings/users-groups/group" : { "post" : { "operationId" : "addGroup", "requestBody" : { "content" : { "application/json" : { "examples" : { "group" : { "$ref" : "#/components/examples/addGroupRequest" } }, "schema" : { "$ref" : "#/components/schemas/Group" } } }, "required" : true }, "responses" : { "201" : { "content" : { "application/json" : { "examples" : { "group" : { "$ref" : "#/components/examples/groupResponse" } }, "schema" : { "$ref" : "#/components/schemas/Group" } } }, "description" : "Created" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to create new group in the current project\n", "tags" : [ "Users and Groups" ] } }, "/pous/project-settings/users-groups/group/{groupName}" : { "delete" : { "operationId" : "deleteGroupByName", "parameters" : [ { "explode" : false, "in" : "path", "name" : "groupName", "required" : true, "schema" : { "example" : "Everyone", "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to delete group from the current project", "tags" : [ "Users and Groups" ] }, "get" : { "operationId" : "getGroupByName", "parameters" : [ { "explode" : false, "in" : "path", "name" : "groupName", "required" : true, "schema" : { "example" : "Everyone", "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "group" : { "$ref" : "#/components/examples/groupResponse" } }, "schema" : { "$ref" : "#/components/schemas/Group" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get group properties", "tags" : [ "Users and Groups" ] }, "put" : { "operationId" : "updateGroupByName", "parameters" : [ { "explode" : false, "in" : "path", "name" : "groupName", "required" : true, "schema" : { "example" : "Everyone", "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "group" : { "$ref" : "#/components/examples/addGroupRequest" } }, "schema" : { "$ref" : "#/components/schemas/Group" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "group" : { "$ref" : "#/components/examples/groupResponse" } }, "schema" : { "$ref" : "#/components/schemas/Group" } } }, "description" : "Ok" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to update the properties of the group .", "tags" : [ "Users and Groups" ] } }, "/devices" : { "get" : { "operationId" : "getDevices", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DevicesTopLevel" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get the root element of the Devices view", "tags" : [ "Devices" ] }, "post" : { "operationId" : "addDevices", "requestBody" : { "content" : { "application/json" : { "examples" : { "device" : { "$ref" : "#/components/examples/deviceRequest" }, "folder" : { "$ref" : "#/components/examples/folderRequest" } }, "schema" : { "$ref" : "#/components/schemas/DevicesRootElements" } } }, "required" : true }, "responses" : { "201" : { "content" : { "application/json" : { "examples" : { "device" : { "$ref" : "#/components/examples/deviceResponse" }, "folder" : { "$ref" : "#/components/examples/folderResponse" } }, "schema" : { "$ref" : "#/components/schemas/DevicesRootElements" } } }, "description" : "Created" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to create a new element and append it to the root element of the Devices view", "tags" : [ "Devices" ] } }, "/devices/{path}" : { "delete" : { "operationId" : "deleteDevicesByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to delete an existing element with all sub-elements", "tags" : [ "Devices" ] }, "get" : { "operationId" : "getDevicesByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "device" : { "$ref" : "#/components/examples/deviceResponse" }, "application" : { "$ref" : "#/components/examples/applicationResponse" }, "action" : { "$ref" : "#/components/examples/actionResponse" }, "dut" : { "$ref" : "#/components/examples/dutResponse" }, "folder" : { "$ref" : "#/components/examples/folderResponse" }, "gvl" : { "$ref" : "#/components/examples/gvlResponse" }, "nvlSender" : { "$ref" : "#/components/examples/nvlSenderResponse" }, "nvlReceiver" : { "$ref" : "#/components/examples/nvlReceiverResponse" }, "pou" : { "$ref" : "#/components/examples/pouResponse" }, "pouMethod" : { "$ref" : "#/components/examples/pouMethodResponse" }, "pouProperty" : { "$ref" : "#/components/examples/pouPropertyResponse" }, "pouPropertyGet" : { "$ref" : "#/components/examples/pouPropertyGetResponse" }, "pouPropertySet" : { "$ref" : "#/components/examples/pouPropertySetResponse" }, "libraryManager" : { "$ref" : "#/components/examples/libraryManagerResponse" }, "recipeManager" : { "$ref" : "#/components/examples/recipeManagerResponse" }, "recipeDefinition" : { "$ref" : "#/components/examples/recipeDefinitionResponse" }, "taskConfig" : { "$ref" : "#/components/examples/taskConfigResponse" }, "task" : { "$ref" : "#/components/examples/taskResponse" }, "symbolConfig" : { "$ref" : "#/components/examples/symbolConfigResponse" }, "persistentVars" : { "$ref" : "#/components/examples/persistentVarsResponse" }, "interface" : { "$ref" : "#/components/examples/interfaceResponse" }, "interfaceMethod" : { "$ref" : "#/components/examples/interfaceMethodResponse" }, "interfaceProperty" : { "$ref" : "#/components/examples/interfacePropertyResponse" }, "interfacePropertyGet" : { "$ref" : "#/components/examples/interfacePropertyGetResponse" }, "interfacePropertySet" : { "$ref" : "#/components/examples/interfacePropertySetResponse" }, "deviceEthercatMaster" : { "$ref" : "#/components/examples/deviceEthercatMasterResponse" }, "deviceS20ECBK" : { "$ref" : "#/components/examples/deviceS20ECBKResponse" }, "deviceEthernet" : { "$ref" : "#/components/examples/deviceEthernetResponse" }, "devicePNController" : { "$ref" : "#/components/examples/devicePNControllerResponse" }, "deviceCodesysProfinetDevice" : { "$ref" : "#/components/examples/deviceCodesysProfinetDeviceResponse" } }, "schema" : { "$ref" : "#/components/schemas/DevicesElements" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get an existing element", "tags" : [ "Devices" ] }, "patch" : { "operationId" : "modifyDevicesByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/merge-patch+json" : { "examples" : { "libraryParameter" : { "$ref" : "#/components/examples/libraryParameterPatchRequest" }, "disableDevice" : { "$ref" : "#/components/examples/disableDevicePatchRequest" }, "plcSettingsDevice" : { "$ref" : "#/components/examples/plcSettingsDevicePatchRequest" } }, "schema" : { "$ref" : "#/components/schemas/DevicePatchElements" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/merge-patch+json" : { "examples" : { "libraryParameter" : { "$ref" : "#/components/examples/libraryParameterPatchResponse" }, "disableDevice" : { "$ref" : "#/components/examples/deviceResponse" }, "plcSettingsDevice" : { "$ref" : "#/components/examples/deviceResponse" } }, "schema" : { "$ref" : "#/components/schemas/DevicePatchResponseElements" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to modify an resourse of an existing element", "tags" : [ "Devices" ] }, "post" : { "operationId" : "addDevicesByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "application" : { "$ref" : "#/components/examples/applicationRequest" }, "action" : { "$ref" : "#/components/examples/actionRequest" }, "dut" : { "$ref" : "#/components/examples/dutRequest" }, "folder" : { "$ref" : "#/components/examples/folderRequest" }, "gvl" : { "$ref" : "#/components/examples/gvlRequest" }, "nvlSender" : { "$ref" : "#/components/examples/nvlSenderRequest" }, "nvlReceiver" : { "$ref" : "#/components/examples/nvlReceiverRequest" }, "pou" : { "$ref" : "#/components/examples/pouRequest" }, "pouMethod" : { "$ref" : "#/components/examples/pouMethodRequest" }, "pouProperty" : { "$ref" : "#/components/examples/pouPropertyRequest" }, "pouPropertyGet" : { "$ref" : "#/components/examples/pouPropertyGetRequest" }, "pouPropertySet" : { "$ref" : "#/components/examples/pouPropertySetRequest" }, "libraryManager" : { "$ref" : "#/components/examples/libraryManagerRequest" }, "addLibrary" : { "$ref" : "#/components/examples/addLibraryRequest" }, "recipeManager" : { "$ref" : "#/components/examples/recipeManagerRequest" }, "recipeDefinition" : { "$ref" : "#/components/examples/recipeDefinitionRequest" }, "taskConfig" : { "$ref" : "#/components/examples/taskConfigRequest" }, "task" : { "$ref" : "#/components/examples/taskRequest" }, "symbolConfig" : { "$ref" : "#/components/examples/symbolConfigRequest" }, "persistentVars" : { "$ref" : "#/components/examples/persistentVarsRequest" }, "interface" : { "$ref" : "#/components/examples/interfaceRequest" }, "interfaceMethod" : { "$ref" : "#/components/examples/interfaceMethodRequest" }, "interfaceProperty" : { "$ref" : "#/components/examples/interfacePropertyRequest" }, "interfacePropertyGet" : { "$ref" : "#/components/examples/interfacePropertyGetRequest" }, "interfacePropertySet" : { "$ref" : "#/components/examples/interfacePropertySetRequest" }, "deviceEthercatMaster" : { "$ref" : "#/components/examples/deviceEthercatMasterRequest" }, "deviceS20ECBK" : { "$ref" : "#/components/examples/deviceS20ECBKRequest" }, "deviceEthernet" : { "$ref" : "#/components/examples/deviceEthernetRequest" }, "devicePNController" : { "$ref" : "#/components/examples/devicePNControllerRequest" }, "deviceCodesysProfinetDevice" : { "$ref" : "#/components/examples/deviceCodesysProfinetDeviceRequest" } }, "schema" : { "$ref" : "#/components/schemas/DevicesElements" } } }, "required" : true }, "responses" : { "201" : { "content" : { "application/json" : { "examples" : { "application" : { "$ref" : "#/components/examples/applicationResponse" }, "action" : { "$ref" : "#/components/examples/actionResponse" }, "dut" : { "$ref" : "#/components/examples/dutResponse" }, "folder" : { "$ref" : "#/components/examples/folderResponse" }, "gvl" : { "$ref" : "#/components/examples/gvlResponse" }, "nvlSender" : { "$ref" : "#/components/examples/nvlSenderResponse" }, "nvlReceiver" : { "$ref" : "#/components/examples/nvlReceiverResponse" }, "pou" : { "$ref" : "#/components/examples/pouResponse" }, "pouMethod" : { "$ref" : "#/components/examples/pouMethodResponse" }, "pouProperty" : { "$ref" : "#/components/examples/pouPropertyResponse" }, "pouPropertyGet" : { "$ref" : "#/components/examples/pouPropertyGetResponse" }, "pouPropertySet" : { "$ref" : "#/components/examples/pouPropertySetResponse" }, "libraryManager" : { "$ref" : "#/components/examples/libraryManagerResponse" }, "addLibrary" : { "$ref" : "#/components/examples/addLibraryResponse" }, "recipeManager" : { "$ref" : "#/components/examples/recipeManagerResponse" }, "recipeDefinition" : { "$ref" : "#/components/examples/recipeDefinitionResponse" }, "taskConfig" : { "$ref" : "#/components/examples/taskConfigResponse" }, "task" : { "$ref" : "#/components/examples/taskResponse" }, "symbolConfig" : { "$ref" : "#/components/examples/symbolConfigResponse" }, "persistentVars" : { "$ref" : "#/components/examples/persistentVarsResponse" }, "interface" : { "$ref" : "#/components/examples/interfaceResponse" }, "interfaceMethod" : { "$ref" : "#/components/examples/interfaceMethodResponse" }, "interfaceProperty" : { "$ref" : "#/components/examples/interfacePropertyResponse" }, "interfacePropertyGet" : { "$ref" : "#/components/examples/interfacePropertyGetResponse" }, "interfacePropertySet" : { "$ref" : "#/components/examples/interfacePropertySetResponse" }, "deviceEthercatMaster" : { "$ref" : "#/components/examples/deviceEthercatMasterResponse" }, "deviceS20ECBK" : { "$ref" : "#/components/examples/deviceS20ECBKResponse" }, "deviceEthernet" : { "$ref" : "#/components/examples/deviceEthernetResponse" }, "devicePNController" : { "$ref" : "#/components/examples/devicePNControllerResponse" }, "deviceCodesysProfinetDevice" : { "$ref" : "#/components/examples/deviceCodesysProfinetDeviceResponse" } }, "schema" : { "$ref" : "#/components/schemas/DevicesElements" } } }, "description" : "Created" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to create a new element", "tags" : [ "Devices" ] }, "put" : { "operationId" : "updateDevicesByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "device" : { "$ref" : "#/components/examples/deviceRequest" }, "application" : { "$ref" : "#/components/examples/applicationRequest" }, "action" : { "$ref" : "#/components/examples/actionRequest" }, "dut" : { "$ref" : "#/components/examples/dutRequest" }, "folder" : { "$ref" : "#/components/examples/folderRequest" }, "gvl" : { "$ref" : "#/components/examples/gvlRequest" }, "nvlSender" : { "$ref" : "#/components/examples/nvlSenderRequest" }, "nvlReceiver" : { "$ref" : "#/components/examples/nvlReceiverRequest" }, "pou" : { "$ref" : "#/components/examples/pouRequest" }, "pouMethod" : { "$ref" : "#/components/examples/pouMethodRequest" }, "pouProperty" : { "$ref" : "#/components/examples/pouPropertyRequest" }, "pouPropertyGet" : { "$ref" : "#/components/examples/pouPropertyGetRequest" }, "pouPropertySet" : { "$ref" : "#/components/examples/pouPropertySetRequest" }, "libraryManager" : { "$ref" : "#/components/examples/libraryManagerRequest" }, "recipeManager" : { "$ref" : "#/components/examples/recipeManagerRequest" }, "recipeDefinition" : { "$ref" : "#/components/examples/recipeDefinitionRequest" }, "taskConfig" : { "$ref" : "#/components/examples/taskConfigRequest" }, "task" : { "$ref" : "#/components/examples/taskRequest" }, "symbolConfig" : { "$ref" : "#/components/examples/symbolConfigRequest" }, "persistentVars" : { "$ref" : "#/components/examples/persistentVarsRequest" }, "interface" : { "$ref" : "#/components/examples/interfaceRequest" }, "interfaceMethod" : { "$ref" : "#/components/examples/interfaceMethodRequest" }, "interfaceProperty" : { "$ref" : "#/components/examples/interfacePropertyRequest" }, "interfacePropertyGet" : { "$ref" : "#/components/examples/interfacePropertyGetRequest" }, "interfacePropertySet" : { "$ref" : "#/components/examples/interfacePropertySetRequest" }, "deviceS20ECBK" : { "$ref" : "#/components/examples/deviceS20ECBKRequest" }, "deviceCodesysProfinetDevice" : { "$ref" : "#/components/examples/deviceCodesysProfinetDeviceRequest" } }, "schema" : { "$ref" : "#/components/schemas/DevicesElements" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "device" : { "$ref" : "#/components/examples/deviceResponse" }, "application" : { "$ref" : "#/components/examples/applicationResponse" }, "action" : { "$ref" : "#/components/examples/actionResponse" }, "dut" : { "$ref" : "#/components/examples/dutResponse" }, "folder" : { "$ref" : "#/components/examples/folderResponse" }, "gvl" : { "$ref" : "#/components/examples/gvlResponse" }, "nvlSender" : { "$ref" : "#/components/examples/nvlSenderResponse" }, "nvlReceiver" : { "$ref" : "#/components/examples/nvlReceiverResponse" }, "pou" : { "$ref" : "#/components/examples/pouResponse" }, "pouMethod" : { "$ref" : "#/components/examples/pouMethodResponse" }, "pouProperty" : { "$ref" : "#/components/examples/pouPropertyResponse" }, "pouPropertyGet" : { "$ref" : "#/components/examples/pouPropertyGetResponse" }, "pouPropertySet" : { "$ref" : "#/components/examples/pouPropertySetResponse" }, "libraryManager" : { "$ref" : "#/components/examples/libraryManagerResponse" }, "recipeManager" : { "$ref" : "#/components/examples/recipeManagerResponse" }, "recipeDefinition" : { "$ref" : "#/components/examples/recipeDefinitionResponse" }, "taskConfig" : { "$ref" : "#/components/examples/taskConfigResponse" }, "task" : { "$ref" : "#/components/examples/taskResponse" }, "symbolConfig" : { "$ref" : "#/components/examples/symbolConfigResponse" }, "persistentVars" : { "$ref" : "#/components/examples/persistentVarsResponse" }, "interface" : { "$ref" : "#/components/examples/interfaceResponse" }, "interfaceMethod" : { "$ref" : "#/components/examples/interfaceMethodResponse" }, "interfaceProperty" : { "$ref" : "#/components/examples/interfacePropertyResponse" }, "interfacePropertyGet" : { "$ref" : "#/components/examples/interfacePropertyGetResponse" }, "interfacePropertySet" : { "$ref" : "#/components/examples/interfacePropertySetResponse" }, "deviceS20ECBK" : { "$ref" : "#/components/examples/deviceS20ECBKResponse" }, "deviceCodesysProfinetDevice" : { "$ref" : "#/components/examples/deviceCodesysProfinetDeviceResponse" } }, "schema" : { "$ref" : "#/components/schemas/DevicesElements" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to modify an existing element", "tags" : [ "Devices" ] } }, "/devices/{path}/symbol-config" : { "delete" : { "operationId" : "deleteDevicesSymbolConfigByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to delete symbol configuration element", "tags" : [ "Symbol Configuration" ] }, "get" : { "operationId" : "getDevicesSymbolConfigByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "If set to true, project symbols will be included in the response.", "example" : true, "explode" : true, "in" : "query", "name" : "showProjSymbols", "required" : false, "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "If set to true, library symbols will be included in the response.", "example" : true, "explode" : true, "in" : "query", "name" : "showLibSymbols", "required" : false, "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "If set to true, symbols exported via attribute will be included in the response.", "example" : true, "explode" : true, "in" : "query", "name" : "showExpAttrSymbols", "required" : false, "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "If set to true, symbols with 'MaximalAccess == None' will be included in the response (CAUTION! this includes more symbol variables). Symbols with 'None' access is not shown in symbol configuration editor of ctrlX PLC Engineering.", "example" : false, "explode" : true, "in" : "query", "name" : "includeMaxAccessNone", "required" : false, "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "If set to true, all structure types will be included in the response (CAUTION! this includes more types variable). These are not shown in symbol configuration editor of ctrlX PLC Engineering.", "example" : false, "explode" : true, "in" : "query", "name" : "includeAllTypes", "required" : false, "schema" : { "type" : "boolean" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "symbolConfig" : { "$ref" : "#/components/examples/symbolConfigResponse" } }, "schema" : { "$ref" : "#/components/schemas/SymbolConfig" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get all symbol variables from project and libraries", "tags" : [ "Symbol Configuration" ] }, "put" : { "operationId" : "updateDevicesSymbolConfigByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "- Use action **Select** and set **isSelected** property of variables inside 'symbols' and 'type' array to **true** to select the symbols.\n\n- Use action **UnSelect** and set **isSelected** property of variables inside 'symbols' and 'type' array to **false** to un select the symbols.\n\n- Use action **UnSelectAll** to clear all selections.\n\n- Use action **UpdateAll** to perform both **UnSelect** and **Select** in one API request.\n", "example" : "Select", "explode" : true, "in" : "query", "name" : "symbolsAction", "required" : false, "schema" : { "enum" : [ "Select", "UnSelect", "UnSelectAll", "UpdateAll" ], "type" : "string" }, "style" : "form" } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "symbolConfig" : { "$ref" : "#/components/examples/symbolConfigRequest" } }, "schema" : { "$ref" : "#/components/schemas/SymbolConfig" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "symbolConfig" : { "$ref" : "#/components/examples/symbolConfigResponse" } }, "schema" : { "$ref" : "#/components/schemas/SymbolConfig" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to select symbol variables and update property of existing symbol configuration element", "tags" : [ "Symbol Configuration" ] } }, "/devices/{path}/task-config" : { "delete" : { "operationId" : "deleteDevicesTaskConfigByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to delete task configuration element", "tags" : [ "Task Configuration" ] }, "get" : { "operationId" : "getDevicesTaskConfigByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "taskConfig" : { "$ref" : "#/components/examples/taskConfigResponse" } }, "schema" : { "$ref" : "#/components/schemas/TaskConfig" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get task configuration properties", "tags" : [ "Task Configuration" ] }, "put" : { "operationId" : "updateDevicesTaskConfigByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "- Use action **Add** to add a new task group. If no action is selected and 'taskGroups' exists in the request body, **Add** will be the default behaviour.\n\n- Use action **Remove** to remove a task group.\n\n- Use action **Update** to update a task group.\n", "example" : "Add", "explode" : true, "in" : "query", "name" : "taskGroupsAction", "required" : false, "schema" : { "enum" : [ "Add", "Remove", "Update" ], "type" : "string" }, "style" : "form" } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "taskConfig" : { "$ref" : "#/components/examples/taskConfigRequest" } }, "schema" : { "$ref" : "#/components/schemas/TaskConfig" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "taskConfig" : { "$ref" : "#/components/examples/taskConfigResponse" } }, "schema" : { "$ref" : "#/components/schemas/TaskConfig" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to update properties and task groups of task configuration element", "tags" : [ "Task Configuration" ] } }, "/devices/{path}/task-config/{taskName}" : { "delete" : { "operationId" : "deleteDevicesTaskByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Task name whch is added below 'Task Configuration'.", "example" : "Task", "explode" : false, "in" : "path", "name" : "taskName", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to delete task element", "tags" : [ "Task Configuration" ] }, "get" : { "operationId" : "getDevicesTaskByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Task name whch is added below 'Task Configuration'.", "example" : "Task", "explode" : false, "in" : "path", "name" : "taskName", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "task" : { "$ref" : "#/components/examples/taskResponse" } }, "schema" : { "$ref" : "#/components/schemas/Task" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get task properties", "tags" : [ "Task Configuration" ] }, "put" : { "operationId" : "updateDevicesTaskByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Task name whch is added below 'Task Configuration'.", "example" : "Task", "explode" : false, "in" : "path", "name" : "taskName", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "task" : { "$ref" : "#/components/examples/taskRequest" } }, "schema" : { "$ref" : "#/components/schemas/Task" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "task" : { "$ref" : "#/components/examples/taskResponse" } }, "schema" : { "$ref" : "#/components/schemas/Task" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to update properties and configuration of task element", "tags" : [ "Task Configuration" ] } }, "/devices/{path}/recipe-manager/{recipeDefinition}/variables" : { "delete" : { "operationId" : "deleteDevicesRecipeManagerVariablesByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipe definition element.\n", "explode" : false, "in" : "path", "name" : "recipeDefinition", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to delete all recipe variable elements of the recipe definition element", "tags" : [ "Recipes" ] }, "get" : { "operationId" : "getDevicesRecipeManagerVariablesByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipe definition element.\n", "explode" : false, "in" : "path", "name" : "recipeDefinition", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RecipeVariableList" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get all recipe variable elements of the recipe definition element", "tags" : [ "Recipes" ] }, "post" : { "operationId" : "addDevicesRecipeManagerVariablesByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipe definition element.\n", "explode" : false, "in" : "path", "name" : "recipeDefinition", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "recipeVariable" : { "$ref" : "#/components/examples/recipeVariableRequest" } }, "schema" : { "$ref" : "#/components/schemas/RecipeVariable" } } }, "required" : true }, "responses" : { "201" : { "content" : { "application/json" : { "examples" : { "recipeVariable" : { "$ref" : "#/components/examples/recipeVariableResponse" } }, "schema" : { "$ref" : "#/components/schemas/RecipeVariable" } } }, "description" : "Created" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to create a new recipe variable element in the recipe definition element", "tags" : [ "Recipes" ] } }, "/devices/{path}/recipe-manager/{recipeDefinition}/variables/{name}" : { "delete" : { "operationId" : "deleteDevicesRecipeManagerVariablesNameByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipeVariable or a recipe.\n", "explode" : false, "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipe definition element.\n", "explode" : false, "in" : "path", "name" : "recipeDefinition", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to delete recipe variable element in the recipe definition element", "tags" : [ "Recipes" ] }, "get" : { "operationId" : "getDevicesRecipeManagerVariablesNameByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipeVariable or a recipe.\n", "explode" : false, "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipe definition element.\n", "explode" : false, "in" : "path", "name" : "recipeDefinition", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "recipeVariable" : { "$ref" : "#/components/examples/recipeVariableResponse" } }, "schema" : { "$ref" : "#/components/schemas/RecipeVariable" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get recipe variable element of recipe definition element", "tags" : [ "Recipes" ] }, "put" : { "operationId" : "updateDevicesRecipeManagerVariablesNameByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipeVariable or a recipe.\n", "explode" : false, "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipe definition element.\n", "explode" : false, "in" : "path", "name" : "recipeDefinition", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "recipeVariable" : { "$ref" : "#/components/examples/recipeVariableRequest" } }, "schema" : { "$ref" : "#/components/schemas/RecipeVariable" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "recipeVariable" : { "$ref" : "#/components/examples/recipeVariableResponse" } }, "schema" : { "$ref" : "#/components/schemas/RecipeVariable" } } }, "description" : "Ok" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to update the recipe variable element in the recipe definition element", "tags" : [ "Recipes" ] } }, "/devices/{path}/recipe-manager/{recipeDefinition}/recipes" : { "delete" : { "operationId" : "deleteDevicesRecipeManagerRecipesByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipe definition element.\n", "explode" : false, "in" : "path", "name" : "recipeDefinition", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to delete all recipe elements in the recipe definition element", "tags" : [ "Recipes" ] }, "get" : { "operationId" : "getDevicesRecipeManagerRecipesByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipe definition element.\n", "explode" : false, "in" : "path", "name" : "recipeDefinition", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RecipeList" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get all recipe elements of recipe definition element", "tags" : [ "Recipes" ] }, "post" : { "operationId" : "addDevicesRecipeManagerRecipesByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipe definition element.\n", "explode" : false, "in" : "path", "name" : "recipeDefinition", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "recipe" : { "$ref" : "#/components/examples/recipeRequest" } }, "schema" : { "$ref" : "#/components/schemas/Recipe" } } }, "required" : true }, "responses" : { "201" : { "content" : { "application/json" : { "examples" : { "recipe" : { "$ref" : "#/components/examples/recipeResponse" } }, "schema" : { "$ref" : "#/components/schemas/Recipe" } } }, "description" : "Created" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to create a new recipe element in the recipe definition element", "tags" : [ "Recipes" ] } }, "/devices/{path}/recipe-manager/{recipeDefinition}/recipes/{name}" : { "delete" : { "operationId" : "deleteDevicesRecipeManagerRecipesNameByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipeVariable or a recipe.\n", "explode" : false, "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipe definition element.\n", "explode" : false, "in" : "path", "name" : "recipeDefinition", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to delete the recipe element in the recipe definition element", "tags" : [ "Recipes" ] }, "get" : { "operationId" : "getDevicesRecipeManagerRecipesNameByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipeVariable or a recipe.\n", "explode" : false, "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipe definition element.\n", "explode" : false, "in" : "path", "name" : "recipeDefinition", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "recipe" : { "$ref" : "#/components/examples/recipeResponse" } }, "schema" : { "$ref" : "#/components/schemas/Recipe" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to get the recipe element of the recipe definition element", "tags" : [ "Recipes" ] }, "put" : { "operationId" : "updateDevicesRecipeManagerRecipesNameByPath", "parameters" : [ { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipeVariable or a recipe.\n", "explode" : false, "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "This is the name of a recipe definition element.\n", "explode" : false, "in" : "path", "name" : "recipeDefinition", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "recipe" : { "$ref" : "#/components/examples/recipeRequest" } }, "schema" : { "$ref" : "#/components/schemas/Recipe" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "recipe" : { "$ref" : "#/components/examples/recipeResponse" } }, "schema" : { "$ref" : "#/components/schemas/Recipe" } } }, "description" : "Ok" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to update the recipe element in the recipe definition element", "tags" : [ "Recipes" ] } }, "/online-change-memory-reserve" : { "get" : { "operationId" : "getAllApplication", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationList" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "scans and returns all the available applications in the project.", "tags" : [ "Online Change Memory Settings" ] } }, "/online-change-memory-reserve/{applicationName}" : { "get" : { "operationId" : "getMemoryReserveInfoByApplicationName", "parameters" : [ { "example" : "Application [Device: PLC Logic]", "explode" : false, "in" : "path", "name" : "applicationName", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "category of the function blocks\n", "example" : "All", "explode" : true, "in" : "query", "name" : "find", "required" : false, "schema" : { "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OnlineChangeMemoryReserve" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "returns memory reserve info of the application function blocks.", "tags" : [ "Online Change Memory Settings" ] }, "put" : { "operationId" : "updateMemoryReserveSizeByApplicationName", "parameters" : [ { "example" : "Application [Device: PLC Logic]", "explode" : false, "in" : "path", "name" : "applicationName", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OnlineChangeMemoryReserve" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OnlineChangeMemoryReserve" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Loading configuration failed", "status" : 400, "instance" : "/solutions/configuration", "mainDiagnosisCode" : "080F0400", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=080F0400" ], "cause" : [ { "type" : "about:blank", "title" : "Error in system configuration", "detail" : "Creation and deletion of motion objects is only allowed in CONFIGURATION state", "status" : 400, "instance" : "/automation/api/v2/nodes/motion/cmd/opstate", "mainDiagnosisCode" : "090F2020", "detailedDiagnosisCode" : "0C560203", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C560203" ] }, { "type" : "about:blank", "title" : "Error in PLC configuration", "detail" : "Loading the configuration in the “RUN” state is not permitted", "status" : 400, "instance" : "/automation/api/v2/nodes/plc/cmd/run", "mainDiagnosisCode" : "0A0F0020", "detailedDiagnosisCode" : "0C280100", "severity" : "Warning", "links" : [ "https://docs.automation.boschrexroth.com/cdphelp?tkeyword=0C280100" ] } ] }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The request is incomplete or malformed" }, "403" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Forbidden (403)", "status" : 403, "instance" : "scheduler/admin/state", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0204", "severity" : "Error", "moreInfo" : { "requiredPermissions" : "rexroth-automation.datalayer.rw, rexroth-device.all.rwx" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Access forbidden for this resource" }, "404" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http client error", "detail" : "Not found (404)", "status" : 404, "instance" : "scheduler/not-available", "mainDiagnosisCode" : "080E0200", "detailedDiagnosisCode" : "0C7A0205", "severity" : "Error" }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "The resource was not found" }, "500" : { "content" : { "application/json" : { "example" : { "type" : "about:blank", "title" : "Http server error", "detail" : "Internal server error (500)", "status" : 500, "instance" : "scheduler/admin", "mainDiagnosisCode" : "080F0200", "detailedDiagnosisCode" : "0C7A0200", "severity" : "Error", "moreInfo" : { "trace" : "ExampleClass.cpp#452 Null pointer exception" } }, "schema" : { "$ref" : "#/components/schemas/Problem" } } }, "description" : "Something unexpected happened on the server" } }, "summary" : "to update the memory Reserve size of the application function blocks .", "tags" : [ "Online Change Memory Settings" ] } } }, "components" : { "examples" : { "deviceRequest" : { "value" : { "name" : "CoreDevice", "elementType" : "Device", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "deviceInfo" : { "deviceType" : 4096, "id" : "1001 0080" } } }, "deviceResponse" : { "value" : { "name" : "CoreDevice", "elementType" : "Device", "id" : "9976952c-8c0e-4cd9-9e1f-c6f41cfeeb51", "children" : [ "Plc Logic", "Realtime_Data" ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "isOnline" : false, "plcSettings" : { "applicationForIOHandling" : "Application", "updateIOWhileInStop" : true, "behaviorFoOutputsInStop" : "ExecuteProgram", "stopResetBehaviourUserProgram" : "POU", "alwaysUpdateVariables" : "Enabled 1 (use bus cycle task if not used in any task)", "busCycleTask" : "Task", "showIOWarningsAsErrors" : false, "enableDiagnosisForDevices" : false, "generateForceVariablesForIOMapping" : false }, "disable" : false, "deviceInfo" : { "name" : "ctrlX CORE", "vendor" : "Bosch Rexroth AG", "deviceType" : 4096, "id" : "1001 0080", "version" : "1.9.2.0", "orderNumber" : "dependent on customer specific configuration", "description" : "ctrlX CORE\r\nEingänge: 8192\r\nAusgänge: 8192\r\nMerker: 8192\r\nRemanenter Speicher: default 64KB auf 128KB konfigurierbar\r\n\t" } } }, "deviceS20ECBKRequest" : { "value" : { "name" : "S20_EC_BK", "elementType" : "Device", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "deviceInfo" : { "deviceType" : 65, "id" : "24_00293C6000000001", "version" : "Revision=16#00000001" }, "ioMapping" : [ { "id" : "33554434", "sectionName" : null, "variable" : "TestVariable", "address" : "%IW0", "automatic" : true, "channelName" : "New Diagnosis Message", "baseType" : "UINT", "ioType" : "Input", "description" : "IO-Link State Ch.1", "subChannels" : [ ] } ] } }, "deviceS20ECBKResponse" : { "value" : { "name" : "S20_EC_BK", "elementType" : "Device", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "disable" : false, "ethercatSlaveInfo" : { "ethercatAddress" : 1001 }, "deviceInfo" : { "name" : "S20-EC-BK, IndraControl S20 EtherCAT Fieldbus coupler", "vendor" : "Bosch Rexroth AG", "deviceType" : 65, "id" : "24_00293C6000000001", "version" : "Revision=16#00000001", "orderNumber" : "S20-EC-BK", "description" : "EtherCAT Slave imported from Slave XML: S20-EC-BK_019.XML Device: S20-EC-BK, IndraControl S20 EtherCAT BuskopplerS20-EC-BK, IndraControl S20 EtherCAT Fieldbus coupler" }, "ioMapping" : [ { "id" : "33554434", "sectionName" : "16#1AFF Bus Coupler Diag Info", "variable" : "test", "address" : "%IW82", "automatic" : true, "channelName" : "New Diagnosis Message", "baseType" : "UINT", "ioType" : "Input", "description" : "IO-Link State Ch.1", "subChannels" : [ ] }, { "id" : "33554435", "sectionName" : "16#1AFF Bus Coupler Diag Info", "variable" : "", "address" : "%IW84", "automatic" : true, "channelName" : "Localbus bus State", "baseType" : "UINT", "ioType" : "Input", "description" : "Localbus bus State", "subChannels" : [ ] }, { "id" : "33554436", "sectionName" : "16#1AFF Bus Coupler Diag Info", "variable" : "", "address" : "%IW86", "automatic" : true, "channelName" : "Localbus Error_Code", "baseType" : "UINT", "ioType" : "Input", "description" : "Localbus Error_Code", "subChannels" : [ ] }, { "id" : "33554437", "sectionName" : "16#1AFF Bus Coupler Diag Info", "variable" : "", "address" : "%IW88", "automatic" : true, "channelName" : "Localbus Add_Error Info", "baseType" : "UINT", "ioType" : "Input", "description" : "Localbus Add_Error Info", "subChannels" : [ ] } ] } }, "declarationsJobAddAllInstancePathsRequest" : { "value" : { "jobType" : "DeclarationsJob", "jobParameters" : { "nodeUrl" : "/devices/device/PLC Logic/Application/PersistentVars", "action" : "AddAllInstancePaths" } } }, "declarationsJobAddAllInstancePathsResponse" : { "value" : { "id" : "e4f5fcc52ccddah5", "state" : "Done", "progress" : 100, "jobType" : "DeclarationsJob", "jobParameters" : { "nodeUrl" : "/devices/device/PLC Logic/Application/PersistentVars", "action" : "AddAllInstancePaths" }, "jobResultInfo" : "'AddAllInstancePath' Successful." } }, "deviceEthercatMasterRequest" : { "value" : { "name" : "EtherCAT_Master", "elementType" : "Device", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "deviceInfo" : { "name" : "EtherCAT Master", "vendor" : "CODESYS", "deviceType" : 64, "id" : "0000 0001", "version" : "4.10.0.0", "orderNumber" : "", "description" : "EtherCAT Master..." } } }, "deviceEthercatMasterResponse" : { "value" : { "name" : "EtherCAT_Master", "elementType" : "Device", "id" : "ca0ea7d6-517e-40a2-ac80-a1f5abd33e68", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "disable" : false, "deviceInfo" : { "name" : "EtherCAT Master", "vendor" : "CODESYS", "deviceType" : 64, "id" : "0000 0001", "version" : "4.10.0.0", "orderNumber" : "", "description" : "EtherCAT Master..." } } }, "deviceEthernetRequest" : { "value" : { "name" : "Ethernet", "elementType" : "Device", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "deviceInfo" : { "name" : "Ethernet", "vendor" : "CODESYS", "deviceType" : 110, "id" : "0000 0002", "version" : "4.2.0.0", "orderNumber" : "", "description" : "Ethernet Link." } } }, "deviceEthernetResponse" : { "value" : { "name" : "Ethernet", "elementType" : "Device", "id" : "f45ccc4c-148e-48a4-b362-32bc05e0322d", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "disable" : false, "deviceInfo" : { "name" : "Ethernet", "vendor" : "CODESYS", "deviceType" : 110, "id" : "0000 0002", "version" : "4.2.0.0", "orderNumber" : "-", "description" : "Ethernet Link." } } }, "devicePNControllerRequest" : { "value" : { "name" : "PN_Controller", "elementType" : "Device", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "deviceInfo" : { "name" : "PN-Controller", "vendor" : "CODESYS", "deviceType" : 80, "id" : "0000 0002", "version" : "4.6.0.0", "orderNumber" : "1", "description" : "PROFINET IO Controller" } } }, "devicePNControllerResponse" : { "value" : { "name" : "PN_Controller", "elementType" : "Device", "id" : "e6432d75-89da-4422-82b3-984007876485", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "disable" : false, "deviceInfo" : { "name" : "PN-Controller", "vendor" : "CODESYS", "deviceType" : 80, "id" : "0000 0002", "version" : "4.6.0.0", "orderNumber" : "1", "description" : "PROFINET IO Controller" } } }, "deviceCodesysProfinetDeviceRequest" : { "value" : { "name" : "CODESYS_PROFINET_Device", "elementType" : "Device", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "deviceInfo" : { "name" : "CODESYS PROFINET Device", "vendor" : "CODESYS", "deviceType" : 81, "id" : "0x02CC_0x1017_IDD_1", "version" : "SW=V4.6.0, HW=0", "orderNumber" : "-", "description" : "CODESYS PLC running as PROFINET Device." }, "ioMapping" : [ { "id" : "79872", "sectionName" : null, "variable" : "", "address" : "%IB119", "automatic" : true, "channelName" : "Inputs PS", "baseType" : "TIOxS", "ioType" : "Input", "description" : "", "subChannels" : [ ] }, { "id" : "145408", "sectionName" : null, "variable" : "", "address" : "%IB120", "automatic" : true, "channelName" : "Inputs PS", "baseType" : "TIOxS", "ioType" : "Input", "description" : "", "subChannels" : [ ] }, { "id" : "210944", "sectionName" : null, "variable" : "", "address" : "%IB121", "automatic" : true, "channelName" : "Inputs PS", "baseType" : "TIOxS", "ioType" : "Input", "description" : "", "subChannels" : [ ] } ] } }, "deviceCodesysProfinetDeviceResponse" : { "value" : { "name" : "CODESYS_PROFINET_Device", "elementType" : "Device", "id" : "71dc3dcb-9a4b-4a98-9e59-afc95b87b683", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "disable" : false, "deviceInfo" : { "name" : "CODESYS PROFINET Device", "vendor" : "CODESYS", "deviceType" : 81, "id" : "0x02CC_0x1017_IDD_1", "version" : "SW=V4.6.0, HW=0", "orderNumber" : "-", "description" : "CODESYS PLC running as PROFINET Device." }, "ioMapping" : [ { "id" : "79872", "sectionName" : null, "variable" : "", "address" : "%IB122", "automatic" : true, "channelName" : "Inputs PS", "baseType" : "TIOxS", "ioType" : "Input", "description" : "", "subChannels" : [ ] }, { "id" : "145408", "sectionName" : null, "variable" : "", "address" : "%IB123", "automatic" : true, "channelName" : "Inputs PS", "baseType" : "TIOxS", "ioType" : "Input", "description" : "", "subChannels" : [ ] }, { "id" : "210944", "sectionName" : null, "variable" : "", "address" : "%IB124", "automatic" : true, "channelName" : "Inputs PS", "baseType" : "TIOxS", "ioType" : "Input", "description" : "", "subChannels" : [ ] } ] } }, "deviceRepositoryJobSaveDeviceRequest" : { "value" : { "jobType" : "DeviceRepositoryJob", "jobParameters" : { "action" : "SaveDevice" } } }, "deviceRepositoryJobSaveDeviceResponse" : { "value" : { "id" : "3d2fad188a4aadf4", "state" : "Done", "progress" : 100, "jobType" : "DeviceRepositoryJob", "jobParameters" : { "action" : "SaveDevice" }, "jobResultInfo" : "Changes to devices are successfully saved." } }, "folderRequest" : { "value" : { "name" : "MyFolder", "elementType" : "Folder", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" }, "documentation" : "Folder Documentation @123" } } }, "folderResponse" : { "value" : { "name" : "MyFolder", "elementType" : "Folder", "children" : [ "GVL_2" ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" }, "documentation" : "Folder Documentation @123" } } }, "generateCodeJobRequest" : { "value" : { "jobType" : "GenerateCodeJob", "jobParameters" : { "action" : "GenerateCode" } } }, "generateCodeJobResponse" : { "value" : { "id" : "28fcdc4e05b4e309", "state" : "Done", "progress" : 100, "jobType" : "GenerateCodeJob", "jobParameters" : { "action" : "GenerateCode" }, "jobResultInfo" : "Build complete -- 0 errors, 0 warnings: Ready for download." } }, "applicationRequest" : { "value" : { "name" : "Application1", "elementType" : "Application", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "TestText" }, "applicationBuildOptions" : { "downloadApplicationContent" : false }, "bootApplication" : { "updateBootProjectAfterDownload" : true, "updateBootProjectAfterOnlineChange" : true, "remindBootApplicationOnClose" : true, "verifyBootApplicationAfterCreation" : true } } } }, "applicationResponse" : { "value" : { "name" : "Application1", "elementType" : "Application", "children" : [ "library-manager" ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "TestText" }, "applicationBuildOptions" : { "downloadApplicationContent" : false }, "bootApplication" : { "updateBootProjectAfterDownload" : true, "updateBootProjectAfterOnlineChange" : true, "remindBootApplicationOnClose" : true, "verifyBootApplicationAfterCreation" : true } }, "isOnline" : false } }, "actionRequest" : { "value" : { "name" : "ACT", "elementType" : "Action", "language" : "ST", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "implementation" : "i:=i+1;\nreturn;\n" } }, "actionResponse" : { "value" : { "name" : "ACT", "elementType" : "Action", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "language" : "ST", "implementation" : "i:=i+1;\nreturn;\n" } }, "dutRequest" : { "value" : { "name" : "Enum1", "elementType" : "DUT", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "declaration" : "{attribute 'qualified_only'}\n{attribute 'strict'}\nTYPE Enum1 :\n(\n\trot := 0,\n\tgelb :=1\n);\nEND_TYPE\n", "textlistsupport" : true } }, "dutResponse" : { "value" : { "name" : "Enum1", "elementType" : "DUT", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "declaration" : "{attribute 'qualified_only'}\n{attribute 'strict'}\nTYPE Enum1 :\n(\n\trot := 0,\n\tgelb :=1\n);\nEND_TYPE\n", "textlistsupport" : true } }, "gvlRequest" : { "value" : { "name" : "MyGVL", "elementType" : "GVL", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "declaration" : "{attribute 'qualified_only'}\nVAR_GLOBAL\nEND_VAR" } }, "gvlResponse" : { "value" : { "name" : "MyGVL", "elementType" : "GVL", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "declaration" : "{attribute 'qualified_only'}\nVAR_GLOBAL\nEND_VAR" } }, "plcLogicRequest" : { "value" : { "name" : "Plc Logic", "elementType" : "PLCLogic", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } } } }, "plcLogicResponse" : { "value" : { "name" : "Plc Logic", "elementType" : "PLCLogic", "children" : [ "Application" ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } } } }, "pouRequest" : { "value" : { "name" : "POU1", "elementType" : "POU", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "language" : "ST", "declaration" : "PROGRAM POU1\nVAR\nEND_VAR\n", "implementation" : "", "level" : "Standard" } }, "pouResponse" : { "value" : { "name" : "POU1", "elementType" : "POU", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "language" : "ST", "declaration" : "PROGRAM POU1\nVAR\nEND_VAR\n", "implementation" : "", "level" : "Standard" } }, "pouMethodRequest" : { "value" : { "name" : "METH", "elementType" : "POUMethod", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "language" : "ST", "declaration" : "", "implementation" : "" } }, "pouMethodResponse" : { "value" : { "name" : "METH", "elementType" : "POUMethod", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "language" : "ST", "declaration" : "METHOD METH\nVAR_INPUT\nEND_VAR\n", "implementation" : "" } }, "pouPropertyRequest" : { "value" : { "name" : "Prop", "elementType" : "POUProperty", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "language" : "ST", "declaration" : "PROPERTY Prop : bool\n" } }, "pouPropertyResponse" : { "value" : { "name" : "Prop", "elementType" : "POUProperty", "children" : [ "Set", "Get" ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "language" : "ST", "declaration" : "PROPERTY Prop : bool\n" } }, "pouPropertyGetRequest" : { "value" : { "name" : "Get", "elementType" : "POUPropertyGet", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "language" : "ST", "declaration" : "VAR\ni:INT;\nEND_VAR", "implementation" : "//This is the implementation" } }, "pouPropertyGetResponse" : { "value" : { "name" : "Get", "elementType" : "POUPropertyGet", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "language" : "ST", "declaration" : "VAR\ni:INT;\nEND_VAR", "implementation" : "//This is the implementation" } }, "pouPropertySetRequest" : { "value" : { "name" : "Set", "elementType" : "POUPropertySet", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "language" : "ST", "declaration" : "VAR\n i:INT;\nEND_VAR", "implementation" : "//Implementation" } }, "pouPropertySetResponse" : { "value" : { "name" : "Set", "elementType" : "POUPropertySet", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "language" : "ST", "declaration" : "VAR\n i:INT;\nEND_VAR", "implementation" : "//Implementation" } }, "libraryManagerRequest" : { "value" : { "name" : "Library Manager", "elementType" : "LibraryManager", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } } } }, "libraryManagerResponse" : { "value" : { "name" : "Library Manager", "displayName" : "Library Manager", "elementType" : "LibraryManager", "children" : [ "IecVarAccess" ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } } } }, "addLibraryRequest" : { "value" : { "name" : "_DEFAULT_CXA_Library_Template", "elementType" : "Library", "version" : "1.0.0.0", "company" : "BoschRexroth", "placeholderName" : "" } }, "addLibraryResponse" : { "value" : { "name" : "_DEFAULT_CXA_Library_Template", "elementType" : "Library", "id" : null, "children" : [ ], "elementProperties" : { }, "version" : "1.0.0.0", "company" : "BoschRexroth", "placeholderName" : "", "displayName" : "_DEFAULT_CXA_Library_Template, 1.0.0.0 (BoschRexroth)", "effectiveVersion" : "1.0.0.0", "systemLibrary" : false, "description" : "Brief description of the Lib (max. 80 characters)", "resolutionInfo" : "", "parameters" : null } }, "recipeManagerRequest" : { "value" : { "name" : "Recipe Manager", "elementType" : "RecipeManager", "displayName" : "Recipe Manager", "storageType" : "Binary", "fileExtension" : ".txtrecipe", "filePath" : "", "separator" : ":=", "columnList" : "0|1", "autoSaveRecipe" : true, "loadType" : "ExactVariableList", "writeType" : "LimitVariablesToMinMax", "checkRecipeForChanges" : false, "recipeManagementInPlc" : true } }, "recipeManagerResponse" : { "value" : { "name" : "Recipe Manager", "elementType" : "RecipeManager", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "displayName" : "Recipe Manager", "storageType" : "Binary", "fileExtension" : ".txtrecipe", "filePath" : "", "separator" : ":=", "columnList" : "0|1", "autoSaveRecipe" : true, "loadType" : "ExactVariableList", "writeType" : "LimitVariablesToMinMax", "checkRecipeForChanges" : false, "recipeManagementInPlc" : true } }, "recipeDefinitionRequest" : { "value" : { "name" : "RecipeDef", "elementType" : "RecipeDefinition", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } } } }, "recipeDefinitionResponse" : { "value" : { "name" : "RecipeDef", "elementType" : "RecipeDefinition", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } } } }, "taskConfigRequest" : { "value" : { "name" : "task-config", "elementType" : "TaskConfig", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "taskGroups" : [ { "groupName" : "TestGroup1", "core" : -1 }, { "groupName" : "TestGroup2", "core" : 2 } ] } }, "taskConfigResponse" : { "value" : { "name" : "task-config", "elementType" : "TaskConfig", "children" : [ "Task" ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "displayName" : "Task Configuration", "taskGroups" : [ { "groupName" : "IEC-Tasks", "core" : -2 }, { "groupName" : "TestGroup1", "core" : -1 }, { "groupName" : "TestGroup2", "core" : 2 } ] } }, "taskRequest" : { "value" : { "name" : "MyTask", "elementType" : "Task", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "priority" : "29", "taskGroup" : "IEC-Tasks", "type" : { "name" : "external", "value" : "TASK_EXTERNAL_EVENT_05" }, "watchdog" : { "enable" : true, "time" : "t#200ms", "sensitivity" : "8" }, "pouCalls" : [ { "name" : "pou1", "comment" : "xyz" }, { "name" : "pou2", "comment" : "xyz" } ] } }, "taskResponse" : { "value" : { "name" : "MyTask", "elementType" : "Task", "children" : [ "pou1.Unknown_TaskPOUCallObject", "pou2.Unknown_TaskPOUCallObject" ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "priority" : "29", "taskGroup" : "IEC-Tasks", "type" : { "name" : "external", "value" : "TASK_EXTERNAL_EVENT_05" }, "watchdog" : { "enable" : true, "time" : "t#200ms", "sensitivity" : "8" }, "pouCalls" : [ { "name" : "pou1", "comment" : "xyz" }, { "name" : "pou2", "comment" : "xyz" } ] } }, "symbolConfigRequest" : { "value" : { "name" : "symbol-config", "elementType" : "SymbolConfig", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "includeCommentsInXML" : true, "supportOPCUA" : true, "optimizedLayout" : true, "symbols" : [ { "libraryNamespace" : "", "name" : "Constants", "isSelected" : true, "variables" : [ { "name" : "RuntimeVersion", "accessRights" : "Void", "maximalAccess" : "Read", "attribute" : "Void", "type" : "VERSION", "fullQualifiedBaseType" : "VERSION", "comment" : " the runtime version number as defined by the device description.", "variableType" : "Var", "isSelected" : false }, { "name" : "CompilerVersion", "accessRights" : "Void", "maximalAccess" : "Read", "attribute" : "Void", "type" : "VERSION", "fullQualifiedBaseType" : "VERSION", "comment" : " the compiler version as defined in the build options (not OEM Customized Version!)", "variableType" : "Var", "isSelected" : false } ] } ], "types" : [ { "libraryNamespace" : "", "name" : "VERSION", "isSelected" : true, "variables" : [ { "name" : "uiMajor", "accessRights" : "Void", "maximalAccess" : "ReadWrite", "attribute" : "Void", "type" : "UINT", "fullQualifiedBaseType" : null, "comment" : "", "variableType" : "Var", "isSelected" : false }, { "name" : "uiMinor", "accessRights" : "Void", "maximalAccess" : "ReadWrite", "attribute" : "Void", "type" : "UINT", "fullQualifiedBaseType" : null, "comment" : "", "variableType" : "Var", "isSelected" : false }, { "name" : "uiServicePack", "accessRights" : "Void", "maximalAccess" : "ReadWrite", "attribute" : "Void", "type" : "UINT", "fullQualifiedBaseType" : null, "comment" : "", "variableType" : "Var", "isSelected" : false }, { "name" : "uiPatch", "accessRights" : "Void", "maximalAccess" : "ReadWrite", "attribute" : "Void", "type" : "UINT", "fullQualifiedBaseType" : null, "comment" : "", "variableType" : "Var", "isSelected" : false } ] } ] } }, "symbolConfigResponse" : { "value" : { "name" : "symbol-config", "elementType" : "SymbolConfig", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "displayName" : "Symbol Configuration", "includeCommentsInXML" : true, "supportOPCUA" : true, "optimizedLayout" : true, "symbols" : [ { "libraryNamespace" : "", "name" : "Constants", "isSelected" : true, "variables" : [ { "name" : "RuntimeVersion", "accessRights" : "Void", "maximalAccess" : "Read", "attribute" : "Void", "type" : "VERSION", "fullQualifiedBaseType" : "VERSION", "comment" : " the runtime version number as defined by the device description.", "variableType" : "Var", "isSelected" : false }, { "name" : "CompilerVersion", "accessRights" : "Void", "maximalAccess" : "Read", "attribute" : "Void", "type" : "VERSION", "fullQualifiedBaseType" : "VERSION", "comment" : " the compiler version as defined in the build options (not OEM Customized Version!)", "variableType" : "Var", "isSelected" : false } ] } ], "types" : [ { "libraryNamespace" : "", "name" : "VERSION", "isSelected" : true, "variables" : [ { "name" : "uiMajor", "accessRights" : "Void", "maximalAccess" : "ReadWrite", "attribute" : "Void", "type" : "UINT", "fullQualifiedBaseType" : null, "comment" : "", "variableType" : "Var", "isSelected" : false }, { "name" : "uiMinor", "accessRights" : "Void", "maximalAccess" : "ReadWrite", "attribute" : "Void", "type" : "UINT", "fullQualifiedBaseType" : null, "comment" : "", "variableType" : "Var", "isSelected" : false }, { "name" : "uiServicePack", "accessRights" : "Void", "maximalAccess" : "ReadWrite", "attribute" : "Void", "type" : "UINT", "fullQualifiedBaseType" : null, "comment" : "", "variableType" : "Var", "isSelected" : false }, { "name" : "uiPatch", "accessRights" : "Void", "maximalAccess" : "ReadWrite", "attribute" : "Void", "type" : "UINT", "fullQualifiedBaseType" : null, "comment" : "", "variableType" : "Var", "isSelected" : false } ] } ] } }, "persistentVarsRequest" : { "value" : { "name" : "PersistentVars", "elementType" : "PersistentVars", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "declaration" : "{attribute 'qualified_only'}\nVAR_GLOBAL PERSISTENT RETAIN\nEND_VAR" } }, "persistentVarsResponse" : { "value" : { "name" : "PersistentVars", "elementType" : "PersistentVars", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "declaration" : "{attribute 'qualified_only'}\nVAR_GLOBAL PERSISTENT RETAIN\nEND_VAR" } }, "projectSettingsRequest" : { "value" : { "name" : "project-settings", "elementType" : "ProjectSettings" } }, "projectSettingsResponse" : { "value" : { "name" : "project-settings", "displayName" : "Project Settings", "elementType" : "ProjectSettings", "children" : [ "Compile options", "Compiler warnings", "Library development", "Page Setup", "Security", "SFC", "Source Download", "Static Analysis Light", "Users and Groups", "Visualization", "Visualization Profile" ], "elementProperties" : { } } }, "sfcEditorRequest" : { "value" : { "name" : "SFC", "elementType" : "SfcEditor", "flags" : [ { "name" : "SFCEnableLimit", "use" : true, "declare" : true }, { "name" : "SFCInit", "use" : true, "declare" : true }, { "name" : "SFCReset", "use" : true, "declare" : true }, { "name" : "SFCQuitError", "use" : true, "declare" : true }, { "name" : "SFCPause", "use" : true, "declare" : true }, { "name" : "SFCError", "use" : true, "declare" : true }, { "name" : "SFCTrans", "use" : true, "declare" : true }, { "name" : "SFCErrorStep", "use" : true, "declare" : true }, { "name" : "SFCErrorPOU", "use" : true, "declare" : true }, { "name" : "SFCCurrentStep", "use" : true, "declare" : true }, { "name" : "SFCTip", "use" : true, "declare" : true }, { "name" : "SFCTipMode", "use" : true, "declare" : true }, { "name" : "SFCErrorAnalyzation", "use" : true, "declare" : true }, { "name" : "SFCErrorAnalyzationTable", "use" : true, "declare" : true } ], "build" : { "calcActiveTransOnly" : false }, "applyToAll" : true } }, "sfcEditorResponse" : { "value" : { "name" : "SFC", "elementType" : "SfcEditor", "flags" : [ { "name" : "SFCEnableLimit", "use" : true, "declare" : true }, { "name" : "SFCInit", "use" : true, "declare" : true }, { "name" : "SFCReset", "use" : true, "declare" : true }, { "name" : "SFCQuitError", "use" : true, "declare" : true }, { "name" : "SFCPause", "use" : true, "declare" : true }, { "name" : "SFCError", "use" : true, "declare" : true }, { "name" : "SFCTrans", "use" : true, "declare" : true }, { "name" : "SFCErrorStep", "use" : true, "declare" : true }, { "name" : "SFCErrorPOU", "use" : true, "declare" : true }, { "name" : "SFCCurrentStep", "use" : true, "declare" : true }, { "name" : "SFCTip", "use" : true, "declare" : true }, { "name" : "SFCTipMode", "use" : true, "declare" : true }, { "name" : "SFCErrorAnalyzation", "use" : true, "declare" : true }, { "name" : "SFCErrorAnalyzationTable", "use" : true, "declare" : true } ], "build" : { "calcActiveTransOnly" : false }, "applyToAll" : true } }, "recipeRequest" : { "value" : { "name" : "recipe1", "elementType" : "Recipe", "variables" : [ { "name" : "PLC_PRG.j", "value" : "1" } ] } }, "recipeResponse" : { "value" : { "name" : "recipe1", "elementType" : "Recipe", "children" : [ ], "elementProperties" : { }, "variables" : [ { "name" : "PLC_PRG.j", "value" : "1" } ] } }, "recipeVariableRequest" : { "value" : { "name" : "PLC_PRG.i", "elementType" : "RecipeVariable", "additionalName" : "PLC_PRG.i", "comment" : "CommentIndex", "lowerBound" : "5", "upperBound" : "14", "recipes" : [ { "name" : "recipe1", "value" : "5" }, { "name" : "recipe2", "value" : "8" }, { "name" : "recipe3", "value" : "1" } ] } }, "recipeVariableResponse" : { "value" : { "name" : "PLC_PRG.i", "elementType" : "RecipeVariable", "children" : [ ], "elementProperties" : { }, "additionalName" : "PLC_PRG.i", "variableType" : "", "comment" : "CommentIndex", "lowerBound" : "5", "upperBound" : "14", "recipes" : [ { "name" : "recipe1", "value" : "5" }, { "name" : "recipe2", "value" : "8" }, { "name" : "recipe3", "value" : "1" } ] } }, "importFieldbusConfigJobRequest" : { "value" : { "jobType" : "ImportFieldbusConfigJob", "jobParameters" : { "nodeUrl" : "/devices/device/Realtime_Data", "username" : "username", "password" : "password", "busType" : "Ethercat", "forceInsert" : true } } }, "importFieldbusConfigJobResponse" : { "value" : { "id" : "4277e217d3bbf9be", "state" : "Done", "progress" : 100, "jobType" : "ImportFieldbusConfigJob", "jobParameters" : { "nodeUrl" : "/devices/device/Realtime_Data", "username" : "username", "password" : "password", "busType" : "Ethercat", "forceInsert" : true }, "jobResultInfo" : "Existing 'Ethercat' elements successfully imported." } }, "preCompileJobDisableRequest" : { "value" : { "jobType" : "PreCompileJob", "jobParameters" : { "action" : "Disable" } } }, "preCompileJobDisableResponse" : { "value" : { "id" : "28fcdc4e05b4e310", "state" : "Done", "progress" : 100, "jobType" : "PreCompileJob", "jobParameters" : { "action" : "Disable" }, "jobResultInfo" : "PreCompile is disabled." } }, "preCompileJobEnableRequest" : { "value" : { "jobType" : "PreCompileJob", "jobParameters" : { "action" : "Enable" } } }, "preCompileJobEnableResponse" : { "value" : { "id" : "28fcdc4e05b4e377", "state" : "Done", "progress" : 100, "jobType" : "PreCompileJob", "jobParameters" : { "action" : "Enable" }, "jobResultInfo" : "PreCompile is enabled." } }, "projectJobOpenRequest" : { "value" : { "jobType" : "ProjectJob", "jobParameters" : { "action" : "Open", "path" : "D:\\ctrlX\\PLCProjects\\OpenApiPLC.project", "keepProjectVersion" : false, "projectEnvironment" : "SetAllToNewest" } } }, "projectJobOpenResponse" : { "value" : { "id" : "ec0d3b1242aa54b0", "state" : "Done", "progress" : 100, "jobType" : "ProjectJob", "jobParameters" : { "action" : "Open", "path" : "D:\\ctrlX\\PLCProjects\\OpenApiPLC.project", "keepProjectVersion" : false, "projectEnvironment" : "SetAllToNewest" }, "jobResultInfo" : "Project ' at D:\\ctrlX\\PLCProjects\\OpenApiPLC.project.' successfully opened." } }, "projectJobCloseRequest" : { "value" : { "jobType" : "ProjectJob", "jobParameters" : { "action" : "Close" } } }, "projectJobCloseResponse" : { "value" : { "id" : "28fcdc4e05b4e309", "state" : "Done", "progress" : 100, "jobType" : "ProjectJob", "jobParameters" : { "action" : "Close" }, "jobResultInfo" : "Project successfully closed." } }, "projectJobSaveRequest" : { "value" : { "jobType" : "ProjectJob", "jobParameters" : { "action" : "Save" } } }, "projectJobSaveResponse" : { "value" : { "id" : "d00d87074fa4219", "state" : "Done", "progress" : 100, "jobType" : "ProjectJob", "jobParameters" : { "action" : "Save" }, "jobResultInfo" : "Project successfully saved." } }, "projectJobSaveAsRequest" : { "value" : { "jobType" : "ProjectJob", "jobParameters" : { "action" : "Save", "path" : "D:\\ctrlX\\PLCProjects\\jobs\\OpenApiPLC.project" } } }, "projectJobSaveAsResponse" : { "value" : { "id" : "bfaf6c3d6a17d8e3", "state" : "Done", "progress" : 100, "jobType" : "ProjectJob", "jobParameters" : { "action" : "Save", "path" : "D:\\ctrlX\\PLCProjects\\jobs\\OpenApiPLC.project" }, "jobResultInfo" : "Project successfully saved at D:\\ctrlX\\PLCProjects\\jobs\\OpenApiPLC.project." } }, "projectJobSaveAndInstallIntoLibraryRepositoryRequest" : { "value" : { "jobType" : "ProjectJob", "jobParameters" : { "action" : "SaveAndInstallIntoLibraryRepository" } } }, "projectJobSaveAndInstallIntoLibraryRepositoryResponse" : { "value" : { "id" : "23729749cffd82f", "state" : "Done", "progress" : 100, "jobType" : "ProjectJob", "jobParameters" : { "action" : "SaveAndInstallIntoLibraryRepository" }, "jobResultInfo" : "Project successfully saved and installed into library repository." } }, "projectJobSaveAsCompiledLibraryRequest" : { "value" : { "jobType" : "ProjectJob", "jobParameters" : { "action" : "SaveAsCompiledLibrary", "path" : "D:\\ctrlX\\Libraries\\CompiledLibrary1.compiled-library" } } }, "projectJobSaveAsCompiledLibraryResponse" : { "value" : { "id" : "23729749cffd82f", "state" : "Done", "progress" : 100, "jobType" : "ProjectJob", "jobParameters" : { "action" : "SaveAsCompiledLibrary" }, "jobResultInfo" : "Project successfully saved as compiled library." } }, "publishMarkedMethodsJobRequest" : { "value" : { "jobType" : "PublishMarkedMethodsJob", "jobParameters" : { "nodeUrl" : "/devices/device/PLC Logic/application/symbol-config" } } }, "publishMarkedMethodsJobResponse" : { "value" : { "id" : "26d32628ee200ea", "state" : "Done", "progress" : 100, "jobType" : "PublishMarkedMethodsJob", "jobParameters" : { "nodeUrl" : "/devices/device/PLC Logic/application/symbol-config" }, "jobResultInfo" : "Successfully published all methods marked with the attribute 'CxRpcEnable'" } }, "pubSubJobSetAsPublisherRequest" : { "value" : { "jobType" : "PubSubJob", "jobParameters" : { "nodeUrl" : "/devices/device/PLC Logic/Application/GVL", "action" : "SetAsPublisher" } } }, "pubSubJobSetAsPublisherResponse" : { "value" : { "id" : "e4f5fcc52ccddac4", "state" : "Done", "progress" : 100, "jobType" : "PubSubJob", "jobParameters" : { "nodeUrl" : "/devices/device/PLC Logic/Application/GVL", "action" : "SetAsPublisher" }, "jobResultInfo" : "Node GVL successfully set as Publisher." } }, "pubSubJobSetAsSubscriberRequest" : { "value" : { "jobType" : "PubSubJob", "jobParameters" : { "nodeUrl" : "/devices/device/PLC Logic/Application/GVL", "action" : "SetAsSubscriber" } } }, "pubSubJobSetAsSubscriberResponse" : { "value" : { "id" : "fc226cf6b0d69404", "state" : "Done", "progress" : 100, "jobType" : "PubSubJob", "jobParameters" : { "nodeUrl" : "/devices/device/PLC Logic/Application/GVL", "action" : "SetAsSubscriber" }, "jobResultInfo" : "Node GVL successfully set as Subscriber." } }, "exportJobRequest" : { "value" : { "jobType" : "ExportJob", "jobParameters" : { "nodeUrl" : "/devices/device/PLC Logic/Application", "filePath" : "X:\\ctrlX\\Projects\\ImportExport", "fileName" : "Application.export", "oneFilePerSubtree" : false, "includeSubNodes" : true } } }, "exportJobResponse" : { "value" : { "id" : "ba4083cffdb6e56f", "state" : "Done", "progress" : 100, "jobType" : "ExportJob", "jobParameters" : { "nodeUrl" : "/devices/device/PLC Logic/Application", "filePath" : "X:\\ctrlX\\Projects\\ImportExport", "fileName" : "Application.export", "oneFilePerSubtree" : false, "includeSubNodes" : true }, "jobResultInfo" : "Export successful." } }, "exportPlcOpenXmlJobRequest" : { "value" : { "jobType" : "ExportPlcOpenXmlJob", "jobParameters" : { "nodeUrl" : "/devices/device/PLC Logic/Application/POU_SFC", "filePath" : "D:\\ctrlX\\PLCProjects\\PLCOpenExport", "fileName" : "POU_SFC.xml" } } }, "exportPlcOpenXmlJobResponse" : { "value" : { "id" : "c23b4e5eb2d52a8", "state" : "Done", "progress" : 100, "jobType" : "ExportPlcOpenXmlJob", "jobParameters" : { "nodeUrl" : "/devices/device/PLC Logic/Application/POU_SFC", "filePath" : "D:\\ctrlX\\PLCProjects\\PLCOpenExport", "fileName" : "POU_SFC.xml" }, "jobResultInfo" : "File 'POU_SFC.xml' successfully exported." } }, "importJobRequest" : { "value" : { "jobType" : "ImportJob", "jobParameters" : { "nodeUrl" : "/devices/device/PLC Logic", "filePath" : "X:\\ctrlX\\Projects\\ImportExport", "fileName" : "Application.export" } } }, "importJobResponse" : { "value" : { "id" : "e4b42ce463540d68", "state" : "Done", "progress" : 100, "jobType" : "ImportJob", "jobParameters" : { "nodeUrl" : "/devices/device/PLC Logic", "filePath" : "X:\\ctrlX\\Projects\\ImportExport", "fileName" : "Application.export" }, "jobResultInfo" : "File 'Application.export' successfully Imported. " } }, "importPlcOpenXmlJobRequest" : { "value" : { "jobType" : "ImportPlcOpenXmlJob", "jobParameters" : { "nodeUrl" : "/devices/device/PLC Logic/Application", "filePath" : "D:\\ctrlX\\PLCProjects\\PLCOpenExport", "fileName" : "POU_SFC.xml" } } }, "importPlcOpenXmlJobResponse" : { "value" : { "id" : "7ca9ca288f272303", "state" : "Done", "progress" : 100, "jobType" : "ImportPlcOpenXmlJob", "jobParameters" : { "nodeUrl" : "/devices/device/PLC Logic/Application", "filePath" : "D:\\ctrlX\\PLCProjects\\PLCOpenExport", "fileName" : "POU_SFC.xml" }, "jobResultInfo" : "File 'POU_SFC.xml' successfully Imported." } }, "nvlSenderResponse" : { "value" : { "name" : "NVL_2", "elementType" : "GVL", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "declaration" : "{attribute 'qualified_only'}\nVAR_GLOBAL\nEND_VAR", "networkVariables" : { "networkType" : "UDP", "task" : "MainTask", "listIdentifier" : "1", "packVariables" : true, "transmitChecksum" : false, "acknowledgement" : false, "cyclicTransmission" : { "enable" : true, "interval" : "T#50ms" }, "transmitOnChange" : { "enable" : false, "minimumGap" : "T#20ms" }, "transmitOnEvent" : { "enable" : false, "variable" : "" }, "settings" : { "enable" : true, "parameters" : [ { "name" : "Port", "value" : "1202" }, { "name" : "Broadcast Adr.", "value" : "255.255.255.255" } ] } } } }, "nvlSenderRequest" : { "value" : { "name" : "NVL_2", "elementType" : "GVL", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "declaration" : "{attribute 'qualified_only'}\nVAR_GLOBAL\nEND_VAR", "networkVariables" : { "networkType" : "UDP", "task" : "MainTask", "listIdentifier" : "1", "packVariables" : true, "transmitChecksum" : false, "acknowledgement" : false, "cyclicTransmission" : { "enable" : true, "interval" : "T#50ms" }, "transmitOnChange" : { "enable" : false, "minimumGap" : "T#20ms" }, "transmitOnEvent" : { "enable" : false, "variable" : "" }, "settings" : { "parameters" : [ { "name" : "Port", "value" : "1202" }, { "name" : "Broadcast Adr.", "value" : "255.255.255.255" } ] } } } }, "nvlReceiverResponse" : { "value" : { "name" : "NVL_2", "elementType" : "NVLReceiver", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "declaration" : "//This gobal variable list is received via the network.\n//Sender: NVL [ctrlX_COREvirtual: PLC Logic: Application]\n//Protocol: UDP\n\n{attribute 'qualified_only'}\nVAR_GLOBAL PERSISTENT RETAIN\n\t\nEND_VAR\nVAR_GLOBAL\n\ta: INT;\nEND_VAR", "networkSettings" : { "task" : "MainTask", "sender" : "NVL [ctrlX_COREvirtual: PLC Logic: Application]", "importFromFile" : "" } } }, "nvlReceiverRequest" : { "value" : { "name" : "NVL_2", "elementType" : "NVLReceiver", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "networkSettings" : { "task" : "MainTask", "sender" : "NVL [ctrlX_COREvirtual: PLC Logic: Application]", "importFromFile" : "" } } }, "openEditorJobRequest" : { "value" : { "jobType" : "OpenEditorJob", "jobParameters" : { "nodeUrl" : "/devices/Device/PLC Logic/Application/PLC_PRG" } } }, "openEditorJobResponse" : { "value" : { "id" : "bdcbebbfb96af862", "state" : "Done", "progress" : 100, "jobType" : "OpenEditorJob", "jobParameters" : { "nodeUrl" : "/devices/Device/PLC Logic/Application/PLC_PRG" }, "jobResultInfo" : "" } }, "libraryParameterPatchRequest" : { "value" : { "parameters" : [ { "name" : "param1", "value" : "50" }, { "name" : "param2", "value" : "50" } ] } }, "libraryParameterPatchResponse" : { "value" : { "name" : "ExampleLib", "elementType" : "Library", "children" : [ ], "elementProperties" : { }, "version" : "1.0.0.0", "company" : "Rexroth", "placeholderName" : "", "displayName" : "ExampleLib, 1.0.0.0 (Rexroth)", "effectiveVersion" : "1.0.0.0", "systemLibrary" : false, "description" : "", "resolutionInfo" : "", "parameters" : [ { "name" : "param1", "value" : "50" }, { "name" : "param2", "value" : "50" } ] } }, "eplanJobCreateNewProjectRequest" : { "value" : { "jobType" : "EplanJob", "jobParameters" : { "action" : "CreateNewProjectViaEplanImport", "amlFile" : "D:\\Eplan\\Plc_ETH_PN_EIP.aml", "projectName" : "EplanProj.plc.project", "projectLocation" : "D:\\My ctrlX\\Eplan" } } }, "eplanJobCreateNewProjectResponse" : { "value" : { "id" : "7210fd1313abc631", "state" : "Done", "progress" : 100, "jobType" : "EplanJob", "jobParameters" : { "action" : "CreateNewProjectViaEplanImport", "amlFile" : "D:\\Eplan\\Plc_ETH_PN_EIP.aml", "projectName" : "EplanProj.plc.project", "projectLocation" : "D:\\My ctrlX\\Eplan" }, "jobResultInfo" : "Eplan Import Successful." } }, "eplanJobImportRequest" : { "value" : { "jobType" : "EplanJob", "jobParameters" : { "action" : "ImportFromEplan", "amlFile" : "D:\\Eplan\\Plc_ETH_PN_EIP.aml" } } }, "eplanJobImportResponse" : { "value" : { "id" : "f8e46d7dacce1a0e", "state" : "Done", "progress" : 100, "jobType" : "EplanJob", "jobParameters" : { "action" : "ImportFromEplan", "amlFile" : "D:\\Eplan\\Plc_ETH_PN_EIP.aml" }, "jobResultInfo" : "Eplan Import Successful." } }, "eplanJobImportEthercatParameterRequest" : { "value" : { "jobType" : "EplanJob", "jobParameters" : { "action" : "ImportEthercatParameterFromEplan", "amlFile" : "D:\\Eplan\\Plc_ETH_PN_EIP.aml" } } }, "eplanJobImportEthercatParameterResponse" : { "value" : { "id" : "f8e46d7dacce1a0e", "state" : "Done", "progress" : 100, "jobType" : "EplanJob", "jobParameters" : { "action" : "ImportEthercatParameterFromEplan", "amlFile" : "D:\\Eplan\\Plc_ETH_PN_EIP.aml" }, "jobResultInfo" : "Ethercat parameter updated successfully." } }, "projectInfoRequest" : { "value" : { "name" : "project-info", "elementType" : "ProjectInfo", "properties" : { "title" : "_DEFAULT_CXA_Library_Template", "company" : "BoschRexroth", "version" : "1.2.3.4", "released" : false, "author" : "Newton", "placeholder" : "ADAPT_THIS_PLACEHOLDER_VALUE_OR_REMOVE_THE_KEY_COMPLETELY", "description" : "descrption", "defaultNamespace" : "Default ", "docFormat" : "reStructuredText", "libDocContent" : "CommentsAndDocs", "libraryCategories" : [ "ctrlX AUTOMATION|Base", "ctrlX AUTOMATION|Communication" ], "generateLibInfo" : false, "generateProjInfo" : false } } }, "projectInfoResponse" : { "value" : { "name" : "project-info", "displayName" : "Project Information", "elementType" : "ProjectInfo", "children" : [ ], "elementProperties" : { }, "properties" : { "author" : "Newton", "company" : "BoschRexroth", "compiledLibraryCompatibilityVersion" : "ctrlX PLC 1.3.0", "defaultNamespace" : "Default namespace", "description" : "descrption", "docFormat" : "reStructuredText", "libDocContent" : "CommentsAndDocs", "libraryCategories" : [ "ctrlX AUTOMATION|Base", "ctrlX AUTOMATION|Communication" ], "placeholder" : "ADAPT_THIS_PLACEHOLDER_VALUE_OR_REMOVE_THE_KEY_COMPLETELY", "project" : "ApiTest", "released" : true, "title" : "_DEFAULT_CXA_Library_Template", "version" : "1.2.3.4", "generateLibInfo" : false, "generateProjInfo" : false } } }, "importOfflineFieldbusConfigJobRequest" : { "value" : { "jobType" : "ImportOfflineFieldbusConfigJob", "jobParameters" : { "nodeUrl" : "/devices/device/Realtime_Data", "filePath" : "D:\\", "fileName" : "Ethercat.xml", "busType" : "Ethercat", "forceInsert" : true, "keepExisting" : false } } }, "importOfflineFieldbusConfigJobResponse" : { "value" : { "id" : "66e24819dbfabb8e", "state" : "Done", "progress" : 100, "jobType" : "ImportOfflineFieldbusConfigJob", "jobParameters" : { "nodeUrl" : "/devices/device/Realtime_Data", "filePath" : "D:\\", "fileName" : "Ethercat.xml", "busType" : "Ethercat", "forceInsert" : true, "keepExisting" : false }, "jobResultInfo" : "Existing 'Ethercat' elements successfully imported." } }, "compileOptionsEditorRequest" : { "value" : { "name" : "Compile options", "elementType" : "CompileOptionsEditor", "fixCompilerVersion" : "3.5.12.60", "settings" : { "allowUniCodeIdentifiers" : true, "replaceConstants" : true, "enableBreakpointLogging" : true }, "maxCompilerWarnings" : "50" } }, "compileOptionsEditorResponse" : { "value" : { "name" : "Compile options", "elementType" : "CompileOptionsEditor", "children" : [ ], "elementProperties" : { }, "fixCompilerVersion" : "3.5.17.0", "settings" : { "allowUniCodeIdentifiers" : true, "replaceConstants" : true, "enableBreakpointLogging" : true }, "maxCompilerWarnings" : "" } }, "moveElementsJobRequest" : { "value" : { "jobType" : "MoveElementsJob", "jobParameters" : { "sourceNodeUrl" : "devices/device/PLC Logic/Application/Folder1", "destinationNodeUrl" : "devices/device/PLC Logic/Application/Folder2" } } }, "moveElementsJobResponse" : { "value" : { "id" : "31a43fb7ad83edf3", "state" : "Done", "progress" : 100, "jobType" : "MoveElementsJob", "jobParameters" : { "sourceNodeUrl" : "devices/device/PLC Logic/Application/Folder1", "destinationNodeUrl" : "devices/device/PLC Logic/Application/Folder2" }, "jobResultInfo" : "Elements moved successfully." } }, "findElementsJobRequest" : { "value" : { "jobType" : "FindElementsJob", "jobParameters" : { "nodeUrl" : "devices/Device/PLC Logic/Application", "findText" : "folder", "findId" : "0ac0a639-1834-4e05-af0b-929ab7b95ab7", "matchCase" : false, "matchWholeWord" : false, "searchOptions" : "NodeAndSubNodes" } } }, "findElementsJobResponse" : { "value" : { "id" : "7e4f477cf07cd0b1", "state" : "Done", "progress" : 100, "jobType" : "FindElementsJob", "jobParameters" : { "nodeUrl" : "devices/Device/PLC Logic/Application", "findText" : "folder", "findId" : "0ac0a639-1834-4e05-af0b-929ab7b95ab7", "matchCase" : false, "matchWholeWord" : false, "searchOptions" : "NodeAndSubNodes", "matchedNodeUrls" : [ "devices/Device/PLC Logic/Application/folder1" ] }, "jobResultInfo" : "FindElements Job completed successfully " } }, "disableDevicePatchRequest" : { "value" : { "disable" : false } }, "plcSettingsDevicePatchRequest" : { "value" : { "plcSettings" : { "applicationForIOHandling" : "Application", "updateIOWhileInStop" : true, "behaviorFoOutputsInStop" : "ExecuteProgram", "stopResetBehaviourUserProgram" : "POU", "alwaysUpdateVariables" : "Enabled 1 (use bus cycle task if not used in any task)", "busCycleTask" : "Task", "showIOWarningsAsErrors" : false, "enableDiagnosisForDevices" : false, "generateForceVariablesForIOMapping" : false } } }, "usersAndGroupsEditorResponse" : { "value" : { "name" : "Users and Groups", "elementType" : "UsersAndGroupsEditor", "id" : null, "children" : [ ], "elementProperties" : { }, "users" : [ { "name" : "Owner", "fullName" : "", "description" : "", "active" : true, "memberships" : [ "Everyone", "Owner" ] } ], "groups" : [ { "name" : "Everyone", "description" : "", "members" : [ "user 'Owner'" ] }, { "name" : "Owner", "description" : "", "members" : [ "user 'Owner'" ] } ], "settings" : { "maximumAuthenticationTrials" : { "checked" : true, "value" : 3 }, "logoutAfterTimeOfInactivity" : { "checked" : true, "value" : 10 }, "enableHashFormatPassword" : false } } }, "usersAndGroupsEditorRequest" : { "value" : { "name" : "Users and Groups", "elementType" : "UsersAndGroupsEditor", "settings" : { "maximumAuthenticationTrials" : { "checked" : true, "value" : 5 }, "logoutAfterTimeOfInactivity" : { "checked" : true, "value" : 1 }, "enableHashFormatPassword" : false } } }, "exportUsersAndGroupsJobRequest" : { "value" : { "jobType" : "ExportUsersAndGroupsJob", "jobParameters" : { "filePath" : "D:\\Test", "fileName" : "userAndGroups" } } }, "exportUsersAndGroupsJobResponse" : { "value" : { "id" : "27e1c833c44d7217", "state" : "Done", "progress" : 100, "jobType" : "ExportUsersAndGroupsJob", "jobParameters" : { "filePath" : "D:\\Test", "fileName" : "userAndGroups" }, "jobResultInfo" : "Exported '1' users,'2' groups and '2' memberships" } }, "importUsersAndGroupsJobRequest" : { "value" : { "jobType" : "ImportUsersAndGroupsJob", "jobParameters" : { "filePath" : "D:\\Test", "fileName" : "userAndGroups" } } }, "importUsersAndGroupsJobResponse" : { "value" : { "id" : "98687ccdcb4534b1", "state" : "Done", "progress" : 100, "jobType" : "ImportUsersAndGroupsJob", "jobParameters" : { "filePath" : "D:\\Test", "fileName" : "userAndGroups" }, "jobResultInfo" : "Imported 1 users,0 groups and 0 memberships" } }, "interfaceRequest" : { "value" : { "name" : "ITF_1", "elementType" : "ITF", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "declaration" : "INTERFACE ITF_1\n", "displayName" : "ITF_1" } }, "interfaceResponse" : { "value" : { "name" : "ITF_1", "elementType" : "ITF", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "declaration" : "INTERFACE ITF_1\n", "displayName" : "ITF_1" } }, "interfaceMethodRequest" : { "value" : { "name" : "METH_1", "elementType" : "InterfaceMethod", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "displayName" : "METH_1", "declaration" : "METHOD METH_1\nVAR_INPUT\nEND_VAR\n" } }, "interfaceMethodResponse" : { "value" : { "name" : "METH_1", "elementType" : "InterfaceMethod", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "displayName" : "METH_1", "declaration" : "METHOD METH\nVAR_INPUT\nEND_VAR\n" } }, "interfacePropertyRequest" : { "value" : { "name" : "Prop_1", "elementType" : "InterfaceProperty", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "displayName" : "Prop_1", "declaration" : "PROPERTY Prop_1 : BOOL\n" } }, "interfacePropertyResponse" : { "value" : { "name" : "Prop_1", "elementType" : "InterfaceProperty", "children" : [ "Set", "Get" ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "displayName" : "Prop_1", "declaration" : "PROPERTY Prop_1 : BOOL\n" } }, "interfacePropertyGetRequest" : { "value" : { "name" : "Get", "elementType" : "InterfacePropertyGet", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "declaration" : "VAR\ni:INT;\nEND_VAR" } }, "interfacePropertyGetResponse" : { "value" : { "name" : "Get", "elementType" : "InterfacePropertyGet", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "declaration" : "VAR\ni:INT;\nEND_VAR" } }, "interfacePropertySetRequest" : { "value" : { "name" : "Set", "elementType" : "InterfacePropertySet", "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "declaration" : "VAR\n i:INT;\nEND_VAR" } }, "interfacePropertySetResponse" : { "value" : { "name" : "Set", "elementType" : "InterfacePropertySet", "children" : [ ], "elementProperties" : { "build" : { "excludeFromBuild" : false, "external" : false, "enableSystemCall" : false, "linkAlways" : false, "compilerDefines" : "" } }, "declaration" : "VAR\n i:INT;\nEND_VAR" } }, "userManagementLogInJobRequest" : { "value" : { "jobType" : "UserManagementLogInJob", "jobParameters" : { "userName" : "Owner", "password" : "" } } }, "userManagementLogInJobResponse" : { "value" : { "id" : "9df41385e6dd663d", "state" : "Done", "progress" : 100, "jobType" : "UserManagementLogInJob", "jobParameters" : { "userName" : "Owner", "password" : "" }, "jobResultInfo" : "User 'Owner' successfully logged in" } }, "userManagementLogOutJobRequest" : { "value" : { "jobType" : "UserManagementLogOutJob" } }, "userManagementLogOutJobResponse" : { "value" : { "id" : "505d51276f9e9061", "state" : "Done", "progress" : 100, "jobType" : "UserManagementLogOutJob", "jobParameters" : null, "jobResultInfo" : "Logout is successful." } }, "addUserRequest" : { "value" : { "name" : "user1", "elementType" : "User", "fullName" : "PLC User", "description" : "All rights", "password" : "a", "confirmPassword" : "a", "active" : true, "memberships" : [ "Owner" ] } }, "addGroupRequest" : { "value" : { "name" : "group1", "elementType" : "Group", "description" : "PLC group", "members" : [ "user Owner" ] } }, "userResponse" : { "value" : { "name" : "user1", "elementType" : "User", "id" : null, "children" : [ ], "elementProperties" : { }, "fullName" : "PLC User", "description" : "All rights", "oldPassword" : "********************************", "password" : "********************************", "confirmPassword" : "********************************", "active" : true, "memberships" : [ "Everyone", "Owner" ] } }, "groupResponse" : { "value" : { "name" : "group1", "elementType" : "Group", "id" : null, "children" : [ ], "elementProperties" : { }, "description" : "PLC group", "members" : [ "user 'Owner'" ] } }, "editUserRequest" : { "value" : { "name" : "user1", "elementType" : "User", "fullName" : "PLC user", "description" : "no rights", "oldPassword" : "a", "password" : "boschrexroth", "confirmPassword" : "boschrexroth", "active" : false, "memberships" : [ "Owner" ] } }, "newProjectJobRequest" : { "value" : { "jobType" : "NewProjectJob", "jobParameters" : { "filePath" : "D:\\test", "fileName" : "untitled1", "template" : "ctrlXOSx64" } } }, "newProjectJobResponse" : { "value" : { "id" : "fc599c58a032a2d1", "state" : "Done", "progress" : 100, "jobType" : "NewProjectJob", "jobParameters" : { "filePath" : "D:\\test", "fileName" : "untitled1", "template" : "ctrlXOSx64" }, "jobResultInfo" : "Project untitled1 successfully created at D:\\test." } }, "resetOriginRequest" : { "value" : { "jobType" : "ResetApplicationJob", "jobParameters" : { "action" : "ResetOrigin" } } }, "resetOriginResponse" : { "value" : { "id" : "3e18344f6f544c8d", "state" : "Pending", "progress" : 0, "jobType" : "ResetApplicationJob", "jobParameters" : { "action" : "ResetOrigin" }, "jobResultInfo" : "'Reset Origin' is successful." } }, "resetColdRequest" : { "value" : { "jobType" : "ResetApplicationJob", "jobParameters" : { "action" : "ResetCold" } } }, "resetColdResponse" : { "value" : { "id" : "1d1a3238c8f4d2bb", "state" : "Pending", "progress" : 0, "jobType" : "ResetApplicationJob", "jobParameters" : { "action" : "ResetCold" }, "jobResultInfo" : "'Reset Cold' is successful." } }, "resetWarmRequest" : { "value" : { "jobType" : "ResetApplicationJob", "jobParameters" : { "action" : "ResetWarm" } } }, "resetWarmResponse" : { "value" : { "id" : "f38d6e684749e3c3", "state" : "Pending", "progress" : 0, "jobType" : "ResetApplicationJob", "jobParameters" : { "action" : "ResetWarm" }, "jobResultInfo" : "'Reset Warm' is successful." } }, "applicationLoginJobRequest" : { "value" : { "jobType" : "ApplicationLoginJob", "jobParameters" : { "nodeUrl" : "/devices/Device/PLC Logic/Application", "loginOption" : "LoginWithOnlineChange", "updateBootApplication" : true } } }, "applicationLoginJobResponse" : { "value" : { "id" : "83ae29e8d3203f78", "state" : "Done", "progress" : 100, "jobType" : "ApplicationLoginJob", "jobParameters" : { "loginOption" : "LoginWithOnlineChange", "updateBootApplication" : true }, "jobResultInfo" : "Application loggedIn successfully" } }, "applicationStartJobRequest" : { "value" : { "jobType" : "ApplicationJob", "jobParameters" : { "action" : "Start", "nodeUrl" : "devices/Device/PLC Logic/Application" } } }, "applicationStartJobResponse" : { "value" : { "id" : "fb454ad2207d6ce8", "state" : "Done", "progress" : 100, "jobType" : "ApplicationJob", "jobParameters" : { "action" : "Start", "nodeUrl" : "devices/Device/PLC Logic/Application" }, "jobResultInfo" : "Application Start is successful" } }, "applicationStopJobRequest" : { "value" : { "jobType" : "ApplicationJob", "jobParameters" : { "action" : "Stop", "nodeUrl" : "devices/Device/PLC Logic/Application" } } }, "applicationStopJobResponse" : { "value" : { "id" : "fb454ad2207d6ce8", "state" : "Done", "progress" : 100, "jobType" : "ApplicationJob", "jobParameters" : { "action" : "Stop", "nodeUrl" : "devices/Device/PLC Logic/Application" }, "jobResultInfo" : "Application Stop is successful" } }, "applicationLogoutJobRequest" : { "value" : { "jobType" : "ApplicationJob", "jobParameters" : { "action" : "Logout", "nodeUrl" : "devices/Device/PLC Logic/Application" } } }, "applicationLogoutJobResponse" : { "value" : { "id" : "fb454ad2207d6ce8", "state" : "Done", "progress" : 100, "jobType" : "ApplicationJob", "jobParameters" : { "action" : "Logout", "nodeUrl" : "devices/Device/PLC Logic/Application" }, "jobResultInfo" : "Application Logout is successful" } }, "buildJobGenerateRuntimeSystemFilesRequest" : { "value" : { "jobType" : "BuildJob", "jobParameters" : { "action" : "GenerateRuntimeSystemFiles", "outputDirectory" : "D:\\C-Integration", "componentName" : "C-Integration", "createM4InterfaceFile" : true, "createCStubFile" : true, "exportLibTypes" : false, "useOriginalTypeNames" : false } } }, "buildJobGenerateRuntimeSystemFilesResponse" : { "value" : { "id" : "a78befc9b631d225", "state" : "Done", "progress" : 100, "jobType" : "BuildJob", "jobParameters" : { "action" : "GenerateRuntimeSystemFiles", "outputDirectory" : "D:\\C-Integration", "componentName" : "C-Integration", "createM4InterfaceFile" : true, "createCStubFile" : true, "exportLibTypes" : false, "useOriginalTypeNames" : false }, "jobResultInfo" : "Generate runtime system files successful." } }, "buildJobGenerateCodeRequest" : { "value" : { "jobType" : "BuildJob", "jobParameters" : { "action" : "GenerateCode" } } }, "buildJobGenerateCodeResponse" : { "value" : { "id" : "28fcdc4e05b4e309", "state" : "Done", "progress" : 100, "jobType" : "BuildJob", "jobParameters" : { "action" : "GenerateCode" }, "jobResultInfo" : "Build complete -- 0 errors, 0 warnings: Ready for download." } }, "deviceUserLoginJobRequest" : { "value" : { "jobType" : "DeviceUserLoginJob", "jobParameters" : { "nodeUrl" : "/devices/Device", "username" : "boschrexroth", "password" : "boschrexroth" } } }, "deviceUserLoginJobResponse" : { "value" : { "id" : "99b92fce667b36e1", "state" : "Done", "progress" : 100, "jobType" : "DeviceUserLoginJob", "jobParameters" : { "nodeUrl" : "/devices/Device", "username" : "boschrexroth", "password" : "boschrexroth" }, "jobResultInfo" : "DeviceUserLoginJob is successful." } }, "deviceUserLogoutJobRequest" : { "value" : { "jobType" : "DeviceUserLogoutJob", "jobParameters" : { "nodeUrl" : "/devices/Device" } } }, "deviceUserLogoutJobResponse" : { "value" : { "id" : "999181b473e75cd6", "state" : "Done", "progress" : 100, "jobType" : "DeviceUserLogoutJob", "jobParameters" : { "nodeUrl" : "/devices/Device" }, "jobResultInfo" : "DeviceUserLogoutJob is successful." } }, "communicationSettingsJobRequest" : { "value" : { "jobType" : "CommunicationSettingsJob", "jobParameters" : { "nodeUrl" : "/devices/Device", "ipAddress" : "10.52.245.95", "httpsPort" : 443, "plcPort" : 11740 } } }, "communicationSettingsJobResponse" : { "value" : { "id" : "8116a6eb4e58c84d", "state" : "Done", "progress" : 100, "jobType" : "CommunicationSettingsJob", "jobParameters" : { "nodeUrl" : "/devices/Device", "ipAddress" : "10.52.245.95", "httpsPort" : 443, "plcPort" : 11740 }, "jobResultInfo" : "CommunicationSettingsJob is successful" } }, "addLibraryCategoriesFromDescFileRequest" : { "value" : { "jobType" : "LibraryCategoriesJob", "jobParameters" : { "action" : "addFromDescriptonFile", "nodeUrl" : "/pous/project-info", "path" : "D:\\Temp\\LibCat.libcat.xml" } } }, "addLibraryCategoriesFromDescFileResponse" : { "value" : { "id" : "f38d6e684749e3c3", "state" : "Pending", "progress" : 0, "jobType" : "LibraryCategoriesJob", "jobParameters" : { "action" : "addFromDescriptonFile" }, "jobResultInfo" : "Library Category is successfully added from description file." } }, "addLibraryCategoriesFromotherLibRequest" : { "value" : { "jobType" : "LibraryCategoriesJob", "jobParameters" : { "action" : "addFromOtherLibrary", "nodeUrl" : "/pous/project-info", "path" : "C:\\ProgramData\\Rexroth\\WRK-V-0120\\0\\Studio\\Managed Libraries\\Bosch Rexroth AG\\CXA_Motion\\1.17.2.1\\CXA_Motion.compiled-library-ge33" } } }, "addLibraryCategoriesFromotherLibResponse" : { "value" : { "id" : "f38d6e684749e3c3", "state" : "Pending", "progress" : 0, "jobType" : "LibraryCategoriesJob", "jobParameters" : { "action" : "addFromOtherLibrary" }, "jobResultInfo" : "Library Category is successfully added from other library." } }, "removeLibraryCategoriesRequest" : { "value" : { "jobType" : "LibraryCategoriesJob", "jobParameters" : { "action" : "Remove", "nodeUrl" : "/pous/project-info", "categories" : [ "Application|ctrlX AUTOMATION|Motion", "Application|ctrlX AUTOMATION|Scripting" ] } } }, "removeLibraryCategoriesResponse" : { "value" : { "id" : "f38d6e684749e3c3", "state" : "Pending", "progress" : 0, "jobType" : "LibraryCategoriesJob", "jobParameters" : { "action" : "Remove" }, "jobResultInfo" : "The selected library category(s) are removed from the existing library categories." } } }, "parameters" : { "path" : { "description" : "This is the path to the element.\n- The char \".\" is not allowed in the name, because it is used in case of ambiguity.\n- If there is an ambiguity between different element names, you can address the element by the option \"name.type\"\n\n Example: A Folder \"TestName\" with the path: `PickingUnit/TestName.Folder` and a POU \"TestName\" with the path: `PickingUnit/TestName.POU`\n", "explode" : false, "in" : "path", "name" : "path", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, "recipeDefinition" : { "description" : "This is the name of a recipe definition element.\n", "explode" : false, "in" : "path", "name" : "recipeDefinition", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, "name" : { "description" : "This is the name of a recipeVariable or a recipe.\n", "explode" : false, "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, "jobId" : { "description" : "job id", "explode" : false, "in" : "path", "name" : "jobId", "required" : true, "schema" : { "example" : "123", "type" : "string" }, "style" : "simple" }, "userName" : { "explode" : false, "in" : "path", "name" : "userName", "required" : true, "schema" : { "example" : "Owner", "type" : "string" }, "style" : "simple" }, "groupName" : { "explode" : false, "in" : "path", "name" : "groupName", "required" : true, "schema" : { "example" : "Everyone", "type" : "string" }, "style" : "simple" } }, "responses" : { "BadRequest" : { "$ref" : "./Common/responses/BadRequest.yaml#/BadRequest" }, "Unauthorized" : { "$ref" : "./Common/responses/Unauthorized.yaml#/Unauthorized" }, "Forbidden" : { "$ref" : "./Common/responses/Forbidden.yaml#/Forbidden" }, "NotFound" : { "$ref" : "./Common/responses/NotFound.yaml#/NotFound" }, "InternalServerError" : { "$ref" : "./Common/responses/InternalServerError.yaml#/InternalServerError" } }, "schemas" : { "Action" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/Action_allOf" } ], "description" : "Implements additional program code." }, "Application" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/Application_allOf" } ], "description" : "Application contains elements for an executable control program. Application elements are available only in **Devices** view.\n" }, "ApplicationBuildOptions" : { "properties" : { "downloadApplicationContent" : { "type" : "boolean" } }, "type" : "object" }, "ApplicationElementProperties" : { "properties" : { "build" : { "$ref" : "#/components/schemas/Build" }, "applicationBuildOptions" : { "$ref" : "#/components/schemas/ApplicationBuildOptions" }, "bootApplication" : { "$ref" : "#/components/schemas/BootApplication" } }, "type" : "object" }, "ApplicationJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/ApplicationJob_allOf" } ], "description" : "- 'Start' command starts the application (status: \"RUN\").\n- 'Stop' command stops the application (status: \"STOP\").\n- 'Logout' command disconnects the application from the target system(controller or simulated device) and returns to offline mode.\n" }, "ApplicationList" : { "example" : { "applications" : [ "Application [Device: PLC Logic]", "Application [Device: PLC Logic]" ] }, "properties" : { "applications" : { "items" : { "example" : "Application [Device: PLC Logic]", "type" : "string" }, "type" : "array" } }, "type" : "object" }, "ApplicationLoginJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/ApplicationLoginJob_allOf" } ], "description" : "The Job connects the application to the target system (PLC to simulated device) and starts the online mode.\n" }, "BaseElement" : { "description" : "BaseElement is an abstraction level with the basic properties. The property **elementType** is mandatory. It is also an unique identification property for Schema.", "discriminator" : { "propertyName" : "elementType" }, "properties" : { "elementType" : { "type" : "string" }, "name" : { "type" : "string" }, "id" : { "description" : "Globally Unique Identifier (GUID) of an element. Top level 'Devices' & 'POUs' return null.", "readOnly" : true, "type" : "string" }, "children" : { "description" : "The array children contains each name of the child-elements.\n\nIf there are elements with identical names, the elementType will be added to the name. \nFor Example:\n- \"mygvl\"\n- \"test.Folder\"\n- \"test.POU\"\n", "items" : { "type" : "string" }, "readOnly" : true, "type" : "array" } }, "required" : [ "elementType" ], "type" : "object" }, "BootApplication" : { "properties" : { "updateBootProjectAfterDownload" : { "type" : "boolean" }, "updateBootProjectAfterOnlineChange" : { "type" : "boolean" }, "remindBootApplicationOnClose" : { "type" : "boolean" }, "verifyBootApplicationAfterCreation" : { "type" : "boolean" } }, "type" : "object" }, "Build" : { "properties" : { "excludeFromBuild" : { "type" : "boolean" }, "external" : { "type" : "boolean" }, "enableSystemCall" : { "type" : "boolean" }, "linkAlways" : { "type" : "boolean" }, "compilerDefines" : { "type" : "string" } }, "type" : "object" }, "BuildJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/BuildJob_allOf" } ], "description" : "- 'GenerateRuntimeSystemFiles' this command generates a C stub file and an M4 interface file from the current library project. These files are used as the basis for creating an external library file.\n- 'GenerateCodeJob' is used to build the active application. The application code is generated with the detailed information about the memory allocation.\n" }, "ChannelInfo" : { "properties" : { "id" : { "description" : "Unique identifier for the variable. When provided in a PUT request, it takes precedence for updates. Recommended for updating variables.", "example" : "33554434", "type" : "string" }, "sectionName" : { "example" : "16#1A81 IO-Link DeviceState Inputs", "type" : "string" }, "variable" : { "example" : "Application.PLC_PRG.idx", "type" : "string" }, "address" : { "example" : "%IW0", "type" : "string" }, "automatic" : { "type" : "boolean" }, "channelName" : { "example" : "AT.Power_supply_status_word", "type" : "string" }, "baseType" : { "example" : "WORD", "type" : "string" }, "ioType" : { "enum" : [ "Input", "Output" ], "type" : "string" }, "description" : { "example" : "output byte 0/Localbus Error_Code", "type" : "string" }, "subChannels" : { "description" : "Array of ChannelInfo", "items" : { "$ref" : "#/components/schemas/ChannelInfo" }, "type" : "array" } }, "type" : "object" }, "CompileOptionsEditor" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "type" : "object" } ], "description" : "CompileOptionsEditor is used for configuring the compile options. This is the global settings, which can be configured from node 'ProjectSettings'. 'Compile options' is added by default when a project is created and it cannot be deleted or added again. It's name in PLC Engineering is language dependent.", "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "fixCompilerVersion" : { "description" : "Compiler version that PLC Engineering uses when compiling and downloading for compile.", "example" : "3.5.6.0 for version 3.5 SP6", "type" : "string" }, "settings" : { "$ref" : "#/components/schemas/CompileOptionsSettings" }, "maxCompilerWarnings" : { "example" : " or 50", "type" : "string" } } }, "CompileOptionsSettings" : { "properties" : { "allowUniCodeIdentifiers" : { "description" : "When true, checkbox 'Allow unicode character for identifier' will be checked.", "example" : true, "type" : "boolean" }, "replaceConstants" : { "description" : "When true, checkbox 'Replace constants' will be checked.", "example" : true, "type" : "boolean" }, "enableBreakpointLogging" : { "description" : "When true, checkbox 'EnableLoggingInBreakpoint' will be checked.", "example" : true, "type" : "boolean" } }, "type" : "object" }, "CommunicationSettingsJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/CommunicationSettingsJob_allOf" } ], "description" : "The job connects PLC Engineering to the device where the application should run.\n" }, "CyclicTransmission" : { "properties" : { "enable" : { "description" : "When true, checkbox 'Enable' will be checked.", "example" : true, "type" : "boolean" }, "interval" : { "description" : "PLC Engineering sends the variables within the defined interval.", "example" : "T#50ms", "type" : "string" } }, "type" : "object" }, "DeclarationsJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/DeclarationsJob_allOf" } ], "description" : "- Declarations Job is used for executing command 'AddAllInstancePaths' on PersistentVars object. \n", "type" : "object" }, "Device" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/Device_allOf" } ], "description" : "Device is the toplevel element below project element. \n\nDevice can be either:\n- ctrlX CORE\n- ctrlX COREvirtual\n- ctrlX CORE I/O Configuration\n" }, "DeviceFilePath" : { "description" : "path to the device file .\n", "example" : { "path" : "D:\\Ethercat_DeviceDescriptions\\Rexroth\\S20-EC-BK_013.xml" }, "properties" : { "path" : { "example" : "D:\\Ethercat_DeviceDescriptions\\Rexroth\\S20-EC-BK_013.xml", "type" : "string" } }, "type" : "object" }, "DeviceInfo" : { "description" : "- General information that originates from the device description file\n- These information are shown in the tab 'Information' of the device editor\n", "properties" : { "name" : { "example" : "ctrlX CORE", "type" : "string" }, "vendor" : { "example" : "Bosch Rexroth AG", "type" : "string" }, "deviceType" : { "example" : 4096, "type" : "integer" }, "id" : { "example" : "1001 0080", "type" : "string" }, "version" : { "description" : "If version information is not given, newest version is selected automatically.", "example" : "1.8.0.0", "type" : "string" }, "orderNumber" : { "example" : "dependent on customer specific configuration", "type" : "string" }, "description" : { "example" : "ctrlX CORE Inputs: 8192 Outputs: 8192 Markers: 8192 Remanent memory: default 64KB configurable to 128KB", "type" : "string" } }, "required" : [ "deviceType", "id" ], "type" : "object" }, "DeviceList" : { "description" : "a list of installed devices", "example" : { "installedDevices" : [ { "deviceType" : 68, "additionalFiles" : [ { "path" : "C:\\ProgramData\\Rexroth\\ctrlX WORKS\\1\\Studio\\Devices\\64\\1001 0101\\1.2.0.0\\BoschRexroth_ControlX_EtherCAT_Master_Diag-1.2.0.0.xml", "key" : "Common.File.XML.NativeDescription" }, { "path" : "C:\\ProgramData\\Rexroth\\ctrlX WORKS\\1\\Studio\\Devices\\64\\1001 0101\\1.2.0.0\\BoschRexroth_ControlX_EtherCAT_Master_Diag-1.2.0.0.xml", "key" : "Common.File.XML.NativeDescription" } ], "vendor" : "Bosch Rexroth AG", "name" : "IndraDrive MPC08 (1 CCD Master +5 CCD Slaves)", "description" : "description", "categories" : [ "65", "65" ], "id" : "24_00000100__242C04", "version" : "Revision=16#00000004" }, { "deviceType" : 68, "additionalFiles" : [ { "path" : "C:\\ProgramData\\Rexroth\\ctrlX WORKS\\1\\Studio\\Devices\\64\\1001 0101\\1.2.0.0\\BoschRexroth_ControlX_EtherCAT_Master_Diag-1.2.0.0.xml", "key" : "Common.File.XML.NativeDescription" }, { "path" : "C:\\ProgramData\\Rexroth\\ctrlX WORKS\\1\\Studio\\Devices\\64\\1001 0101\\1.2.0.0\\BoschRexroth_ControlX_EtherCAT_Master_Diag-1.2.0.0.xml", "key" : "Common.File.XML.NativeDescription" } ], "vendor" : "Bosch Rexroth AG", "name" : "IndraDrive MPC08 (1 CCD Master +5 CCD Slaves)", "description" : "description", "categories" : [ "65", "65" ], "id" : "24_00000100__242C04", "version" : "Revision=16#00000004" } ], "repositoryName" : "repositoryName" }, "properties" : { "repositoryName" : { "type" : "string" }, "installedDevices" : { "items" : { "$ref" : "#/components/schemas/InstalledDeviceBasics" }, "type" : "array" } }, "type" : "object" }, "DevicePatchElements" : { "oneOf" : [ { "$ref" : "#/components/schemas/LibraryParameter" }, { "$ref" : "#/components/schemas/DisableDevice" } ] }, "DevicePatchResponseElements" : { "oneOf" : [ { "$ref" : "#/components/schemas/Library" }, { "$ref" : "#/components/schemas/Device" } ] }, "DeviceRepositoryJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/DeviceRepositoryJob_allOf" } ], "description" : "Saves the current devices in the device cache. Use after adding or removing many devices.", "type" : "object" }, "DeviceRepositoryList" : { "example" : { "repositories" : [ "System Repository", "System Repository" ] }, "properties" : { "repositories" : { "items" : { "example" : "System Repository", "type" : "string" }, "type" : "array" } }, "type" : "object" }, "DeviceUserLoginJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/DeviceUserLoginJob_allOf" } ], "description" : "The job logins the user to the device.\n" }, "DeviceUserLogoutJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/DeviceUserLogoutJob_allOf" } ], "description" : "The job logout the device user.\n" }, "DevicesElements" : { "oneOf" : [ { "$ref" : "#/components/schemas/Device" }, { "$ref" : "#/components/schemas/Application" }, { "$ref" : "#/components/schemas/Action" }, { "$ref" : "#/components/schemas/DUT" }, { "$ref" : "#/components/schemas/Folder" }, { "$ref" : "#/components/schemas/GVL" }, { "$ref" : "#/components/schemas/PLCLogic" }, { "$ref" : "#/components/schemas/POU" }, { "$ref" : "#/components/schemas/POUMethod" }, { "$ref" : "#/components/schemas/POUProperty" }, { "$ref" : "#/components/schemas/POUPropertyGet" }, { "$ref" : "#/components/schemas/POUPropertySet" }, { "$ref" : "#/components/schemas/LibraryManager" }, { "$ref" : "#/components/schemas/RecipeManager" }, { "$ref" : "#/components/schemas/RecipeDefinition" }, { "$ref" : "#/components/schemas/TaskConfig" }, { "$ref" : "#/components/schemas/Task" }, { "$ref" : "#/components/schemas/SymbolConfig" }, { "$ref" : "#/components/schemas/PersistentVars" }, { "$ref" : "#/components/schemas/NVLReceiver" }, { "$ref" : "#/components/schemas/Interface" }, { "$ref" : "#/components/schemas/InterfaceMethod" }, { "$ref" : "#/components/schemas/InterfaceProperty" }, { "$ref" : "#/components/schemas/InterfacePropertyGet" }, { "$ref" : "#/components/schemas/InterfacePropertySet" } ] }, "DevicesTopLevel" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" } ], "description" : "Top level **Devices** view in PLC Engineering." }, "DevicesRootElements" : { "oneOf" : [ { "$ref" : "#/components/schemas/Device" }, { "$ref" : "#/components/schemas/Folder" } ] }, "DisableDevice" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/DisableDevice_allOf" } ], "description" : "Disable or Enable the device. If set to **true**, device will be disabled. Should be used with **PATCH** request only." }, "DUT" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/DUT_allOf" } ], "description" : "Data unit type" }, "Ecad" : { "properties" : { "id" : { "description" : "Resource identifier of an ECAD system.", "example" : "BK_12$&_example_name", "type" : "string" } }, "type" : "object" }, "ElementProperties" : { "properties" : { "build" : { "$ref" : "#/components/schemas/Build" }, "ecad" : { "$ref" : "#/components/schemas/Ecad" } }, "type" : "object" }, "ExportJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/ExportJob_allOf" } ], "description" : "The job 'ExportJob' is used to export the specified node and its children if any to '.export' file format.\n" }, "ExportPlcOpenXmlJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/ExportPlcOpenXmlJob_allOf" } ], "description" : "The job 'ExportPlcOpenXmlJob' is used to export the specified node and its children if any to standard 'PLCopen XML' file.\n" }, "ExportUsersAndGroupsJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/ExportUsersAndGroupsJob_allOf" } ], "description" : "The job 'ExportUsersAndGroupsJob' is used to export users and groups definitions of the project in a file *.users xml format.\n" }, "FindElementsJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/FindElementsJob_allOf" } ], "description" : "- The job 'FindElementsJob' is used to search for all the occurence of an element starting from a node including the corresponding subnodes. Search will be based on 'findText' or 'findId'.\n- If both findText and findId are given, then it searches for the node which matches both id and text.\n" }, "Folder" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/Folder_allOf" } ], "description" : "Folders are structural elements. The char \".\" is not allowed in the name, although it would be possible in ctrlX PLC Engineering." }, "FolderProperties" : { "properties" : { "build" : { "$ref" : "#/components/schemas/Build" }, "documentation" : { "description" : "Represent 'Documentation' tab in the folder properties dialog.", "type" : "string" } }, "type" : "object" }, "FunctionBlockInfo" : { "example" : { "memoryReserveSize" : 1, "size" : 0, "numInstances" : 6, "additionalMemorySizeAllInstances" : 5, "functionBlock" : "functionBlock", "remainingMemoryReserveSize" : 5 }, "properties" : { "functionBlock" : { "description" : "name of the function block", "type" : "string" }, "size" : { "type" : "integer" }, "numInstances" : { "type" : "integer" }, "memoryReserveSize" : { "type" : "integer" }, "additionalMemorySizeAllInstances" : { "type" : "integer" }, "remainingMemoryReserveSize" : { "type" : "integer" } }, "type" : "object" }, "Group" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/Group_allOf" } ], "description" : "Displays the groups and their members." }, "GroupBasicInfo" : { "properties" : { "name" : { "example" : "Everyone", "type" : "string" }, "description" : { "type" : "string" }, "members" : { "description" : "Members of the group.", "items" : { "example" : "user 'Owner'", "type" : "string" }, "type" : "array" } }, "type" : "object" }, "GVL" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/GVL_allOf" } ], "description" : "Global variable list. This can also be used as NVL(Sender) if it is configured under Devices view." }, "InstalledDeviceBasics" : { "example" : { "deviceType" : 68, "additionalFiles" : [ { "path" : "C:\\ProgramData\\Rexroth\\ctrlX WORKS\\1\\Studio\\Devices\\64\\1001 0101\\1.2.0.0\\BoschRexroth_ControlX_EtherCAT_Master_Diag-1.2.0.0.xml", "key" : "Common.File.XML.NativeDescription" }, { "path" : "C:\\ProgramData\\Rexroth\\ctrlX WORKS\\1\\Studio\\Devices\\64\\1001 0101\\1.2.0.0\\BoschRexroth_ControlX_EtherCAT_Master_Diag-1.2.0.0.xml", "key" : "Common.File.XML.NativeDescription" } ], "vendor" : "Bosch Rexroth AG", "name" : "IndraDrive MPC08 (1 CCD Master +5 CCD Slaves)", "description" : "description", "categories" : [ "65", "65" ], "id" : "24_00000100__242C04", "version" : "Revision=16#00000004" }, "properties" : { "name" : { "description" : "name of the installed device .", "example" : "IndraDrive MPC08 (1 CCD Master +5 CCD Slaves)", "readOnly" : true, "type" : "string" }, "version" : { "description" : "version of the installed device .", "example" : "Revision=16#00000004", "readOnly" : true, "type" : "string" }, "vendor" : { "description" : "vendor of the device .", "example" : "Bosch Rexroth AG", "readOnly" : true, "type" : "string" }, "description" : { "description" : "description of the device .", "readOnly" : true, "type" : "string" }, "categories" : { "items" : { "example" : "65", "type" : "string" }, "type" : "array" }, "deviceType" : { "example" : 68, "type" : "integer" }, "id" : { "example" : "24_00000100__242C04", "type" : "string" }, "additionalFiles" : { "items" : { "$ref" : "#/components/schemas/InstalledDeviceBasics_additionalFiles" }, "type" : "array" } }, "required" : [ "additionalFiles", "categories", "description", "deviceType", "id", "name", "vendor", "version" ], "type" : "object" }, "Interface" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/Interface_allOf" } ], "description" : "Implements Interface. Here you write source code." }, "InterfaceMethod" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/InterfaceMethod_allOf" } ], "description" : "Extension of Interface for a series of statements." }, "InterfaceProperty" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/InterfaceProperty_allOf" } ], "description" : "Extension of Interface for external access to data." }, "InterfacePropertyGet" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/InterfacePropertyGet_allOf" } ], "description" : "Extension of InterfaceProperty." }, "InterfacePropertySet" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/InterfacePropertySet_allOf" } ], "description" : "Extension of InterfaceProperty." }, "ImportFieldbusConfigJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/ImportFieldbusConfigJob_allOf" } ], "description" : "The job 'ImportFieldbusConfig' is used to import all configured devices of the 'busType' from the control.\nThere is no possibility to merge with existing elements.\n" }, "ImportOfflineFieldbusConfigJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/ImportOfflineFieldbusConfigJob_allOf" } ], "description" : "The job 'ImportOfflineFieldbusConfigJob' is used to import all configured devices of the 'busType' from the file.\nThere is no possibility to merge with existing elements.\n" }, "ImportJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/ImportJob_allOf" } ], "description" : "The job 'ImportJob' is used to import the given file of type '.export' on the specified node. Import conflict will be resolved by renaming the new object.\n" }, "ImportPlcOpenXmlJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/ImportPlcOpenXmlJob_allOf" } ], "description" : "The job 'ImportPlcOpenXmlJob' is used to import the given file of standard 'PLCopen XML' on the specified node. Already existing objects will be overwritten.\n" }, "ImportUsersAndGroupsJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/ImportUsersAndGroupsJob_allOf" } ], "description" : "The job 'ImportUsersAndGroupsJob' is used to import the users and groups definiitions, stored in the file , into the project.\n" }, "Job" : { "discriminator" : { "propertyName" : "jobType" }, "example" : { "jobResultInfo" : "jobResultInfo", "progress" : 10, "id" : "123", "state" : "Running", "jobType" : "jobType" }, "properties" : { "jobType" : { "description" : "one of available jobTypes (e.g. ApplicationJob, ApplicationLoginJob, BuildJob, CommunicationSettingsJob, DeclarationsJob, DeviceRepositoryJob, DeviceUserLoginJob, DeviceUserLogoutJob, EplanJob, ExportJob, ExportPlcOpenXmlJob, ExportUsersAndGroupsJob, FindElementsJob, ImportJob, ImportOfflineFieldbusConfigJob, ImportPlcOpenXmlJob, ImportUsersAndGroupsJob, LibraryCategoriesJob, MoveElementsJob, NewProjectJob, OpenEditorJob, PreCompileJob, ProjectJob, PublishMarkedMethodsJob, PubSubJob, ResetApplicationJob, UserManagementLogInJob, UserManagementLogOutJob, ImportFieldbusConfigJob )", "type" : "string" }, "id" : { "description" : "Id of a job", "example" : "123", "readOnly" : true, "type" : "string" }, "state" : { "enum" : [ "Pending", "Failed", "Done", "Running" ], "example" : "Running", "readOnly" : true, "type" : "string" }, "progress" : { "description" : "Progress of the task in percent", "example" : 10, "maximum" : 100, "minimum" : 0, "readOnly" : true, "type" : "integer" }, "jobResultInfo" : { "type" : "string" } }, "required" : [ "jobType" ], "type" : "object" }, "JobList" : { "example" : { "jobs" : [ { "jobResultInfo" : "jobResultInfo", "progress" : 10, "id" : "123", "state" : "Running", "jobType" : "jobType" }, { "jobResultInfo" : "jobResultInfo", "progress" : 10, "id" : "123", "state" : "Running", "jobType" : "jobType" } ] }, "properties" : { "jobs" : { "description" : "a list of jobs", "items" : { "$ref" : "#/components/schemas/Job" }, "type" : "array" } }, "type" : "object" }, "Jobs" : { "oneOf" : [ { "$ref" : "#/components/schemas/ApplicationJob" }, { "$ref" : "#/components/schemas/ApplicationLoginJob" }, { "$ref" : "#/components/schemas/BuildJob" }, { "$ref" : "#/components/schemas/CommunicationSettingsJob" }, { "$ref" : "#/components/schemas/DeclarationsJob" }, { "$ref" : "#/components/schemas/DeviceRepositoryJob" }, { "$ref" : "#/components/schemas/DeviceUserLoginJob" }, { "$ref" : "#/components/schemas/DeviceUserLogoutJob" }, { "$ref" : "#/components/schemas/EplanJob" }, { "$ref" : "#/components/schemas/ExportJob" }, { "$ref" : "#/components/schemas/ExportPlcOpenXmlJob" }, { "$ref" : "#/components/schemas/ExportUsersAndGroupsJob" }, { "$ref" : "#/components/schemas/FindElementsJob" }, { "$ref" : "#/components/schemas/ImportFieldbusConfigJob" }, { "$ref" : "#/components/schemas/ImportJob" }, { "$ref" : "#/components/schemas/ImportOfflineFieldbusConfigJob" }, { "$ref" : "#/components/schemas/ImportPlcOpenXmlJob" }, { "$ref" : "#/components/schemas/ImportUsersAndGroupsJob" }, { "$ref" : "#/components/schemas/LibraryCategoriesJob" }, { "$ref" : "#/components/schemas/MoveElementsJob" }, { "$ref" : "#/components/schemas/NewProjectJob" }, { "$ref" : "#/components/schemas/OpenEditorJob" }, { "$ref" : "#/components/schemas/PreCompileJob" }, { "$ref" : "#/components/schemas/ProjectJob" }, { "$ref" : "#/components/schemas/PublishMarkedMethodsJob" }, { "$ref" : "#/components/schemas/PubSubJob" }, { "$ref" : "#/components/schemas/ResetApplicationJob" }, { "$ref" : "#/components/schemas/UserManagementLogInJob" }, { "$ref" : "#/components/schemas/UserManagementLogOutJob" } ] }, "Language" : { "description" : "Possible programming languages for PLCs:\n- FBD (Function Block Diagram)\n- ST (Structured Text)\n- CFC (Continuous Function Chart)\n- SFC (Sequential Function Chart)\n- IL (Instruction List)\n- LD (Ladder Diagram)\n", "enum" : [ "FBD", "ST", "CFC", "SFC", "IL", "LD" ], "type" : "string" }, "Library" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/Library_allOf" } ], "description" : "Library element\n- \"elementType\"=\"Library\"\n" }, "LibraryBasics" : { "example" : { "name" : "Standard", "placeholderName" : "placeholderName", "company" : "System", "version" : "3.5.15.0" }, "properties" : { "name" : { "description" : "name of the library", "example" : "Standard", "readOnly" : true, "type" : "string" }, "version" : { "description" : "version of the library", "example" : "3.5.15.0", "readOnly" : true, "type" : "string" }, "company" : { "description" : "company of the library", "example" : "System", "readOnly" : true, "type" : "string" }, "placeholderName" : { "description" : "placeholder name of the library", "readOnly" : true, "type" : "string" } }, "required" : [ "company", "name", "placeholderName", "version" ], "type" : "object" }, "LibraryCategoriesJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/LibraryCategoriesJob_allOf" } ], "description" : "- 'addFromDescriptonFile' command adds library categories from Description file.\n- 'addFromOtherLibrary' command adds library categories from other libraries.\n- 'Remove' command removes the specified library from the exsiting library categories.\n", "type" : "object" }, "LibraryList" : { "description" : "a list of libraries", "example" : { "installedLibraries" : [ { "name" : "Standard", "placeholderName" : "placeholderName", "company" : "System", "version" : "3.5.15.0" }, { "name" : "Standard", "placeholderName" : "placeholderName", "company" : "System", "version" : "3.5.15.0" } ], "repositoryName" : "repositoryName" }, "properties" : { "repositoryName" : { "type" : "string" }, "installedLibraries" : { "items" : { "$ref" : "#/components/schemas/LibraryBasics" }, "type" : "array" } }, "type" : "object" }, "LibraryManager" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/LibraryManager_allOf" } ], "description" : "LibraryManager contains a set of libraries. Element with fixed name \"library-manager\". It's name in PLC Engineering is shown language dependent." }, "LibraryParameter" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/LibraryParameter_allOf" } ], "description" : "Used to edit the library parameter list of the library project." }, "LibraryParameterBaseElement" : { "properties" : { "name" : { "description" : "Name of the element", "example" : "testParameter", "type" : "string" }, "value" : { "description" : "Value of the element", "example" : "5", "type" : "string" } }, "type" : "object" }, "ListItem" : { "description" : "General information of elements.", "example" : { "name" : "name", "elementType" : "elementType", "url" : "url" }, "properties" : { "name" : { "type" : "string" }, "elementType" : { "type" : "string" }, "url" : { "type" : "string" } }, "readOnly" : true, "type" : "object" }, "LogoutAfterInactivity" : { "properties" : { "checked" : { "type" : "boolean" }, "value" : { "description" : "Value must be between 1 to 180.", "type" : "integer" } }, "type" : "object" }, "MaximumAuthenticationTrials" : { "properties" : { "checked" : { "type" : "boolean" }, "value" : { "description" : "Value must be between 1 to 10.", "type" : "integer" } }, "type" : "object" }, "MoveElementsJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/MoveElementsJob_allOf" } ], "description" : "The job 'MoveElementsJob' is used to shift the element from one node to another including all the submodules.\n" }, "NetworkSettings" : { "properties" : { "task" : { "description" : "Task of the current application that controls the variables to be received.", "example" : "MainTask", "type" : "string" }, "sender" : { "description" : "Available sender NVLs of another device in the project.", "example" : "NVL [ctrlX_COREvirtual: PLC Logic: Application]", "type" : "string" }, "importFromFile" : { "description" : "File name in GVL export file *.gvl format", "example" : "C:\\Users\\temp\\nvl.gvl", "type" : "string" } }, "type" : "object" }, "NetworkVariables" : { "description" : "GVL added under POUs does not have NetworkVariables property. but default value of this property will be displayed.", "properties" : { "networkType" : { "description" : "Type of the network.", "example" : "UDP", "type" : "string" }, "task" : { "description" : "Task of the current application that controls the variables to be sent.", "example" : "MainTask", "type" : "string" }, "listIdentifier" : { "description" : "Used to identify the network variable list. Must be unique.", "example" : "1", "type" : "string" }, "packVariables" : { "type" : "boolean" }, "transmitChecksum" : { "type" : "boolean" }, "acknowledgement" : { "type" : "boolean" }, "cyclicTransmission" : { "$ref" : "#/components/schemas/CyclicTransmission" }, "transmitOnChange" : { "$ref" : "#/components/schemas/TransmitOnChange" }, "transmitOnEvent" : { "$ref" : "#/components/schemas/TransmitOnEvent" }, "settings" : { "$ref" : "#/components/schemas/Settings" } }, "type" : "object" }, "NewProjectJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/NewProjectJob_allOf" } ], "description" : "The job 'NewProjectJob' is used to create a new project.\n" }, "NVLReceiver" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/NVLReceiver_allOf" } ], "description" : "Network variable list (Receiver)." }, "NVLSenderParameters" : { "description" : "- Parameter name can be Port and Broadcast Adr.\n- If the parameters are not set default value will be taken. \n- Default value for port is 1202.\n- Default value for Broadcast Adr. is 255.255.255.255.\n- If the settings is not enabled then parameters cannot be updated.\n", "properties" : { "name" : { "enum" : [ "Port", "Broadcast Adr." ], "example" : "Port.", "type" : "string" }, "value" : { "example" : "1202", "type" : "string" } } }, "OnlineChangeMemoryReserve" : { "description" : "Memory reserve for the function blocks can be configured during the online change", "example" : { "numberOfFunctionBlocks" : 2, "functionBlockCategories" : [ "5 bytes", "5 bytes" ], "functionBlocks" : [ { "memoryReserveSize" : 1, "size" : 0, "numInstances" : 6, "additionalMemorySizeAllInstances" : 5, "functionBlock" : "functionBlock", "remainingMemoryReserveSize" : 5 }, { "memoryReserveSize" : 1, "size" : 0, "numInstances" : 6, "additionalMemorySizeAllInstances" : 5, "functionBlock" : "functionBlock", "remainingMemoryReserveSize" : 5 } ], "additionalMemoryUsedByAllInstances" : 0 }, "properties" : { "numberOfFunctionBlocks" : { "example" : 2, "readOnly" : true, "type" : "integer" }, "additionalMemoryUsedByAllInstances" : { "example" : 0, "readOnly" : true, "type" : "integer" }, "functionBlockCategories" : { "items" : { "example" : "5 bytes", "type" : "string" }, "readOnly" : true, "type" : "array" }, "functionBlocks" : { "items" : { "$ref" : "#/components/schemas/FunctionBlockInfo" }, "type" : "array" } }, "type" : "object" }, "Path" : { "description" : "For example path to a library file or path to save a project.\n", "example" : { "path" : "C:\\User\\Libraries\\MyLibrary.complied-library or C:\\User\\ABC_Test.project" }, "properties" : { "path" : { "example" : "C:\\User\\Libraries\\MyLibrary.complied-library or C:\\User\\ABC_Test.project", "type" : "string" } }, "type" : "object" }, "PersistentVars" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/PersistentVars_allOf" } ], "description" : "Persistent Vars object that can be added below application node. Only one 'PersistentVars' object is allowed below application node." }, "PLCLogic" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/PLCLogic_allOf" } ], "description" : "PLCLogic is automatically created on adding a plc device. Structural element with fixed name \"Plc Logic\". Its name in PLC Engineering is shown language dependent." }, "PLCSettings" : { "description" : "In **PLC Settings** tab, you make the basic settings for the configuration of the PLC. For example, handling of inputs and outputs and the bus cycle task.\nAfter any changes to **PLC Settings**, login is no longer possible without download.\n", "properties" : { "applicationForIOHandling" : { "description" : "Application that is responsible for the I/O handling. Before you select ``, you should be aware that `` means no application is defined for I/O handling.", "example" : "Application", "type" : "string" }, "updateIOWhileInStop" : { "description" : "PLC Engineering refreshes the values of the input and output channels even if the PLC is in the stop state. If the watchdog detects a malfunction, the outputs are set to the predefined default values.", "example" : true, "type" : "boolean" }, "behaviorFoOutputsInStop" : { "description" : "Handling of the output channels when the controller enters the stop state:\n- KeepCurrentValues: The current values are retained.\n- SetToDefault: The default values resulting from the I/O mapping are assigned.\n- ExecuteProgram: You can control the handling of the output values via a program contained in the project, which PLC Engineering executes at \"STOP\". Enter the name of the program in the property `stopResetBehaviourUserProgram`.\n", "enum" : [ "KeepCurrentValues", "SetToDefault", "ExecuteProgram" ], "type" : "string" }, "stopResetBehaviourUserProgram" : { "description" : "Name of the program that needs to be executed. Use this property only if 'behaviorFoOutputsInStop' is set to 'ExecuteProgram'.", "example" : "POU", "type" : "string" }, "alwaysUpdateVariables" : { "description" : "Global setting that defines whether or not PLC Engineering updates the I/O variables in the bus cycle task. This setting is effective for I/O variables of the slaves and modules only if 'deactivated' is defined in their update settings.\n- Disabled (update only if used in a task): PLC Engineering updates the I/O variables only if they are used in a task.\n- Enabled 1 (use bus cycle task if not used in any task): PLC Engineering updates the I/O variables in the bus cycle task if they are not used in any other task.\n- Enabled 2 (always in bus cycle task): PLC Engineering updates all variables in each cycle of the bus cycle task, regardless of whether they are used and whether they are mapped to an input or output channel.\n", "enum" : [ "Disabled (update only if used in a task)", "Enabled 1 (use bus cycle task if not used in any task)", "Enabled 2 (always in bus cycle task)" ], "type" : "string" }, "busCycleTask" : { "description" : "Task that controls the bus cycle. By default the task defined by the device description is entered.\nBefore you select the `` setting for the bus cycle task, you should be aware that `` means that the default setting given in the device description goes into effects. You should therefore check this description. Use of the task with the shortest cycle time may be defined as the default there, but use of the task with the longest cycle time could equally well be defined!\nFor fieldbuses, a fixed cycle matrix is necessary to assure a determined behavior. Therefore, do not use the type 'free-running' for a bus cycle task.\n", "example" : "Task", "type" : "string" }, "showIOWarningsAsErrors" : { "description" : "Warnings concerning the I/O configuration are displayed as errors.", "example" : false, "type" : "boolean" }, "enableDiagnosisForDevices" : { "description" : "PLC Engineering automatically integrates the library CAA Device Diagnosis in the project and creates an implicit function block for each device. If there is already a function block for the device, then either an extended FB is used (for example with EtherCAT) or a further FB instance is added. This then contains a general implementation of the device diagnostics.\nBy means of the FB instances you can determine the status of all devices in the application and evaluate errors. In addition, the library contains functions for the programmatic editing of the device tree. Example: Scanning of all children of a bus system, jumping to the parent element.\n", "example" : false, "type" : "boolean" }, "generateForceVariablesForIOMapping" : { "description" : "This setting is available only if it is supported by the device. When compiling the application PLC Engineering creates two global variables for each I/O channel that is mapped to a variable in the dialog I/O Mapping. You can use these variables for the forcing of the input or output value on this channel, for example via an HMI visualization.", "example" : false, "type" : "boolean" } }, "type" : "object" }, "POU" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/POU_allOf" } ], "description" : "Program organization unit. Here you write source code." }, "POUMethod" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/POUMethod_allOf" } ], "description" : "Extension of POU for a series of statements." }, "POUProperty" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/POUProperty_allOf" } ], "description" : "Extension of POU for external access to data." }, "POUPropertyGet" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/POUPropertyGet_allOf" } ], "description" : "Extension of POUProperty." }, "POUPropertySet" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/POUPropertySet_allOf" } ], "description" : "Extension of POUProperty." }, "PousElements" : { "oneOf" : [ { "$ref" : "#/components/schemas/DUT" }, { "$ref" : "#/components/schemas/Folder" }, { "$ref" : "#/components/schemas/GVL" }, { "$ref" : "#/components/schemas/POU" }, { "$ref" : "#/components/schemas/Interface" }, { "$ref" : "#/components/schemas/LibraryManager" }, { "$ref" : "#/components/schemas/ProjectInfo" }, { "$ref" : "#/components/schemas/ProjectSettings" }, { "$ref" : "#/components/schemas/Action" }, { "$ref" : "#/components/schemas/POUMethod" }, { "$ref" : "#/components/schemas/POUProperty" }, { "$ref" : "#/components/schemas/POUPropertyGet" }, { "$ref" : "#/components/schemas/POUPropertySet" }, { "$ref" : "#/components/schemas/InterfaceMethod" }, { "$ref" : "#/components/schemas/InterfaceProperty" }, { "$ref" : "#/components/schemas/InterfacePropertyGet" }, { "$ref" : "#/components/schemas/InterfacePropertySet" }, { "$ref" : "#/components/schemas/SfcEditor" }, { "$ref" : "#/components/schemas/CompileOptionsEditor" }, { "$ref" : "#/components/schemas/UsersAndGroupsEditor" } ] }, "PousRootElements" : { "oneOf" : [ { "$ref" : "#/components/schemas/DUT" }, { "$ref" : "#/components/schemas/Folder" }, { "$ref" : "#/components/schemas/GVL" }, { "$ref" : "#/components/schemas/POU" }, { "$ref" : "#/components/schemas/Interface" }, { "$ref" : "#/components/schemas/LibraryManager" }, { "$ref" : "#/components/schemas/ProjectInfo" }, { "$ref" : "#/components/schemas/ProjectSettings" } ] }, "PousTopLevel" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" } ], "description" : "Top level **POUs** view in PLC Engineering." }, "OpenEditorJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/OpenEditorJob_allOf" } ], "description" : "The job 'OpenEditorJob' is used to open or view editor window. If editor is already opened but hidden then it will focus the editor.\n" }, "EplanJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/EplanJob_allOf" } ], "description" : "The job 'EplanJob' is used to create and import project as well as update ethercat parameter in the project from .aml files.\n" }, "PreCompileJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/PreCompileJob_allOf" } ], "description" : "- 'Disable' this suppresses the delivery of the language model during complex tasks (ex: import, export, install library...) and thus the precompile is not started. **CAUTION!** after complex task is done or in case of exception, PreCompileJob should be enabled again before performing other tasks.\n- 'Enable' precompile will be enabled again.\n", "type" : "object" }, "Product" : { "description" : "information regarding product", "example" : { "versionText" : "WRK-V-RC" }, "properties" : { "versionText" : { "example" : "WRK-V-RC", "type" : "string" } }, "type" : "object" }, "Project" : { "description" : "Includes everything for the production of a control program.", "example" : { "profileName" : "ctrlX Plc 0.0.3", "path" : "C:\\User\\Admin\\PLCProjects\\", "lastModifiedTime" : "2019-11-11T11:37:03.2873026+01:00", "lastAccessTime" : "2019-11-11T11:37:03.2952358+01:00", "creationTime" : "2019-10-29T09:32:36.1187391+01:00", "name" : "ABC_Test.project", "compilerVersion" : "3.5.15.0", "visualisationProfile" : "ctrlXPlcVisu0.0.3", "elementList" : [ { "name" : "name", "elementType" : "elementType", "url" : "url" }, { "name" : "name", "elementType" : "elementType", "url" : "url" } ] }, "properties" : { "name" : { "example" : "ABC_Test.project", "type" : "string" }, "path" : { "example" : "C:\\User\\Admin\\PLCProjects\\", "type" : "string" }, "creationTime" : { "example" : "2019-10-29T09:32:36.1187391+01:00", "type" : "string" }, "lastModifiedTime" : { "example" : "2019-11-11T11:37:03.2873026+01:00", "type" : "string" }, "lastAccessTime" : { "example" : "2019-11-11T11:37:03.2952358+01:00", "type" : "string" }, "profileName" : { "example" : "ctrlX Plc 0.0.3", "type" : "string" }, "compilerVersion" : { "example" : "3.5.15.0", "type" : "string" }, "visualisationProfile" : { "example" : "ctrlXPlcVisu0.0.3", "type" : "string" }, "elementList" : { "items" : { "$ref" : "#/components/schemas/ListItem" }, "readOnly" : true, "type" : "array" } }, "type" : "object" }, "ProjectInfo" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/ProjectInfo_allOf" } ], "description" : "Project Information object is required for the creation of the Lib\nElement with fixed name. Its name in PLC Engineering is shown language dependent.\n" }, "ProjectInfoproperties" : { "properties" : { "author" : { "description" : "Author of the Lib.", "example" : "_DEFAULT_Bosch Rexroth AG", "type" : "string" }, "company" : { "description" : "Company of the Lib", "example" : "_DEFAULT_Bosch Rexroth AG", "type" : "string" }, "compiledLibraryCompatibilityVersion" : { "description" : "PLC Engineering version for which the currently open library project is compatible.", "example" : "ctrlX PLC 1.3.0", "type" : "string" }, "defaultNamespace" : { "description" : "Default namespace of the Lib.", "example" : "_DEFAULT_namespace", "type" : "string" }, "description" : { "description" : "Description of the Lib.", "example" : "Brief description of the Lib (max. 80 characters)", "type" : "string" }, "docFormat" : { "description" : "Doc format of the Lib.", "example" : "reStructuredText", "type" : "string" }, "libDocContent" : { "description" : "Lib doc content of the Lib", "example" : "CommentsAndDocs", "type" : "string" }, "libraryCategories" : { "description" : "List of Library Categories", "example" : [ "Application|ctrlX AUTOMATION|Motion" ], "items" : { "type" : "string" }, "type" : "array" }, "placeholder" : { "description" : "Placeholder for the Lib", "example" : "ADAPT_THIS_PLACEHOLDER_VALUE_OR_REMOVE_THE_KEY_COMPLETELY", "type" : "string" }, "project" : { "description" : "Name of the Lib project.", "example" : "ApiTest", "type" : "string" }, "released" : { "description" : "Released flag for the Lib.", "example" : false, "type" : "boolean" }, "title" : { "description" : "Title of the Lib.", "example" : "_DEFAULT_CXA_Library_Template", "type" : "string" }, "version" : { "description" : "Version of the Lib.", "example" : "0.1.0.0", "type" : "string" }, "generateLibInfo" : { "description" : "Flag to Automatically generate 'Library Information' POUs.", "example" : false, "type" : "boolean" }, "generateProjInfo" : { "description" : "Flag to Automatically generate 'Project Information' POUs.", "example" : false, "type" : "boolean" } } }, "ProjectJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/ProjectJob_allOf" } ], "description" : "- 'Open' open project as current project\n- 'Close' close current project without saving. Project files wiill be deleted, on close of new project that has not been saved.\n- 'Save' save the current project. If a 'path' is contained, 'save as' is performed\n- 'SaveAndInstallIntoLibraryRepository' save the current library project and install into library repository\n- 'SaveAsCompiledLibrary' save the current library project in encrypted form\n", "type" : "object" }, "ProjectSettings" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/ProjectSettings_allOf" } ], "description" : "ProjectSettings contains a set of options to configure project.\nElement with fixed name. It's name in PLC Engineering is language dependent. Node 'Project Settings' is added by default when a project is created. This node cannot be deleted or added again.\n" }, "PublishMarkedMethodsJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/PublishMarkedMethodsJob_allOf" } ], "description" : "The job 'PublishMarkedMethodsJob' is used to publish all methods marked with the attribute 'CxRpcEnable'." }, "PubSubJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/PubSubJob_allOf" } ], "description" : "- Publisher Subscriber Job is supported only for 'GVL'.\n- As a prerequisite, 'SetAsPublisher' action requires a 'Publisher' data layer node and 'SetAsSubscriber' action requires a 'Subscriber' data layer node.\n", "type" : "object" }, "Recipe" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/Recipe_allOf" } ], "description" : "Recipe type", "required" : [ "name" ], "type" : "object" }, "RecipeBaseElement" : { "properties" : { "name" : { "description" : "Name of the element", "example" : "myTestName", "type" : "string" }, "value" : { "description" : "Value of the element", "example" : "5", "type" : "string" } }, "type" : "object" }, "RecipeDefinition" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/PLCLogic_allOf" } ], "description" : "RecipeDefinition type" }, "RecipeList" : { "items" : { "$ref" : "#/components/schemas/Recipe" }, "type" : "array" }, "RecipeManager" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/RecipeManager_allOf" } ], "description" : "RecipeManager contains and manages information about recipe definition child elements. Element with fixed name \"recipe-manager\". It's name in PLC Engineering is shown language dependent." }, "RecipeVariable" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/RecipeVariable_allOf" } ], "description" : "RecipeVariable type", "required" : [ "name" ], "type" : "object" }, "RecipeVariableList" : { "items" : { "$ref" : "#/components/schemas/RecipeVariable" }, "type" : "array" }, "RepositoryList" : { "example" : { "repositories" : [ "System", "System" ] }, "properties" : { "repositories" : { "items" : { "example" : "System", "type" : "string" }, "type" : "array" } }, "type" : "object" }, "ResetApplicationJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/ResetApplicationJob_allOf" } ], "description" : "- 'ResetOrigin' command resets the device to its factory settings.\n- 'ResetCold' command results in a cold start of the active application on the controller.\n- 'ResetWarm' command results in a warm start of the active application on the controller.\n", "type" : "object" }, "Settings" : { "description" : "- Protocol-specific settings. Possible entries depend on the network library.\n", "properties" : { "enable" : { "description" : "If the network type is selected value will be set to true.", "readOnly" : true, "type" : "boolean" }, "parameters" : { "items" : { "$ref" : "#/components/schemas/NVLSenderParameters" }, "type" : "array" } }, "type" : "object" }, "SfcBuild" : { "properties" : { "calcActiveTransOnly" : { "description" : "If set to true, Calculate active transitions only checkbox will be checked", "example" : true, "type" : "boolean" } }, "type" : "object" }, "SfcEditor" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/SfcEditor_allOf" } ], "description" : "SfcEditor contains **flags** and **build** options to configure SFC settings. This is the global settings, which can be configured from node 'ProjectSettings'.\nElement with fixed name. It's name in PLC Engineering is language dependent.\n" }, "SfcFlags" : { "properties" : { "name" : { "description" : "Name of the flag", "example" : "SFCEnableLimit", "type" : "string" }, "use" : { "description" : "If set to true, use checkbox of the flag will be checked", "example" : true, "type" : "boolean" }, "declare" : { "description" : "If set to true, declare checkbox of the flag will be checked", "example" : true, "type" : "boolean" } }, "required" : [ "declare", "name", "use" ], "type" : "object" }, "Symbol" : { "properties" : { "libraryNamespace" : { "description" : "Parameter 'libraryNamespace' will diaplay value only for Library symbols. Value may have be hierarchical, in this case each value will be seperated by '/'.", "example" : "IecVarAccessLibrary/SymbolicVarsBase/Stu", "type" : "string" }, "name" : { "description" : "Column name 'Symbols' in the 'Symbol Configuration' editor.", "example" : "Constants", "type" : "string" }, "isSelected" : { "description" : "Column 'Checkbox' in the 'Symbol Configuration' editor.", "example" : true, "type" : "boolean" }, "variables" : { "description" : "Array of 'SymbolVariable'.", "items" : { "$ref" : "#/components/schemas/SymbolVariable" }, "type" : "array" } }, "type" : "object" }, "SymbolConfig" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/SymbolConfig_allOf" } ], "description" : "Symbol Configuration object is required for the configuration of Symbols. Element with fixed name. It's name in PLC Engineering is shown language dependent. Only one 'Symbol Configuration' object is allowed below application node." }, "SymbolVariable" : { "description" : "These Symbols are available in 'Symbol Configuration' editor.", "properties" : { "name" : { "description" : "Column name 'Symbols' in the 'Symbol Configuration' editor.", "example" : "RuntimeVersion", "type" : "string" }, "accessRights" : { "description" : "Column name 'Access Rights' in the 'Symbol Configuration' editor.", "example" : "Void", "type" : "string" }, "maximalAccess" : { "description" : "Column name 'Maximal' in the 'Symbol Configuration' editor.", "example" : "Read", "type" : "string" }, "attribute" : { "description" : "Column name 'Attribute' in the 'Symbol Configuration' editor.", "example" : "Void", "type" : "string" }, "type" : { "description" : "Column name 'Type' in the 'Symbol Configuration' editor.", "example" : "VERSION", "type" : "string" }, "fullQualifiedBaseType" : { "description" : "If null then it's not a structure type, else this structure type will be available in 'types' array.", "example" : "CXAC_Base.FB_CXACi", "type" : "string" }, "comment" : { "description" : "Column name 'Comment' in the 'Symbol Configuration' editor.", "example" : "the runtime version number as defined by the device description.", "type" : "string" }, "variableType" : { "description" : "For local variables this parameter must be 'Var', In case of an executable method this parameter must be 'Method'.", "example" : "Var", "type" : "string" }, "isSelected" : { "description" : "Column 'Checkbox' in the 'Symbol Configuration' editor.", "example" : true, "type" : "boolean" } }, "type" : "object" }, "Task" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/Task_allOf" } ], "description" : "Task element, which can be added below 'Task Configuration'." }, "TaskConfig" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/TaskConfig_allOf" } ], "description" : "Task Configuration object is required for the configuration of Tasks. Element with fixed name. It's name in PLC Engineering is shown language dependent. Only one 'Task Configuration' object is allowed below application node. By default a 'Task' and a 'TaskGroup' will be added when a new Task Configuration object is created." }, "TaskConfigGroup" : { "description" : "Represent 'Task Groups' in Task Configuration", "properties" : { "groupName" : { "description" : "Name of the task group", "example" : "IEC-Tasks1", "type" : "string" }, "core" : { "description" : "- Fixed Pinned (-2)\n- Sequentially Pinned (-1)\n- 0\n- 1\n- 2\n- 3\n", "example" : -2, "type" : "integer" } }, "type" : "object" }, "TaskPouCall" : { "description" : "- If any entry exists, pous will be added\n- In the below example 'pou1' & 'pou2' will be added \n```json\n\"pouCalls\": [\n {\n \"name\": \"pou1\",\n \"comment\": \"xyz\" \n },\n {\n \"name\": \"pou2\",\n \"comment\": \"xyz\" \n }\n]\n```\n- If an empty array is passed, all the added pous below 'Task' will be removed\n```json\n \"pouCalls\": []\n", "properties" : { "name" : { "description" : "Name of the pou", "example" : "PLC_PRG", "type" : "string" }, "comment" : { "description" : "Comment", "example" : "1st POU", "type" : "string" } }, "type" : "object" }, "TaskType" : { "properties" : { "name" : { "description" : "Name of the task type", "example" : "external", "type" : "string" }, "value" : { "description" : "Value of the task type. For task name Freewheeling, value will be empty(\"\")", "example" : "TASK_EXTERNAL_EVENT_01", "type" : "string" } }, "type" : "object" }, "TaskWatchdog" : { "properties" : { "enable" : { "description" : "When true, checkbox 'Enable' will be checked", "example" : true, "type" : "boolean" }, "time" : { "description" : "Watchdog time", "example" : "200 or t#200ms", "type" : "string" }, "sensitivity" : { "description" : "Watchdog sensitivity", "example" : "5", "type" : "string" } }, "type" : "object" }, "TransmitOnChange" : { "properties" : { "enable" : { "description" : "When true, checkbox 'Enable' will be checked.", "example" : true, "type" : "boolean" }, "minimumGap" : { "description" : "Least amount of time between two transmissions.", "example" : "T#20ms", "type" : "string" } }, "type" : "object" }, "TransmitOnEvent" : { "properties" : { "enable" : { "description" : "When true, checkbox 'Enable' will be checked.", "example" : true, "type" : "boolean" }, "variable" : { "description" : "PLC Engineering sends the variables as soon as the defined variable yields TRUE.", "type" : "string" } }, "type" : "object" }, "User" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "type" : "object" } ], "description" : "Displays the users and their memberships in groups", "example" : { "password" : "password", "oldPassword" : "oldPassword", "fullName" : "fullName", "description" : "description", "active" : true, "confirmPassword" : "confirmPassword", "memberships" : [ "Everyone", "Everyone" ] }, "properties" : { "fullName" : { "type" : "string" }, "description" : { "type" : "string" }, "active" : { "example" : true, "type" : "boolean" }, "oldPassword" : { "type" : "string" }, "password" : { "type" : "string" }, "confirmPassword" : { "type" : "string" }, "memberships" : { "description" : "List of all user groups that you have defined in addition to the group Everyone (to which each new user automatically belongs).", "items" : { "example" : "Everyone", "type" : "string" }, "type" : "array" } } }, "UserBasicInfo" : { "properties" : { "name" : { "description" : "Name of the user.", "example" : "Owner", "type" : "string" }, "fullName" : { "type" : "string" }, "description" : { "type" : "string" }, "active" : { "example" : true, "type" : "boolean" }, "memberships" : { "description" : "List of all user groups that you have defined in addition to the group Everyone (to which each new user automatically belongs).", "items" : { "example" : "Everyone", "type" : "string" }, "type" : "array" } }, "type" : "object" }, "UserManagementLogInJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "$ref" : "#/components/schemas/UserManagementLogInJob_allOf" } ], "description" : "The job 'UserManagementLogInJob' is used to log in defined user for the opened project. User cannot login if 'logoutAfterTimeOfInactivity' is True. So internally while performing the login, it will be set to false. \n" }, "UserManagementLogOutJob" : { "allOf" : [ { "$ref" : "#/components/schemas/Job" }, { "type" : "object" } ], "description" : "The job 'UserManagementLogOutJob' is used to logout from the current project.\n" }, "UsersAndGroupsEditor" : { "allOf" : [ { "$ref" : "#/components/schemas/BaseElement" }, { "$ref" : "#/components/schemas/UsersAndGroupsEditor_allOf" } ], "description" : "This editor is for the configuration of the user management for the current project. This is the global settings, which can be configured from node 'ProjectSettings'.\nElement with fixed name. It's name in PLC Engineering is language dependent.\n" }, "UsersAndGroupsSettings" : { "properties" : { "maximumAuthenticationTrials" : { "$ref" : "#/components/schemas/MaximumAuthenticationTrials" }, "logoutAfterTimeOfInactivity" : { "$ref" : "#/components/schemas/LogoutAfterInactivity" }, "enableHashFormatPassword" : { "type" : "boolean" } }, "type" : "object" }, "Problem" : { "description" : "This document defines a \"problem detail\" as a way to carry machine-readable details of errors in a HTTP response to avoid the need to define new error response formats for HTTP APIs.\n", "properties" : { "type" : { "default" : "about:blank", "description" : "A URI reference [RFC3986] that identifies the problem type. \nThis specification encourages that, when dereferenced, \nit provide human-readable documentation for the problem type \n(e.g., using HTML [W3C.REC-html5-20141028]). When this member \nis not present, its value is assumed to be \"about:blank\".\n", "example" : "https://example.com/probs/out-of-credit", "format" : "uri", "type" : "string" }, "title" : { "description" : "A short, human-readable summary of the problem type. \nIt SHOULD NOT change from occurrence to occurrence of the problem, \nexcept for purposes of localization (e.g., using proactive content \nnegotiation; see [RFC7231], Section 3.4).\nIf the response is a diagnostics message, it contains \nthe text associated with the mainDiagnosisCode.\n", "example" : "You do not have enough credit.", "type" : "string" }, "status" : { "description" : "The HTTP status code ([RFC7231], Section 6) generated by the \norigin server for this occurrence of the problem.\n", "example" : 403, "format" : "int32", "type" : "integer" }, "detail" : { "description" : "A human-readable explanation specific to this occurrence of the problem.\nIf the response is a diagnostics message, it contains the text associated with\nthe detailedDiagnosisCode.\n", "example" : "Your current balance is 30, but that costs 50.", "type" : "string" }, "instance" : { "description" : "A URI reference that identifies the specific occurrence of the problem.\nIt may or may not yield further information if dereferenced.\n", "example" : "/account/12345/msgs/abc", "type" : "string" }, "code" : { "deprecated" : true, "description" : "An error code issued by the system that caused the original problem.\nThis code can be used to track down the root cause of the error.\n", "example" : "F360001", "type" : "string" }, "mainDiagnosisCode" : { "description" : "The main diagnosis code is issued by the system that caused the problem.\nThis code can be used to track down the root cause and source of the error.\nIt can be used to search in the documentation for a solution.\nIt SHOULD NOT change from occurrence to occurrence of the same problem.\n", "example" : "080F0100", "type" : "string" }, "detailedDiagnosisCode" : { "description" : "The detailed diagnosis code issued by the system that caused the problem.\nThis code can be used to track down the detailed cause and source of the error.\nIt can be used to search in the documentation for a solution.\nThe detailed diagnosis code gives additional information about the cause of the error.\nIt SHOULD NOT change from occurrence to occurrence of the same problem.\n", "example" : "00666001", "type" : "string" }, "dynamicDescription" : { "description" : "A dynamic description gives detailed information about the occurrence of a problem.\nIt can change between different occurrences of the same error.\n", "example" : "value = -4.5", "type" : "string" }, "severity" : { "description" : " Severity of a problem as defined RFC5424 of the Syslog standard, see https://tools.ietf.org/html/rfc5424", "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Informational", "Debug" ], "example" : "Error", "type" : "string" }, "links" : { "description" : "Collection of links to fix the problem. E.g. links to online user manual,\nto an online community (using tags) or a developer chat (e.g. Slack).\n", "items" : { "example" : "https://stackoverflow.com/questions/tagged/boschrexroth+controlx+f360001", "format" : "uri", "type" : "string" }, "type" : "array" }, "moreInfo" : { "additionalProperties" : true, "description" : "The moreInfo field allows you to add additional information that might be necessary to debug or trace down the cause of an error.\nIt might also contain information what is needed to resolve the problem.\nThere are loosely specified fields for specific problems that can be used in these situations, e.g.:\n- On a 403 Forbidden error: The moreInfo can contain a field \"requiredPermissions\" with the required permissions seperated by comma\n- On a 402 Payment required: The moreInfo can contain a field \"requiredLicenses\" with the required licenses seperated by comma\n", "example" : { "trace" : "ExampleClass.cpp#452 Null pointer exception", "class" : "ExampleClass" }, "type" : "object" }, "cause" : { "description" : "Sometimes a problem might be caused by problems that occure in other components or are the root cause of a problem. In this\ncase the related problems can be added as a cause. Since it might be possible that multiple components have problems on a single\naction, cause is an array. E.g. Loading failed because several components where not able to load the configuration.\n", "items" : { "$ref" : "#/components/schemas/Problem" }, "type" : "array" } }, "required" : [ "title", "type" ], "type" : "object", "x-version" : "1.0.0" }, "Action_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "language" : { "$ref" : "#/components/schemas/Language" }, "implementation" : { "type" : "string" } } }, "Application_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ApplicationElementProperties" }, "isOnline" : { "description" : "isOnline will be **true**, if the application is loggedin. Otherwise it will be **false**.", "example" : true, "readOnly" : true, "type" : "boolean" }, "active" : { "description" : "active application state.", "example" : true, "type" : "boolean" } } }, "ApplicationJob_allOf_jobParameters" : { "properties" : { "nodeUrl" : { "description" : "Path of the application which has to start/stop/logout. If not specified active application will be considered.", "example" : "devices/Device/PLC Logic/Application", "type" : "string" }, "action" : { "enum" : [ "Start", "Stop", "Logout" ], "example" : "Start", "type" : "string" } } }, "ApplicationJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/ApplicationJob_allOf_jobParameters" } } }, "ApplicationLoginJob_allOf_jobParameters" : { "properties" : { "nodeUrl" : { "description" : "Path of the application which has to be loggedIn. If not specified active application will be loggedIn.", "example" : "/devices/Device/PLC Logic/Application", "type" : "string" }, "loginOption" : { "description" : "If the application exists in the PLC, but if it has been changed since the last download. User will be prompted with a dialog with options( i.e. Login with online change, Login with download, Login without any change)\nUser can select one of the options using this property. By default Login with online change will be selected.\n", "enum" : [ "LoginWithOnlineChange", "LoginWithDownload", "LoginWithoutAnyChange" ], "example" : "LoginWithOnlineChange", "type" : "string" }, "updateBootApplication" : { "description" : "Update the boot application on the PLC. Default value of the property is true.\n", "example" : true, "type" : "boolean" } } }, "ApplicationLoginJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/ApplicationLoginJob_allOf_jobParameters" } } }, "BuildJob_allOf_jobParameters" : { "properties" : { "action" : { "enum" : [ "GenerateRuntimeSystemFiles", "GenerateCodeJob" ], "example" : "GenerateRuntimeSystemFiles", "type" : "string" }, "outputDirectory" : { "description" : "Directory where PLC Engineering creates the runtime system files.", "example" : "D:\\C-Integration", "type" : "string" }, "componentName" : { "description" : "Name of the library project.", "example" : "C-Integration", "type" : "string" }, "createM4InterfaceFile" : { "description" : "Interface file `componentNameItf.m4` with definitions.", "example" : true, "type" : "boolean" }, "createCStubFile" : { "description" : "Stub file for reprogramming the library in C.", "example" : false, "type" : "boolean" }, "exportLibTypes" : { "description" : "The referenced types are included in the export.", "example" : false, "type" : "boolean" }, "useOriginalTypeNames" : { "description" : "The type names of the library project are used.", "example" : false, "type" : "boolean" } } }, "BuildJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/BuildJob_allOf_jobParameters" } } }, "CommunicationSettingsJob_allOf_jobParameters" : { "properties" : { "nodeUrl" : { "description" : "ctrlX device node for which job needs to be executed.", "example" : "/devices/Device", "type" : "string" }, "ipAddress" : { "description" : "IpAddress of the controller.", "example" : "127.0.0.1", "type" : "string" }, "httpsPort" : { "description" : "Optional parameter. If not provided considers the default or previously set value.", "example" : 8443, "type" : "integer" }, "plcPort" : { "description" : "Optional paramter. If not provided considers the default or previously set value.", "example" : 8740, "type" : "integer" } } }, "CommunicationSettingsJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/CommunicationSettingsJob_allOf_jobParameters" } } }, "DeclarationsJob_allOf_jobParameters" : { "properties" : { "nodeUrl" : { "description" : "path to PersistentVars object.", "example" : "/devices/device/PLC Logic/Application/PersistentVars", "type" : "string" }, "action" : { "example" : "AddAllInstancePaths", "type" : "string" } } }, "DeclarationsJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/DeclarationsJob_allOf_jobParameters" } } }, "Device_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "isOnline" : { "description" : "isOnline will be **true**, if the device is online. Otherwise it will be **false**.", "example" : true, "readOnly" : true, "type" : "boolean" }, "plcSettings" : { "$ref" : "#/components/schemas/PLCSettings" }, "disable" : { "description" : "Disable or Enable the device. If set to **true**, device will be disabled. Should be used with **PATCH** request only.", "example" : true, "type" : "boolean" }, "ioHierarchy" : { "description" : "Format of 'DataLayer_Realtime' nodes. If set to **true**, datalayer realtime nodes will be displayed in 'Hierarchy'. Should be used with **PATCH** request only.", "example" : true, "type" : "boolean" }, "deviceInfo" : { "$ref" : "#/components/schemas/DeviceInfo" }, "ioMapping" : { "items" : { "$ref" : "#/components/schemas/ChannelInfo" }, "type" : "array" } } }, "DeviceRepositoryJob_allOf_jobParameters" : { "properties" : { "action" : { "example" : "SaveDevice", "type" : "string" } } }, "DeviceRepositoryJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/DeviceRepositoryJob_allOf_jobParameters" } } }, "DeviceUserLoginJob_allOf_jobParameters" : { "properties" : { "nodeUrl" : { "description" : "ctrlX device node for which job needs to be executed.", "example" : "/devices/Device", "type" : "string" }, "username" : { "example" : "boschrexroth", "type" : "string" }, "password" : { "example" : "boschrexroth", "type" : "string" } } }, "DeviceUserLoginJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/DeviceUserLoginJob_allOf_jobParameters" } } }, "DeviceUserLogoutJob_allOf_jobParameters" : { "properties" : { "nodeUrl" : { "description" : "ctrlX device node for which job needs to be executed.", "example" : "/devices/Device", "type" : "string" } } }, "DeviceUserLogoutJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/DeviceUserLogoutJob_allOf_jobParameters" } } }, "DisableDevice_allOf" : { "properties" : { "disable" : { "example" : true, "type" : "boolean" } } }, "DUT_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "declaration" : { "type" : "string" }, "textlistsupport" : { "type" : "boolean" } } }, "ExportJob_allOf_jobParameters" : { "properties" : { "nodeUrl" : { "description" : "node and its child nodes which needs to be exported", "example" : "/devices/device/PLC Logic/Application", "type" : "string" }, "filePath" : { "description" : "path where export file needs to be saved", "example" : "X:\\ctrlX\\Projects\\ImportExport", "type" : "string" }, "fileName" : { "description" : "name of the file (with or without extension). If property 'oneFilePerSubtree' is true, file name is ignored", "example" : "Application or Application.export", "type" : "string" }, "oneFilePerSubtree" : { "description" : "if true, one file per subtree is generated", "example" : false, "type" : "boolean" }, "includeSubNodes" : { "description" : "if false, sub elements will be excluded.", "example" : true, "type" : "boolean" } } }, "ExportJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/ExportJob_allOf_jobParameters" } } }, "ExportPlcOpenXmlJob_allOf_jobParameters" : { "properties" : { "nodeUrl" : { "description" : "node which needs to be exported", "example" : "/devices/device/PLC Logic/Application/POU_SFC", "type" : "string" }, "filePath" : { "description" : "path where xml file needs to be saved", "example" : "X:\\ctrlX\\PLCProjects\\PLCOpenExport", "type" : "string" }, "fileName" : { "description" : "name of the file (with or without extension).", "example" : "POU_SFC or POU_SFC.xml", "type" : "string" } } }, "ExportPlcOpenXmlJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/ExportPlcOpenXmlJob_allOf_jobParameters" } } }, "ExportUsersAndGroupsJob_allOf_jobParameters" : { "properties" : { "filePath" : { "description" : "path where *.users xml file needs to be saved", "example" : "X:\\ctrlX\\PLCProjects", "type" : "string" }, "fileName" : { "description" : "name of the file (with or without extension).", "example" : "usersAndGroups or usersAndGroups.users", "type" : "string" } } }, "ExportUsersAndGroupsJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/ExportUsersAndGroupsJob_allOf_jobParameters" } } }, "FindElementsJob_allOf_jobParameters" : { "properties" : { "nodeUrl" : { "description" : "Path of the node from where the search has to begin.", "example" : "/devices/Device/PLC Logic/Application", "type" : "string" }, "findText" : { "description" : "Text to be searched.", "example" : "folder", "type" : "string" }, "findId" : { "description" : "Id to be searched.", "example" : "be0458db-09f5-43c7-8bbf-0347b8f11765", "type" : "string" }, "matchCase" : { "description" : "Finds all occurrences with the exact combination of uppercase and lowercase letters specified in the findText. Default value is false.", "example" : true, "type" : "boolean" }, "matchWholeWord" : { "description" : "Searches for the complete word. Default value is false.", "example" : true, "type" : "boolean" }, "searchOptions" : { "description" : "Specifies the search range.", "enum" : [ "NodeAndSubNodes" ], "type" : "string" }, "matchedNodeUrls" : { "description" : "Lists the path of all the nodes, which matches the findId and findText.", "example" : [ "devices/Device/PLC Logic/Application/folder1" ], "items" : { "type" : "string" }, "readOnly" : true, "type" : "array" } } }, "FindElementsJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/FindElementsJob_allOf_jobParameters" } } }, "Folder_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/FolderProperties" } } }, "Group_allOf" : { "properties" : { "description" : { "type" : "string" }, "members" : { "description" : "Members of the group. A group can also be a member of a group. Member name is preceded with 'user' or 'group' to identify which category it belongs to.", "items" : { "example" : "user 'Owner'", "type" : "string" }, "type" : "array" } } }, "GVL_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "declaration" : { "type" : "string" }, "networkVariables" : { "$ref" : "#/components/schemas/NetworkVariables" } } }, "InstalledDeviceBasics_additionalFiles" : { "example" : { "path" : "C:\\ProgramData\\Rexroth\\ctrlX WORKS\\1\\Studio\\Devices\\64\\1001 0101\\1.2.0.0\\BoschRexroth_ControlX_EtherCAT_Master_Diag-1.2.0.0.xml", "key" : "Common.File.XML.NativeDescription" }, "properties" : { "key" : { "example" : "Common.File.XML.NativeDescription", "type" : "string" }, "path" : { "example" : "C:\\ProgramData\\Rexroth\\ctrlX WORKS\\1\\Studio\\Devices\\64\\1001 0101\\1.2.0.0\\BoschRexroth_ControlX_EtherCAT_Master_Diag-1.2.0.0.xml", "type" : "string" } } }, "Interface_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "declaration" : { "type" : "string" }, "displayName" : { "type" : "string" } } }, "InterfaceMethod_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "declaration" : { "example" : "METHOD METH\\nVAR_INPUT\\nEND_VAR\\n", "type" : "string" }, "displayName" : { "type" : "string" }, "implementation" : { "type" : "string" } } }, "InterfaceProperty_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "declaration" : { "example" : "PROPERTY Prop_1 : BOOL\n", "type" : "string" }, "displayName" : { "type" : "string" } } }, "InterfacePropertyGet_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "declaration" : { "example" : "VAR\\ni:INT;\\nEND_VAR", "type" : "string" }, "implementation" : { "type" : "string" } } }, "InterfacePropertySet_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "declaration" : { "example" : "VAR\\n i:INT;\\nEND_VAR", "type" : "string" }, "implementation" : { "type" : "string" } } }, "ImportFieldbusConfigJob_allOf_jobParameters" : { "properties" : { "nodeUrl" : { "example" : "/devices/device/Realtime_Data", "type" : "string" }, "username" : { "description" : "used for authentification on the control", "example" : "username", "type" : "string" }, "password" : { "description" : "used for authentification on the control", "example" : "password", "type" : "string" }, "busType" : { "enum" : [ "ethercat" ], "type" : "string" }, "forceInsert" : { "default" : false, "description" : "If 'true' existing elements are deleted before found elements are imported. If 'false' Job is not started when elements exist and request returns with error.", "type" : "boolean" } } }, "ImportFieldbusConfigJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/ImportFieldbusConfigJob_allOf_jobParameters" } } }, "ImportOfflineFieldbusConfigJob_allOf_jobParameters" : { "properties" : { "nodeUrl" : { "example" : "/devices/device/Realtime_Data", "type" : "string" }, "filePath" : { "description" : "path where xml file exists", "example" : "X:\\ctrlX\\PLCProjects\\PLCOpenExport", "type" : "string" }, "fileName" : { "description" : "name of the file.", "example" : "Ethercat.xml", "type" : "string" }, "busType" : { "enum" : [ "ethercat" ], "type" : "string" }, "forceInsert" : { "default" : false, "description" : "If 'true' existing elements are deleted before found elements are imported. If 'false' Job is not started when elements exist and request returns with error.", "type" : "boolean" }, "keepExisting" : { "default" : false, "description" : "Optional parameter. If forceInsert is true then the value is ignored. If KeepExisting is true, the existing elements are kept and only new elements are imported from the file. If it is false, the job will fail if elements are already present and the request will return an error.", "type" : "boolean" } } }, "ImportOfflineFieldbusConfigJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/ImportOfflineFieldbusConfigJob_allOf_jobParameters" } } }, "ImportJob_allOf_jobParameters" : { "properties" : { "nodeUrl" : { "description" : "node on which '.export' file needs to be imported", "example" : "/devices/device/PLC Logic", "type" : "string" }, "filePath" : { "description" : "path where '.export' file exists", "example" : "X:\\ctrlX\\Projects\\ExportImport", "type" : "string" }, "fileName" : { "description" : "name of the file (with or without extension) that needs to be imported.", "example" : "Application or Application.export", "type" : "string" } } }, "ImportJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/ImportJob_allOf_jobParameters" } } }, "ImportPlcOpenXmlJob_allOf_jobParameters" : { "properties" : { "nodeUrl" : { "description" : "node on which xml file needs to be imported", "example" : "/devices/device/PLC Logic/Application", "type" : "string" }, "filePath" : { "description" : "path where xml file exists", "example" : "X:\\ctrlX\\PLCProjects\\PLCOpenExport", "type" : "string" }, "fileName" : { "description" : "name of the file (with or without extension) that needs to be imported.", "example" : "POU_SFC or POU_SFC.xml", "type" : "string" } } }, "ImportPlcOpenXmlJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/ImportPlcOpenXmlJob_allOf_jobParameters" } } }, "ImportUsersAndGroupsJob_allOf_jobParameters" : { "properties" : { "filePath" : { "description" : "path where xml file exists", "example" : "X:\\ctrlX\\PLCProjects", "type" : "string" }, "fileName" : { "description" : "name of the file (with or without extension .users) that needs to be imported.", "example" : "usersAndGroups or usersAndGroups.users", "type" : "string" } } }, "ImportUsersAndGroupsJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/ImportUsersAndGroupsJob_allOf_jobParameters" } } }, "Library_allOf" : { "properties" : { "version" : { "description" : "version of the library", "example" : "3.5.15.0", "type" : "string" }, "company" : { "description" : "company of the library", "example" : "System", "type" : "string" }, "placeholderName" : { "description" : "placeholder name of the library", "type" : "string" }, "displayName" : { "readOnly" : true, "type" : "string" }, "effectiveVersion" : { "readOnly" : true, "type" : "string" }, "systemLibrary" : { "readOnly" : true, "type" : "boolean" }, "description" : { "readOnly" : true, "type" : "string" }, "resolutionInfo" : { "readOnly" : true, "type" : "string" }, "parameters" : { "description" : "List of all parameter names and corresponding values.", "items" : { "$ref" : "#/components/schemas/LibraryParameterBaseElement" }, "type" : "array" } }, "required" : [ "company", "placeholderName", "version" ] }, "LibraryCategoriesJob_allOf_jobParameters" : { "properties" : { "action" : { "enum" : [ "addFromDescriptonFile", "addFromOtherLibrary", "Remove" ], "type" : "string" } } }, "LibraryCategoriesJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/LibraryCategoriesJob_allOf_jobParameters" } } }, "LibraryManager_allOf" : { "properties" : { "displayName" : { "description" : "Displayed name in the project", "example" : "Library Manager", "readOnly" : true, "type" : "string" }, "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" } } }, "LibraryParameter_allOf" : { "properties" : { "parameters" : { "description" : "List of all parameter names and corresponding values.\n", "items" : { "$ref" : "#/components/schemas/LibraryParameterBaseElement" }, "type" : "array" } } }, "MoveElementsJob_allOf_jobParameters" : { "properties" : { "sourceNodeUrl" : { "description" : "Source location of the node which has to be shifted.", "example" : "devices/device/PLC Logic/Application/Folder1", "type" : "string" }, "destinationNodeUrl" : { "description" : "Destination location to which the node has to be shifted.", "example" : "devices/device/PLC Logic/Application/Folder2", "type" : "string" }, "insertPosition" : { "description" : "- Position where the sourceNode has to be inserted.\n- If not specified default value -1 will be set, which inserts the node at the end.\n- If the nodes are sorted in alphabetical order, then insertion will be based on the node name.\n", "example" : 2, "type" : "integer" } } }, "MoveElementsJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/MoveElementsJob_allOf_jobParameters" } } }, "NewProjectJob_allOf_jobParameters" : { "properties" : { "filePath" : { "description" : "path where the created project need to be saved.", "example" : "D:\\test", "type" : "string" }, "fileName" : { "description" : "name of the project.", "example" : "plcDemo", "type" : "string" }, "template" : { "description" : "Depending on the template, user can obtain a project that is automatically equipped with a certain range of objects.", "enum" : [ "EmptyLibrary", "EmptyProject", "StandardLibrary", "ctrlXOSARM64", "ctrlXOSx64" ], "type" : "string" } } }, "NewProjectJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/NewProjectJob_allOf_jobParameters" } } }, "NVLReceiver_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "declaration" : { "readOnly" : true, "type" : "string" }, "networkSettings" : { "$ref" : "#/components/schemas/NetworkSettings" } } }, "PersistentVars_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "declaration" : { "example" : "{attribute 'qualified_only'}\\nVAR_GLOBAL PERSISTENT RETAIN\\nEND_VAR", "type" : "string" } } }, "PLCLogic_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" } } }, "POU_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "language" : { "$ref" : "#/components/schemas/Language" }, "declaration" : { "type" : "string" }, "implementation" : { "type" : "string" }, "level" : { "default" : "Standard", "enum" : [ "Void", "Basic", "Extended", "System", "Standard" ], "type" : "string" } }, "required" : [ "language" ] }, "POUMethod_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "language" : { "$ref" : "#/components/schemas/Language" }, "declaration" : { "example" : "METHOD POUFBMethod\\nVAR_INPUT\\nEND_VAR\\n", "type" : "string" }, "implementation" : { "type" : "string" } }, "required" : [ "language" ] }, "POUProperty_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "language" : { "$ref" : "#/components/schemas/Language" }, "declaration" : { "example" : "PROPERTY Prop : bool\\n", "type" : "string" } } }, "POUPropertyGet_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "language" : { "$ref" : "#/components/schemas/Language" }, "declaration" : { "example" : "VAR\\ni:INT;\\nEND_VAR", "type" : "string" }, "implementation" : { "type" : "string" } }, "required" : [ "language" ] }, "POUPropertySet_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "language" : { "$ref" : "#/components/schemas/Language" }, "declaration" : { "example" : "VAR\\n i:INT;\\nEND_VAR", "type" : "string" }, "implementation" : { "type" : "string" } }, "required" : [ "language" ] }, "OpenEditorJob_allOf_jobParameters" : { "properties" : { "nodeUrl" : { "description" : "node of the editor which user wants to open or view", "example" : "/devices/Device/PLC Logic/Application/PLC_PRG", "type" : "string" } } }, "OpenEditorJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/OpenEditorJob_allOf_jobParameters" } } }, "EplanJob_allOf_jobParameters" : { "properties" : { "action" : { "enum" : [ "CreateNewProjectViaEplanImport", "ImportEthercatParameterFromEplan", "ImportFromEplan" ], "type" : "string" }, "amlFile" : { "description" : "path to the .aml file.", "example" : "D:\\Eplan\\Plc_ETH_PN_EIP.aml", "type" : "string" }, "projectName" : { "description" : "name of the project to be created when importing .aml file.", "example" : "AmlProjPlc_2.plc.project", "type" : "string" }, "projectLocation" : { "description" : "path of the project where it should be created.", "example" : "D:\\Eplan", "type" : "string" } } }, "EplanJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/EplanJob_allOf_jobParameters" } } }, "PreCompileJob_allOf_jobParameters" : { "properties" : { "action" : { "enum" : [ "Disable", "Enable" ], "type" : "string" } } }, "PreCompileJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/PreCompileJob_allOf_jobParameters" } } }, "ProjectInfo_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "properties" : { "$ref" : "#/components/schemas/ProjectInfoproperties" } } }, "ProjectJob_allOf_jobParameters" : { "properties" : { "action" : { "enum" : [ "Open", "Save", "Close", "SaveAndInstallIntoLibraryRepository", "SaveAsCompiledLibrary" ], "type" : "string" }, "path" : { "example" : "C:\\User\\Libraries\\MyLibrary.complied-library or C:\\User\\ABC_Test.project", "type" : "string" }, "keepProjectVersion" : { "description" : "Default value is false. If false, Project will be converted based on 'projectEnvironment' enum and opened. If true, project will not be opened.", "type" : "boolean" }, "projectEnvironment" : { "default" : "SetAllToNewest", "description" : "Handling of Project Open:\n- SetAllToNewest: All the Project Environment versions for Library, Compiler, Placeholder, Device, Visualization.. will be set to newest.\n- DoNotUpdate: All the Project Environment versions for Library, Compiler, Placeholder, Device, Visualization.. will not be updated. \n", "enum" : [ "SetAllToNewest", "DoNotUpdate" ], "type" : "string" } } }, "ProjectJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/ProjectJob_allOf_jobParameters" } } }, "ProjectSettings_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "displayName" : { "description" : "Displayed name in the project", "example" : "In english 'Project Settings', in German 'Projekteinstellungen'", "readOnly" : true, "type" : "string" } } }, "PublishMarkedMethodsJob_allOf_jobParameters" : { "properties" : { "nodeUrl" : { "example" : "/devices/device/PLC Logic/Application/symbol-config", "type" : "string" } } }, "PublishMarkedMethodsJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/PublishMarkedMethodsJob_allOf_jobParameters" } } }, "PubSubJob_allOf_jobParameters" : { "properties" : { "nodeUrl" : { "description" : "node that needs to be set as 'Publisher' or 'Subscriber'", "example" : "/devices/device/PLC Logic/Application/GVL", "type" : "string" }, "action" : { "enum" : [ "SetAsPublisher", "SetAsSubscriber" ], "type" : "string" } } }, "PubSubJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/PubSubJob_allOf_jobParameters" } } }, "Recipe_allOf" : { "properties" : { "variables" : { "description" : "List of all variablenames and corresponding values.", "items" : { "$ref" : "#/components/schemas/RecipeBaseElement" }, "type" : "array" } } }, "RecipeManager_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "displayName" : { "description" : "Displayed name in the project", "example" : "Recipe Manager", "readOnly" : true, "type" : "string" }, "storageType" : { "default" : "Textual", "enum" : [ "Binary", "Textual" ], "type" : "string" }, "filePath" : { "type" : "string" }, "fileExtension" : { "default" : ".txtrecipe", "type" : "string" }, "separator" : { "default" : "Assignment", "description" : "Tab(\\t), Semicolon(;), Comma(,), Space( ), Assignment(:=) and Pipe(|)", "enum" : [ "Tab", "Semicolon", "Comma", "Space", "Assignment", "Pipe" ], "type" : "string" }, "columnList" : { "description" : "Defines which information is saved in which order in the recipe file. (Variable = \"0\", Value = \"1\", Type = \"2\", Name = \"3\", Comment = \"4\", Min = \"5\", Max = \"6\")\n", "example" : "0|1", "type" : "string" }, "recipeManagementInPlc" : { "default" : true, "description" : "Must be selected for the user program or visualization elements to load recipes in runtime mode.\n", "type" : "boolean" }, "autoSaveRecipe" : { "default" : true, "type" : "boolean" }, "loadType" : { "default" : "ExactVariableList", "enum" : [ "ExactVariableList", "MatchingVariableNames" ], "type" : "string" }, "writeType" : { "default" : "LimitVariablesToMinMax", "enum" : [ "LimitVariablesToMinMax", "DoNotWriteMinMaxToVariables" ], "type" : "string" }, "checkRecipeForChanges" : { "default" : false, "type" : "boolean" } } }, "RecipeVariable_allOf" : { "properties" : { "additionalName" : { "description" : "Additional name of the variable. Caution the \"name\" field in BaseElement is the variable name!", "type" : "string" }, "variableType" : { "description" : "Type of the plc variable is automatically set", "readOnly" : true, "type" : "string" }, "comment" : { "type" : "string" }, "lowerBound" : { "description" : "If current value of the variable is below LowerBound, the value is set to LowerBound", "type" : "string" }, "upperBound" : { "description" : "If current value of the variable is higher UpperBound, the value is set to UpperBound", "type" : "string" }, "recipies" : { "description" : "List of all recipe names and corresponding values.", "items" : { "$ref" : "#/components/schemas/RecipeBaseElement" }, "type" : "array" } } }, "ResetApplicationJob_allOf_jobParameters" : { "properties" : { "action" : { "enum" : [ "ResetOrigin", "ResetCold", "ResetWarm" ], "type" : "string" } } }, "ResetApplicationJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/ResetApplicationJob_allOf_jobParameters" } } }, "SfcEditor_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "flags" : { "items" : { "$ref" : "#/components/schemas/SfcFlags" }, "type" : "array" }, "build" : { "$ref" : "#/components/schemas/SfcBuild" }, "applyToAll" : { "description" : "- If set to true, 'SFC Settings' of all pou object(s) of type 'SFC' will be overwritten.\n- By default, in 'SfcEditor' response, this property will be set to true.\n", "example" : true, "type" : "boolean" } } }, "SymbolConfig_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "displayName" : { "description" : "Displayed name in the project.", "example" : "Symbol Configuration", "readOnly" : true, "type" : "string" }, "includeCommentsInXML" : { "description" : "If set to true, 'Include Comments in XML' checkbox will be checked.", "example" : true, "type" : "boolean" }, "supportOPCUA" : { "description" : "If set to true, 'Support OPC UA Features' checkbox will be checked. This also enables 'Support calls to Functions, FBs, Methods and Programs' and 'Include call information in XML'", "example" : true, "type" : "boolean" }, "optimizedLayout" : { "description" : "If set to true, 'Optimized Layout' will be selected. When set to false 'Compatibility Layout' will be selected.", "example" : true, "type" : "boolean" }, "symbols" : { "description" : "These Symbols are available in 'Symbol Configuration' editor.", "items" : { "$ref" : "#/components/schemas/Symbol" }, "type" : "array" }, "types" : { "description" : "These are the data types referenced in the 'Members' column of 'Symbol Configuration' editor.", "items" : { "$ref" : "#/components/schemas/Symbol" }, "type" : "array" } } }, "Task_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "priority" : { "description" : "Priority value", "example" : "29", "type" : "string" }, "taskGroup" : { "description" : "Task group name", "example" : "IEC-Tasks", "type" : "string" }, "type" : { "$ref" : "#/components/schemas/TaskType" }, "watchdog" : { "$ref" : "#/components/schemas/TaskWatchdog" }, "pouCalls" : { "items" : { "$ref" : "#/components/schemas/TaskPouCall" }, "type" : "array" } } }, "TaskConfig_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "displayName" : { "description" : "Displayed name in the project", "example" : "Task Configuration", "readOnly" : true, "type" : "string" }, "taskGroups" : { "items" : { "$ref" : "#/components/schemas/TaskConfigGroup" }, "type" : "array" } } }, "UserManagementLogInJob_allOf_jobParameters" : { "properties" : { "userName" : { "type" : "string" }, "password" : { "type" : "string" } } }, "UserManagementLogInJob_allOf" : { "properties" : { "jobParameters" : { "$ref" : "#/components/schemas/UserManagementLogInJob_allOf_jobParameters" } } }, "UsersAndGroupsEditor_allOf" : { "properties" : { "elementProperties" : { "$ref" : "#/components/schemas/ElementProperties" }, "users" : { "description" : "Displays the users and their memberships in groups.", "items" : { "$ref" : "#/components/schemas/UserBasicInfo" }, "readOnly" : true, "type" : "array" }, "groups" : { "description" : "Displays the groups and their members. A group can also be a member of a group.", "items" : { "$ref" : "#/components/schemas/GroupBasicInfo" }, "readOnly" : true, "type" : "array" }, "settings" : { "$ref" : "#/components/schemas/UsersAndGroupsSettings" } } } } } }