Rest api descriptions for ctrlX WORKS¶
The ctrlX WORKS engineering platform is designed as an open platform to encourage developers to develop third-party apps and services. As part of this goal we publish all released REST-APIs as OpenAPI description on github. You can use it to generate clients using third-party generators or browse our interactive API documentation.
In the list below, you will find the latest released versions of our apis. The first column contains a link to the interactive API documentation. The link in the second column will open the actual openAPI as json.
| Rest API Description | OpenAPI Specification |
|---|---|
| ctrlX WORKS - Devices API | ctrlx-works.v1.3.0.openapi.json |
| ctrlX WORKS - IO Engineering API | io-engineering.v2.7.0.openapi.json |
| ctrlX WORKS - PLC Engineering API | plc-engineering.v2.7.0.openapi.json |
Important directions for use¶
Areas of use and application¶
The content (e.g. source code and related documents) of this repository is intended to be used for configuration, parameterization, programming or diagnostics in combination with selected Bosch Rexroth ctrlX AUTOMATION devices. Additionally, the specifications given in the "Areas of Use and Application" for ctrlX AUTOMATION devices used with the content of this repository do also apply.
Unintended use¶
Any use of the source code and related documents of this repository in applications other than those specified above or under operating conditions other than those described in the documentation and the technical specifications is considered as "unintended". Furthermore, this software must not be used in any application areas not expressly approved by Bosch Rexroth.
About¶
Copyright © 2021-2022 Bosch Rexroth AG. All rights reserved.
Bosch Rexroth AG
Bgm.-Dr.-Nebel-Str. 2
97816 Lohr am Main
GERMANY
Licenses¶
MIT License
Copyright (c) 2021-2022 Bosch Rexroth AG
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.