openapi: 3.0.1 info: description: >- This is a sample IO-Link Master server. You can find out more about IO-Link at [http://www.io-link.com](http://www.io-link.com) # Description ## Error messages ### General errors * [101] HTTP Status 500: Internal server error * [102] HTTP Status 500: Internal communication error * [103] HTTP Status 404: Operation not supported * [104] HTTP Status 400: Action locked by another client - Remark: Fieldbus controller or another gateway protocol has claimed priority * [105] HTTP Status 501: IODD feature not supported * [106] HTTP Status 501: MQTT feature not supported * [150] HTTP Status 403: Permission denied - Remark: due to user management restrictions ### JSON Parsing errors * [201] HTTP Status 400: JSON parsing failed - Remark: Error while parsing the incoming JSON object * [202] HTTP Status 400: JSON data value invalid - Remark: Error while parsing a specific JSON value, e.g. malformed IP address * [203] HTTP Status 400: JSON data type invalid - Remark: e.g. string instead of number * [204] HTTP Status 400: Enumeration value unknown * [205] HTTP Status 400: JSON data value out of range - Remark: Exceeds the minimum or maximum value * [206] HTTP Status 400: JSON data value out of bounds - Remark: An array/string was accessed exceeding its maximum length * [207] HTTP Status 400: deviceAlias is not unique * [208] HTTP Status 400: POST request without content ### Resource access errors * [301] HTTP Status 404: Resource not found - Remark: e.g. wrong URL * [302] HTTP Status 404: masterNumber not found * [303] HTTP Status 404: portNumber not found * [304] HTTP Status 404: deviceAlias not found * [305] HTTP Status 400: Query parameter name invalid * [306] HTTP Status 400: Query parameter value invalid * [307] HTTP Status 400: Port is not configured to IO-Link - Remark: e.g. not in IOLINK_MANUAL or IOLINK_AUTOSTART mode * [308] HTTP Status 404: IO-Link Device is not accessible - Remark: e.g. not connected or communication error * [309] HTTP Status 404: IO-Link parameter not found * [310] HTTP Status 404: IO-Link parameter access not supported by the Device * [311] HTTP Status 400: IO-Link parameter access error - Remark: The additional iolinkErrorCode and iolinkErrorMessage fields contain the IO-Link error code and the incident text from the ErrorTypes table * [312] HTTP Status 404: IO-Link parameter name is not unique - Remark: Please use the {name}_{index} format ### Data Storage errors * [401] HTTP Status 400: Data storage mismatch - Remark: Mismatch between meta data of device and data storage ### Process Data handling * [501] HTTP Status 400: I/Q is not configured as DIGITAL_OUTPUT * [502] HTTP Status 400: C/Q is not configured as DIGITAL_OUTPUT * [503] HTTP Status 400: IO-Link device has no output process data ### IODD errors * [601] HTTP Status 400: IODD (representation) is not available - Remark: IODD representation for this IO-Link Device is not available * [602] HTTP Status 500: IODD upload failed: not enough memory * [603] HTTP Status 400: IODD upload failed: IODD XML invalid - Remark: Check the file content superficially to ensure that the IODD is an XML and an IODD (e.g. vendorId, deviceId, VendorName, ProductName and other mandatory elements or attributes) * [604] HTTP Status 400: IODD upload failed: CRC error * [605] HTTP Status 400: IODD upload failed: parsing error - Remark: All those systems that do not want to store the IODD have to parse it immediately ### Data content errors * [701] HTTP Status 400: Data set incomplete * [702] HTTP Status 400: Data set not applicable - Remark: whole data set is rejected * [703] HTTP Status 400: Data set combination incompatible - Remark: whole data set is rejected ### Implementation hints: * If there is more than one error in the request, the parsing is stopped and just the first detected error is returned. * Errors [101], [150] can be returned to every request. * Error [103] can be returned to every request which is not included in the base facet. * Specific error messages have to be provided only if the corresponding operation is supported. So you do not need to give specific errors for bad IODDs if you do not support the IODD Facet, just indicate error [105]. * Error [301] can be returned to every request where there is a variable in the URL. * If the request was successful and no body is specified, the response contains nothing in the body. version: 1.0.0 title: Swagger IO-Link Master contact: email: lorand.molnar@teconcept.de license: name: Apache 2.0 url: 'http://www.apache.org/licenses/LICENSE-2.0.html' servers: - url: '{scheme}://{host}/{basePath}' variables: basePath: default: iolink/v1 host: default: 'iolmaster.io-link.com' scheme: description: 'The IO-Link gateway can expose the API over https and/or http' enum: - 'https' - 'http' default: 'http' tags: - name: gateway description: Access to parameters of the JSON gateway - name: mqtt description: Access to the parameters of the MQTT client - name: iodds description: Access to the IODDs - name: masters description: Access to parameters of the IO-Link master itself - name: ports description: Access to the IO-Link ports of the IO-Link master - name: devices description: Access to the IO-Link Devices connected to the Master paths: '/gateway/identification': get: description: Read the identification data of the Gateway operationId: getGateywayIdentification tags: - gateway summary: Read the identification of the Gateway. responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/gatewayIdentificationGet' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error '/gateway/capabilities': get: description: Read the capatibities of the Gateway operationId: getGateywayCapabilities tags: - gateway summary: Read the capabilities of the Gateway. responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/gatewayCapabilitiesGet' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error '/gateway/configuration': get: tags: - gateway summary: Read the network configuration of the Gateway. description: Read the actual active configuration of the IO-Link Gateway. The Gateway may support multiple IPv4 interfaces operationId: getGatewayConfiguration responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/gatewayConfigurationGetPost' examples: Manual: value: ethIpv4: - ipConfiguration: MANUAL ipAddress: 192.168.1.13 subnetMask: 255.255.255.0 standardGateway: 192.168.1.1 DHCP: value: ethIpv4: - ipConfiguration: DHCP Multiple ethernet interfaces: value: ethIpv4: - ipConfiguration: MANUAL ipAddress: 192.168.1.13 subnetMask: 255.255.255.0 standardGateway: 192.168.1.1 - ipConfiguration: MANUAL ipAddress: 192.168.2.10 subnetMask: 255.255.255.0 standardGateway: 192.168.2.1 - ipConfiguration: DHCP '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error post: description: Write a new network configuration of the Gateway operationId: postGatewayConfiguration tags: - gateway summary: Write the network configuration of the Gateway. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/gatewayConfigurationGetPost' examples: Manual: value: ethIpv4: - ipConfiguration: MANUAL ipAddress: 192.168.1.13 subnetMask: 255.255.255.0 standardGateway: 192.168.1.1 DHCP: value: ethIpv4: - ipConfiguration: DHCP Multiple ethernet interfaces: value: ethIpv4: - ipConfiguration: MANUAL ipAddress: 192.168.1.13 subnetMask: 255.255.255.0 standardGateway: 192.168.1.1 - ipConfiguration: MANUAL ipAddress: 192.168.2.10 subnetMask: 255.255.255.0 standardGateway: 192.168.2.1 - ipConfiguration: DHCP responses: '204': description: Successful operation '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "104": value: code: 104 message: Action locked by another client "201": value: code: 201 message: JSON parsing failed "202": value: code: 202 message: JSON data value invalid "203": value: code: 203 message: JSON data type invalid "204": value: code: 204 message: Enumeration value unknown "205": value: code: 205 message: JSON data value out of range "206": value: code: 206 message: JSON data value out of bounds "208": value: code: 208 message: POST request without content "701": value: code: 701 message: Data set incomplete "702": value: code: 702 message: Data set not applicable "703": value: code: 703 message: Data set combination incompatible '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error '/gateway/reset': post: tags: - gateway summary: Reset the Gateway including all Masters. Optional. description: Invoke a reset of the IO-Link Gateway. This may reset all configuration data and interrupt all communications channels. It is recommended to log this within the EventLog operationId: postGatewayReset responses: '204': description: Successful operation '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "104": value: code: 104 message: Action locked by another client '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error '/gateway/reboot': post: tags: - gateway summary: Reboot the Gateway including all Masters. Optional. description: Invoke a reboot of the IO-Link Gateway. This may reset all configuration data and interrupt all communications channels. It is recommended to log this within the EventLog operationId: postGatewayReboot responses: '204': description: Successful operation '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "104": value: code: 104 message: Action locked by another client '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error '/gateway/events': get: tags: - gateway summary: Read the EventLog containing all events from Gateway, Masters, Ports and Devices. description: > Each Gateway shall have an Event Log object containing the events of the devices, ports and the masters. The content of the Event Log can be read by getting the object “Gateway Event Log” operationId: getGatewayEvents parameters: - $ref: '#/components/parameters/eventOrigin' - $ref: '#/components/parameters/eventMasterNumber' - $ref: '#/components/parameters/eventPortNumber' - $ref: '#/components/parameters/eventdeviceAlias' - $ref: '#/components/parameters/eventTop' - $ref: '#/components/parameters/eventBottom' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/gatewayEventsGet' examples: origin=ALL: value: - time: '2018-05-18T07:31:54.123Z' severity: WARNING origin: masterNumber: 1 message: text: IO-Link Master has restarted - time: '2018-05-18T07:32:42.023Z' severity: ERROR origin: masterNumber: 1 portNumber: 1 message: code: 6163 mode: APPEARS text: Overcurrent at C/Q (if digital output) - check load - time: '2018-05-18T07:31:54.123Z' severity: WARNING origin: masterNumber: 1 portNumber: 1 deviceAlias: Temp_sensor_1 message: code: 16912 mode: APPEARS text: Device temperature over-run – Clear source of heat origin=MASTERS: value: - time: '2018-05-18T07:31:54.123Z' severity: WARNING origin: masterNumber: 1 message: text: IO-Link Master has restarted origin=PORTS: value: - time: '2018-05-18T07:32:42.023Z' severity: ERROR origin: masterNumber: 1 port: 1 message: code: 6163 mode: APPEARS text: Overcurrent at C/Q (if digital output) - check load - time: '2018-05-18T07:33:42.023Z' severity: ERROR origin: masterNumber: 1 portNumber: 1 message: code: 6163 mode: DISAPPEARS text: Overcurrent at C/Q (if digital output) - check load - time: '2018-05-18T07:35:54.123Z' severity: NOTICE origin: masterNumber: 1 portNumber: 2 message: code: 65313 mode: SINGLESHOT text: New slave origin=DEVICES: value: - time: '2018-05-18T07:31:54.123Z' severity: WARNING origin: masterNumber: 1 portNumber: 1 deviceAlias: Temp_sensor_1 message: code: 16912 mode: APPEARS text: Device temperature over-run – Clear source of heat - time: '2018-05-18T08:31:54.123Z' severity: ERROR origin: masterNumber: 1 portNumber: 3 deviceAlias: Distance_Laser_3 message: code: 20480 mode: APPEARS text: Device hardware fault – Device exchange '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "305": value: code: 305 message: Query parameter name invalid "306": value: code: 306 message: Query parameter value invalid '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error '/mqtt/configuration': get: tags: - mqtt summary: >- Read the MQTT configuration of the Gateway. description: Read the MQTT configuraiton of the Gateway operationId: getMqttConfiguration responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/mqttConfigurationGetPost' examples: Active client: value: clientMode: "ACTIVE" serverAddress: 192.168.2.1/mqttbroker username: iolink_json password: '1234' lastwill: - topic: process_data message: Process data transfer stopped. qos: 0_ONLY_ONCE retain: true keepAliveTime: 10 Inactive client: value: clientMode: "INACTIVE" '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "106": value: code: 106 message: MQTT feature not supported post: tags: - mqtt summary: >- Update the MQTT configuration of the Gateway. description: Update the MQTT configuration of the Gateway. operationId: postMqttConfiguration requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/mqttConfigurationGetPost' examples: Active Client: value: clientMode: ACTIVE serverAddress: 192.168.2.1/mqttbroker username: iolink_json password: '1234' lastwill: - topic: process_data message: Process data transfer stopped. qos: 0_ONLY_ONCE retain: true keepAliveTime: 10 Inactive Client: value: clientMode: INACTIVE responses: '204': description: Successful operation '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "104": value: code: 104 message: Action locked by another client "201": value: code: 201 message: JSON parsing failed "202": value: code: 202 message: JSON data value invalid "203": value: code: 203 message: JSON data type invalid "204": value: code: 204 message: Enumeration value unknown "205": value: code: 205 message: JSON data value out of range "206": value: code: 206 message: JSON data value out of bounds "208": value: code: 208 message: POST request without content "701": value: code: 701 message: Data set incomplete "702": value: code: 702 message: Data set not applicable "703": value: code: 703 message: Data set combination incompatible '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "106": value: code: 106 message: MQTT feature not supported '/mqtt/topics': get: tags: - mqtt summary: Get the list of MQTT topics. description: Get the list of MQTT topics. operationId: GetMqttTopics responses: '200': description: Successful operation content: application/json: schema: type: array items: $ref: '#/components/schemas/mqttConfigurationTopicGet' example: - topicId: 1 topicName: Sensor34/processData qos: 1_AT_LEAST_ONCE deviceAlias: DT35 processData: direction: getData format: iodd interval: value: 10 unit: ms - topicId: 2 topicName: Sensor34/event qos: 1_AT_LEAST_ONCE deviceAlias: TAD081 event: {} - topicId: 3 topicName: PD qos: 0_ONLY_ONCE deviceAlias: BNI_IOL processData: direction: getSetData format: iodd onChange: true '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "106": value: code: 106 message: MQTT feature not supported post: tags: - mqtt summary: Create a new MQTT topic. description: Create a new MQTT topic. operationId: postMqttTopics requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/mqttConfigurationTopicPost' examples: Process Data: value: qos: 1_AT_LEAST_ONCE deviceAlias: DT35 processData: direction: getData format: iodd interval: value: 10 unit: ms Event: value: qos: 1_AT_LEAST_ONCE deviceAlias: TAD081 event: {} responses: '200': description: Successful operation returning the topic ID content: application/json: schema: type: integer '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "104": value: code: 104 message: Action locked by another client "201": value: code: 201 message: JSON parsing failed "202": value: code: 202 message: JSON data value invalid "203": value: code: 203 message: JSON data type invalid "204": value: code: 204 message: Enumeration value unknown "205": value: code: 205 message: JSON data value out of range "206": value: code: 206 message: JSON data value out of bounds "208": value: code: 208 message: POST request without content "701": value: code: 701 message: Data set incomplete "702": value: code: 702 message: Data set not applicable '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "106": value: code: 106 message: MQTT feature not supported '/mqtt/topics/{topicId}': get: tags: - mqtt summary: Get one MQTT topic. description: Get one MQTT topic operationId: getMqttTopicsTopicId parameters: - $ref: '#/components/parameters/mqttTopicId' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/mqttConfigurationTopicGet' examples: Process Data: value: topicId: 1 topicName: PD input qos: 1_AT_LEAST_ONCE deviceAlias: DT35 processData: direction: getData format: iodd interval: value: 10 unit: ms Event: value: topicId: 2 topicName: Event qos: 1_AT_LEAST_ONCE deviceAlias: TAD081 event: {} '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "301": value: code: 301 message: Resource not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "106": value: code: 106 message: MQTT feature not supported delete: tags: - mqtt summary: Delete a specific MQTT topic. description: Delete a specific MQTT topic. operationId: deleteMqttTopicsTopicsId parameters: - $ref: '#/components/parameters/mqttTopicId' responses: '204': description: Successful operation '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "104": value: code: 104 message: Action locked by another client '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "301": value: code: 301 message: Resource not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "106": value: code: 106 message: MQTT feature not supported '/mqtt/connectionstatus': get: tags: - mqtt summary: Read the connection status of the MQTT client to the MQTT server. description: Read the connection status of the MQTT client to the MQTT server. operationId: GetMqttConnectionstatus responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/mqttConnectionStatusGet' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: '150': value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: '103': value: code: 103 message: Operation not supported '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: '101': value: code: 101 message: Internal server error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "106": value: code: 106 message: MQTT feature not supported '/iodds': get: tags: - iodds summary: >- Get a list of all IODD (representations) that are available on the Gateway. description: >- Only one version of an IODD is stored on the webserver at the same time for one vendorId-deviceId-ioLinkRevision-combination. operationId: getIodds parameters: - $ref: '#/components/parameters/vendorId' - $ref: '#/components/parameters/deviceId' - $ref: '#/components/parameters/revision' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ioddsGet' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "305": value: code: 305 message: Query parameter name invalid "306": value: code: 306 message: Query parameter value invalid '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported delete: tags: - iodds summary: Delete a specific IODD representation. description: Delete a specific IODD representation. operationId: deleteIodds parameters: - $ref: '#/components/parameters/vendorId' - $ref: '#/components/parameters/deviceId' - $ref: '#/components/parameters/revision' responses: '204': description: Successful operation '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "104": value: code: 104 message: Action locked by another client "305": value: code: 305 message: Query parameter name invalid "306": value: code: 306 message: Query parameter value invalid '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "301": value: code: 301 message: Resource not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported '/iodds/file': get: tags: - iodds summary: Get a specific IODD. Optional. description: All query parameters are mandatory. operationId: getIoddsFile parameters: - $ref: '#/components/parameters/vendorId' - $ref: '#/components/parameters/deviceId' - $ref: '#/components/parameters/revision' responses: '200': description: Successful operation content: application/xml: schema: $ref: '#/components/schemas/ioddFile' example: "IODD XML file" '400': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "305": value: code: 305 message: Query parameter name invalid "306": value: code: 306 message: Query parameter value invalid '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "301": value: code: 301 message: Resource not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported post: tags: - iodds summary: Store or update an IODD. description: > It is not needed to specify the identification data for this action as the parser can read this information. operationId: postIoddsFile requestBody: required: true content: application/xml: schema: $ref: '#/components/schemas/ioddFile' example: "IODD XML file" responses: '204': description: Successful operation '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "104": value: code: 104 message: Action locked by another client "208": value: code: 208 message: POST request without content "603": value: code: 603 message: IODD upload failed. IODD XML invalid "604": value: code: 604 message: IODD upload failed. CRC error "605": value: code: 605 message: IODD upload failed. Parsing error '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "602": value: code: 602 message: IODD upload failed. Not enough memory '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported '/masters': get: tags: - masters summary: >- Read all the available masterNumber keys with the corresponding identification information. description: >- Read all the available masterNumber keys with the corresponding identification information. operationId: getMasters responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/identificationMasters' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '/masters/{masterNumber}/capabilities': get: tags: - masters summary: Read the capabilities of the Master. description: Read the capabilities of the Master. operationId: getMastersMasterNumberCapabilities parameters: - $ref: '#/components/parameters/masterNumber' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/masterCapabilitiesGet' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "302": value: code: 302 message: masterNumber not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '/masters/{masterNumber}/identification': get: tags: - masters summary: Read the identification of the Master. description: Read the identification of the Master. operationId: getMastersMasterNumberIdentification parameters: - $ref: '#/components/parameters/masterNumber' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/identificationGet' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "302": value: code: 302 message: masterNumber not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error post: tags: - masters summary: Write application specific identification to a Master. description: Write application specific identification to a Master. operationId: postMastersMasterNumberIdentification parameters: - $ref: '#/components/parameters/masterNumber' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/identificationPost' examples: All optional fiels: value: applicationSpecificTag: Fallback reader at the end of the belt locationTag: Down under functionTag: Code reading responses: '204': description: Successful operation '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "104": value: code: 104 message: Action locked by another client "201": value: code: 201 message: JSON parsing failed "202": value: code: 202 message: JSON data value invalid "203": value: code: 203 message: JSON data type invalid "206": value: code: 206 message: JSON data value out of bounds "208": value: code: 208 message: POST request without content '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "302": value: code: 302 message: masterNumber not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '/masters/{masterNumber}/ports': get: tags: - ports summary: Read all the available portNumber keys with the corresponding identification information. description: >- Read all the available portNumber keys with the corresponding identification information. operationId: getMastersMasterNumberPorts parameters: - $ref: '#/components/parameters/masterNumber' responses: '200': description: Successful operation content: application/json: schema: type: array items: type: object required: - portNumber - statusInfo - deviceAlias properties: portNumber: type: integer minimum: 1 statusInfo: type: string deviceAlias: type: string example: - portNumber: 1 statusInfo: "DEVICE_ONLINE" deviceAlias: "Distance_Sensor" - portNumber: 2 statusInfo: "DEVICE_ONLINE" deviceAlias: "Pressure_Sensor" - portNumber: 3 statusInfo: "DIGITAL_INPUT_C/Q" deviceAlias: "Switching_Sensor" - portNumber: 4 statusInfo: "DEACTIVATED" deviceAlias: "Empty_port" '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "302": value: code: 302 message: masterNumber not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '/masters/{masterNumber}/ports/{portNumber}/capabilities': get: tags: - ports summary: Read the capability information of the specified port. description: Read the capability information of the specified port. operationId: getMastersMasterNumberPortsPortNumberCapabilities parameters: - $ref: '#/components/parameters/masterNumber' - $ref: '#/components/parameters/portNumber' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/portCapabilitiesGet' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "302": value: code: 302 message: masterNumber not found "303": value: code: 303 message: portNumber not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '/masters/{masterNumber}/ports/{portNumber}/status': get: tags: - ports summary: Read the actual status of the selected port. description: Read the actual status of the selected port. operationId: getMastersMasterNumberPortsPortNumberStatus parameters: - $ref: '#/components/parameters/masterNumber' - $ref: '#/components/parameters/portNumber' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/portStatusGet' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "302": value: code: 302 message: masterNumber not found "303": value: code: 303 message: portNumber not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '/masters/{masterNumber}/ports/{portNumber}/configuration': get: tags: - ports parameters: - $ref: '#/components/parameters/masterNumber' - $ref: '#/components/parameters/portNumber' summary: Read the actual configuration of the specified port. description: Read the actual configuration of the specified port. operationId: getMastersMasterNumberPortsPortNumberConfiguration responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/portConfigurationGet' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "302": value: code: 302 message: masterNumber not found "303": value: code: 303 message: portNumber not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error post: tags: - ports summary: Write the configuration of the specified port. description: Write the configuration of the specified port. operationId: postMastersMasterNumbersPortsPortNumberConfiguration parameters: - $ref: '#/components/parameters/masterNumber' - $ref: '#/components/parameters/portNumber' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/portConfigurationPost' examples: Complete configuration: value: mode: IOLINK_MANUAL validationAndBackup: TYPE_COMPATIBLE_DEVICE_V1.1 cycleTime: value: 2.3 unit: ms vendorId: 26 deviceId: 333 iqConfiguration: DIGITAL_INPUT deviceAlias: Distance_sensor_1 Change CQ mode: value: mode: IOLINK_AUTOSTART Change iqConfiguration: value: iqConfiguration: DIGITAL_OUTPUT Change the deviceAlias: value: deviceAlias: Flow_control_1 responses: '204': description: Successful operation '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "104": value: code: 104 message: Action locked by another client "201": value: code: 201 message: JSON parsing failed "202": value: code: 202 message: JSON data value invalid "203": value: code: 203 message: JSON data type invalid "204": value: code: 204 message: Enumeration value unknown "205": value: code: 205 message: JSON data value out of range "207": value: code: 207 message: deviceAlias is not unique "208": value: code: 208 message: POST request without content "701": value: code: 701 message: Data set incomplete "702": value: code: 702 message: Data set not applicable "703": value: code: 703 message: Data set combination incompatible '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "302": value: code: 302 message: masterNumber not found "303": value: code: 303 message: portNumber not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '/masters/{masterNumber}/ports/{portNumber}/datastorage': get: tags: - ports parameters: - $ref: '#/components/parameters/masterNumber' - $ref: '#/components/parameters/portNumber' summary: Read the Data Storage content of a specific port. description: Read the Data Storage content of a specific port. operationId: getMastersMasterNumberPortsPortNumberDatastorage responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/dataStorageGetPost' examples: "Data Storage with valid content": value: header: vendorId: 15 deviceId: 65253 ioLinkRevision: '1.1' content: >- TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGl "Empty Data Storage": value: header: {} content: '' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "302": value: code: 302 message: masterNumber not found "303": value: code: 303 message: portNumber not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error post: tags: - ports parameters: - $ref: '#/components/parameters/masterNumber' - $ref: '#/components/parameters/portNumber' summary: Write the Data Storage content to a specific port. description: Write the Data Storage content to a specific port. operationId: postMastersMasterNumberPortsPortNumberDatastorage requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dataStorageGetPost' examples: Data Storage with valid content: value: header: vendorId: 15 deviceId: 65253 ioLinkRevision: '1.1' content: >- TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGl Empty Data Storage: value: header: {} content: '' responses: '204': description: Successful operation '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "104": value: code: 104 message: Action locked by another client "201": value: code: 201 message: JSON parsing failed "202": value: code: 202 message: JSON data value invalid "203": value: code: 203 message: JSON data type invalid "204": value: code: 204 message: Enumeration value unknown "205": value: code: 205 message: JSON data value out of range "206": value: code: 206 message: JSON data value out of bounds "208": value: code: 208 message: POST request without content "401": value: code: 401 message: Data storage mismatch "701": value: code: 701 message: Data set incomplete '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "302": value: code: 302 message: masterNumber not found "303": value: code: 303 message: portNumber not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '/devices': get: tags: - devices summary: Get all available deviceAlias keys and the location by Master number and Port number. description: >- Get all available deviceAlias keys and the location by Master number and Port number. operationId: getDevices responses: '200': description: Successful operation content: application/json: schema: type: array items: type: object required: - deviceAlias - masterNumber - portNumber properties: deviceAlias: type: string masterNumber: type: integer minimum: 1 portNumber: type: integer minimum: 1 example: - deviceAlias: DT35 masterNumber: 1 portNumber: 1 - deviceAlias: TAD081 masterNumber: 1 portNumber: 2 - deviceAlias: BNI_IOL masterNumber: 1 portNumber: 3 - deviceAlias: master1port4 masterNumber: 1 portNumber: 4 '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '/devices/{deviceAlias}/capabilities': get: tags: - devices summary: Read the capabilities from the specific Device. description: Read the capabilities from the specific Device. operationId: GetDevicesDeviceAliasCapabilities parameters: - $ref: '#/components/parameters/deviceAlias' responses: '200': description: Successful opearation content: application/json: schema: $ref: '#/components/schemas/deviceCapabilitiesGet' example: minimumCycleTime: value: 2.3 unit: ms supportedProfiles: [10, 32770] '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "307": value: code: 307 message: Port is not configured to IO-Link '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "304": value: code: 304 message: deviceAlias not found "308": value: code: 308 message: IO-Link Device is not accessible '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: '101': value: code: 101 message: Internal server error '102': value: code: 102 message: Internal communication error '/devices/{deviceAlias}/identification': get: tags: - devices summary: Read the identification from the specific Device. description: >- *Implementation hint*: You have to request the ISDU values of applicationSpecificTag, locationTag and functionTag (if they are supported by the device). operationId: getDevicesDeviceAliasIdentification parameters: - $ref: '#/components/parameters/deviceAlias' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/deviceIdentificationGet' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "307": value: code: 307 message: Port is not configured to IO-Link '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "304": value: code: 304 message: deviceAlias not found "308": value: code: 308 message: IO-Link Device is not accessible '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error post: tags: - devices summary: Write application specific identification to the Device. description: >- Write application specific identification to the Device. operationId: postDevicesDeviceAliasIdentification parameters: - $ref: '#/components/parameters/deviceAlias' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/portIdentificationPost' examples: All optional fields: value: applicationSpecificTag: Fallback light switch at the end of the belt locationTag: Down under functionTag: Check start of belt responses: '204': description: Successful operation '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "104": value: code: 104 message: Action locked by another client "201": value: code: 201 message: JSON parsing failed "202": value: code: 202 message: JSON data value invalid "203": value: code: 203 message: JSON data type invalid "206": value: code: 206 message: JSON data value out of bounds "208": value: code: 208 message: POST request without content "307": value: code: 307 message: Port is not configured to IO-Link '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "304": value: code: 304 message: deviceAlias not found "308": value: code: 308 message: IO-Link Device is not accessible "309": value: code: 309 message: IO-Link parameter not found "310": value: code: 310 message: IO-Link parameter access not supported by the device '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '/devices/{deviceAlias}/processdata/value': get: tags: - devices summary: Read the process data values (input and output) from the specified Device. description: >- Read the process data values (input and output) from the specified Device. operationId: getDevicesDeviceAliasProcessdataValue parameters: - $ref: '#/components/parameters/deviceAlias' - $ref: '#/components/parameters/format' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/deviceProcessDataValueGet' examples: 'Format=byteArray, CQ in IO-Link (only input), IQ in digital output': value: getData: ioLink: valid: true value: - 12 - 22 - 216 setData: iqValue: true 'Format=iodd, CQ in IO-Link (input and output), IQ in digital input': value: getData: ioLink: valid: true value: Distance: value: 55 Quality: value: 12 iqValue: true setData: ioLink: valid: true value: Buzzer: value: 5 '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "305": value: code: 305 message: Query parameter name invalid "306": value: code: 306 message: Query parameter value invalid "601": value: code: 601 message: IODD (representation) for this IO-Link device is not available '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "304": value: code: 304 message: deviceAlias not found "308": value: code: 308 message: IO-Link Device is not accessible '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: '101': value: code: 101 message: Internal server error '102': value: code: 102 message: Internal communication error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported post: tags: - devices summary: Write the process data output values to the specified Device. description: Write the process data output values to the specified Device. operationId: postDevicesDeviceAliasProcessdataValue parameters: - $ref: '#/components/parameters/deviceAlias' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/deviceProcessDataValuePost' examples: 'format=byteArray, CQ (pin4) in IO-Link, IQ (pin2) in digital output': value: ioLink: valid: true value: - 15 - 123 - 126 - 236 iqValue: true 'format=iodd, CQ (pin4) in IO-Link, IQ (pin2) not available': value: iolink: valid: true value: Valve_1: value: true Valve_2: value: false responses: '204': description: Successful operation '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "104": value: code: 104 message: Action locked by another client "201": value: code: 201 message: JSON parsing failed "202": value: code: 202 message: JSON data value invalid "203": value: code: 203 message: JSON data type invalid "204": value: code: 204 message: Enumeration value unknown "205": value: code: 205 message: JSON data value out of range "206": value: code: 206 message: JSON data value out of bounds "208": value: code: 208 message: POST request without content "305": value: code: 305 message: Query parameter name invalid "306": value: code: 306 message: Query parameter value invalid "307": value: code: 307 message: Port is not configured to IO-Link "501": value: code: 501 message: I/Q is not configured as DIGITAL_OUTPUT "502": value: code: 502 message: C/Q is not configured as DIGITAL_OUTPUT "503": value: code: 503 message: IO-Link Device has no output process data "601": value: code: 601 message: IODD (representation) for this IO-Link device is not available "701": value: code: 701 message: Data set incomplete "702": value: code: 702 message: Data set not applicable "703": value: code: 703 message: Data set combination incompatible '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "304": value: code: 304 message: deviceAlias not found "308": value: code: 308 message: IO-Link Device is not accessible '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported '/devices/{deviceAlias}/processdata/getdata/value': get: tags: - devices summary: >- Read the process data input values from the specified Device. description: >- Read the process data input values from the specified Device. operationId: getDevicesDeviceAliasProcessdataGetdataValue parameters: - $ref: '#/components/parameters/deviceAlias' - $ref: '#/components/parameters/format' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/processDataValue' examples: 'Format=byteArray, CQ (pin4) in IO-Link, IQ (pin2) in digital input': value: ioLink: valid: true value: - 12 - 22 - 216 iqValue: true 'Format=iodd, CQ (pin4) in IO-Link, IQ (pin2) in digital input': value: ioLink: valid: true value: Distance: value: 55 Quality: value: 12 iqValue: true '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "305": value: code: 305 message: Query parameter name invalid "306": value: code: 306 message: Query parameter value invalid "601": value: code: 601 message: IODD (representation) for this IO-Link device is not available '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "304": value: code: 304 message: deviceAlias not found "308": value: code: 308 message: IO-Link Device is not accessible '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: '101': value: code: 101 message: Internal server error '102': value: code: 102 message: Internal communication error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported '/devices/{deviceAlias}/processdata/setdata/value': get: tags: - devices summary: >- Read the process data output values from the specified Device. description: >- Read the process data output values from the specified Device. operationId: DevicesDeviceAliasProcessdataSetdataValue parameters: - $ref: '#/components/parameters/deviceAlias' - $ref: '#/components/parameters/format' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/processDataValue' examples: 'Format=byteArray, CQ (pin4) in digital output, IQ (pin2) in digital input': value: cqValue: false 'Format=iodd, CQ (pin4) in IO-Link, IQ (pin2) in digital input': value: iolink: valid: true value: Valve_1: value: true Valve_2: value: false '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: '305': value: code: 305 message: Query parameter name invalid '306': value: code: 306 message: Query parameter value invalid '601': value: code: 601 message: IODD (representation) for this IO-Link device is not available '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: '150': value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "304": value: code: 304 message: deviceAlias not found "308": value: code: 308 message: IO-Link Device is not accessible "503": value: code: 503 message: IO-Link Device has no output process data '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: '101': value: code: 101 message: Internal server error '102': value: code: 102 message: Internal communication error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported '/devices/{deviceAlias}/parameters': get: tags: - devices summary: >- Read all available parameter indices and parameter names from the specific Device. IODD support is required. description: >- Read all available parameter indices and parameter names from the specific Device. IODD support is required. operationId: getDevicesDeviceAliasProcessdataSetdataValue parameters: - $ref: '#/components/parameters/deviceAlias' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/deviceParametersGet' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "305": value: code: 305 message: Query parameter name invalid "306": value: code: 305 message: Query parameter value invalid "601": value: code: 601 message: IODD (representation) for this IO-Link device is not available '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "304": value: code: 304 message: deviceAlias not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported '/devices/{deviceAlias}/parameters/{index}/value': get: tags: - devices summary: Read a parameter value from the specific Device with the given index. description: >- Read a parameter value from the specific Device with the given index. operationId: getDevicesDeviceAliasParametersIndexValue parameters: - $ref: '#/components/parameters/deviceAlias' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/format' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/deviceParameterValueGetPost' examples: format=byteArray: value: - 0 - 156 - 125 - 25 'format=iodd, simple type': value: value: 15.2 'format=iodd, complex type': value: Distance: value: 15 Quality: value: 12 '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "305": value: code: 305 message: Query parameter name invalid "306": value: code: 306 message: Query parameter value invalid "307": value: code: 307 message: Port is not configured to IO-Link "311": value: code: 311 message: IO-Link parameter access error "601": value: code: 601 message: IODD (representation) for this IO-Link device is not available '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "304": value: code: 304 message: deviceAlias not found "308": value: code: 308 message: IO-Link Device is not accessible "309": value: code: 309 message: IO-Link parameter not found "310": value: code: 310 message: IO-Link parameter access not supported by the device '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported post: tags: - devices summary: Write a parameter value with the given index to the specified Device. description: >- Write a parameter value with the given index to the specified Device. operationId: postDevicesDeviceAliasParametersIndexValue parameters: - $ref: '#/components/parameters/deviceAlias' - $ref: '#/components/parameters/index' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/deviceParameterValueGetPost' examples: 'payload as byteArray': value: - 0 - 156 - 125 - 25 'payload as iodd, simple type': value: value: 15.2 'payload as iodd, complex type': value: Distance: value: 15 Quality: value: 12 responses: '204': description: Successful operation '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "104": value: code: 104 message: Action locked by another client "201": value: code: 201 message: JSON parsing failed "202": value: code: 202 message: JSON data value invalid "203": value: code: 203 message: JSON data type invalid "204": value: code: 204 message: Enumeration value unknown "205": value: code: 205 message: JSON data value out of range "206": value: code: 206 message: JSON data value out of bounds "208": value: code: 208 message: POST request without content "305": value: code: 305 message: Query parameter name invalid "306": value: code: 306 message: Query parameter value invalid "307": value: code: 307 message: Port is not configured to IO-Link "311": value: code: 311 message: IO-Link parameter access error "601": value: code: 601 message: IODD (representation) for this IO-Link device is not available "701": value: code: 701 message: Data set incomplete '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "304": value: code: 304 message: deviceAlias not found "308": value: code: 308 message: IO-Link Device is not accessible "309": value: code: 309 message: IO-Link parameter not found "310": value: code: 310 message: IO-Link parameter access not supported by the device '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported '/devices/{deviceAlias}/parameters/{parameterName}/value': get: tags: - devices summary: >- Read a parameter value from the specific Device by parameter name. IODD support is required. description: >- Read a parameter value from the specific Device by parameter name. IODD support is required. operationId: getDevicesDeviceAliasParametersParameterNameValue parameters: - $ref: '#/components/parameters/deviceAlias' - $ref: '#/components/parameters/parameterName' - $ref: '#/components/parameters/format' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/deviceParameterValueGetPost' examples: format=byteArray: value: - 0 - 156 - 125 - 25 'format=iodd, simple type': value: value: 15.2 'format=iodd, complex type': value: Distance: value: 15 Quality: value: 12 '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "305": value: code: 305 message: Query parameter name invalid "306": value: code: 306 message: Query parameter value invalid "307": value: code: 307 message: Port is not configured to IO-Link "311": value: code: 311 message: IO-Link parameter access error "601": value: code: 601 message: IODD (representation) for this IO-Link device is not available '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "304": value: code: 304 message: deviceAlias not found "308": value: code: 308 message: IO-Link Device is not accessible "309": value: code: 309 message: IO-Link parameter not found "310": value: code: 310 message: IO-Link parameter access not supported by the device "312": value: code: 312 message: IO-Link parameter name is not unique '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported post: tags: - devices summary: >- Write a parameter value by name to the specified Device.IODD support is required. IODD support is required. description: >- Write a parameter value by name to the specified Device.IODD support is required. IODD support is required. operationId: postDevicesDeviceAliasParametersParameterNameValue parameters: - $ref: '#/components/parameters/deviceAlias' - $ref: '#/components/parameters/parameterName' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/deviceParameterValueGetPost' examples: format=byteArray: value: - 0 - 156 - 125 - 25 'format=iodd, simple type': value: value: 15.2 'format=iodd, complex type': value: Distance: value: 15 Quality: value: 12 responses: '204': description: Successful operation '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "104": value: code: 104 message: Action locked by another client "201": value: code: 201 message: JSON parsing failed "202": value: code: 202 message: JSON data value invalid "203": value: code: 203 message: JSON data type invalid "204": value: code: 204 message: Enumeration value unknown "205": value: code: 205 message: JSON data value out of range "206": value: code: 206 message: JSON data value out of bounds "208": value: code: 208 message: POST request without content "307": value: code: 307 message: Port is not configured to IO-Link "311": value: code: 311 message: IO-Link parameter access error "601": value: code: 601 message: IODD (representation) for this IO-Link device is not available "701": value: code: 701 message: Data set incomplete '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "304": value: code: 304 message: deviceAlias not found "308": value: code: 308 message: IO-Link Device is not accessible "309": value: code: 309 message: IO-Link parameter not found "310": value: code: 310 message: IO-Link parameter access not supported by the device "312": value: code: 312 message: IO-Link parameter name is not unique '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported '/devices/{deviceAlias}/parameters/{index}/subindices': get: tags: - devices summary: >- Read all available parameter sub-indices and sub-parameter names from the specific Device. IODD support is required. description: >- Read all available parameter sub-indices and sub-parameter names from the specific Device. IODD support is required. operationId: getDevicesDeviceAliasParametersIndexSubindices parameters: - $ref: '#/components/parameters/deviceAlias' - $ref: '#/components/parameters/index' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/deviceSubParametersGet' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "601": value: code: 601 message: IODD (representation) for this IO-Link device is not available '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "304": value: code: 304 message: deviceAlias not found "309": value: code: 309 message: IO-Link parameter not found "310": value: code: 310 message: IO-Link parameter access not supported by the device '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported '/devices/{deviceAlias}/parameters/{parameterName}/subindices': get: tags: - devices summary: >- Read all available parameter sub-indices and sub-parameter names from the specific Device (referenced by parameter name). IODD support is required. description: >- Read all available parameter sub-indices and sub-parameter names from the specific Device (referenced by parameter name). IODD support is required. operationId: getDevicesDeviceAliasParametersParameterNameSubindices parameters: - $ref: '#/components/parameters/deviceAlias' - $ref: '#/components/parameters/parameterName' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/deviceSubParametersGet' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "601": value: code: 601 message: IODD (representation) for this IO-Link device is not available '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "304": value: code: 304 message: deviceAlias not found "312": value: code: 312 message: IO-Link parameter name is not unique '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported '/devices/{deviceAlias}/parameters/{index}/subindices/{subindex}/value': get: tags: - devices summary: >- Read a parameter value from the specific Device with the given index and subindex. description: >- Read a parameter value from the specific Device with the given index and subindex. operationId: getDevicesDeviceAliasPArametersIndexSubindicesSubindexValue parameters: - $ref: '#/components/parameters/deviceAlias' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/subindex' - $ref: '#/components/parameters/format' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/deviceParameterSubindexValueGetPost' examples: format=byteArray: value: - 0 - 156 - 125 - 25 format=iodd: value: value: 15.2 '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "305": value: code: 305 message: Query parameter name invalid "306": value: code: 306 message: Query parameter value invalid "307": value: code: 307 message: Port is not configured to IO-Link "311": value: code: 311 message: IO-Link parameter access error "601": value: code: 601 message: IODD (representation) for this IO-Link device is not available '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "304": value: code: 304 message: deviceAlias not found "308": value: code: 308 message: IO-Link Device is not accessible "309": value: code: 309 message: IO-Link parameter not found "310": value: code: 310 message: IO-Link parameter access not supported by the device '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported post: tags: - devices summary: >- Write the parameter with the given index and subindex. description: >- Write the parameter with the given index and subindex. operationId: postDevicesDeviceAliasPArametersIndexSubindicesSubindexValue parameters: - $ref: '#/components/parameters/deviceAlias' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/subindex' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/deviceParameterSubindexValueGetPost' examples: format=byteArray: value: - 0 - 156 - 125 - 25 format=iodd: value: value: 15.2 responses: '204': description: Successful operation '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "104": value: code: 104 message: Action locked by another client "201": value: code: 201 message: JSON parsing failed "202": value: code: 202 message: JSON data value invalid "203": value: code: 203 message: JSON data type invalid "204": value: code: 204 message: Enumeration value unknown "205": value: code: 205 message: JSON data value out of range "206": value: code: 206 message: JSON data value out of bounds "208": value: code: 208 message: POST request without content "307": value: code: 307 message: Port is not configured to IO-Link "311": value: code: 311 message: IO-Link parameter access error "601": value: code: 601 message: IODD is not availabl "701": value: code: 701 message: Data set incomplete '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "304": value: code: 304 message: deviceAlias not found "308": value: code: 308 message: IO-Link Device is not accessible "309": value: code: 309 message: IO-Link parameter not found "310": value: code: 310 message: IO-Link parameter access not supported by the device '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported '/devices/{deviceAlias}/parameters/{parameterName}/subindices/{subParameterName}/value': get: tags: - devices summary: >- Read a parameter value from the specific Device by parameter name and subname. IODD support is required. description: >- Read a parameter value from the specific Device by parameter name and subname. IODD support is required. operationId: getDevicesDeviceAliasParametersParameterNameSubindicesSubParameterNameValue parameters: - $ref: '#/components/parameters/deviceAlias' - $ref: '#/components/parameters/parameterName' - $ref: '#/components/parameters/subParameterName' - $ref: '#/components/parameters/format' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/deviceParameterSubindexValueGetPost' examples: format=byteArray: value: - 0 - 156 - 125 - 25 format=iodd: value: value: 15.2 '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "305": value: code: 305 message: Query parameter name invalid "306": value: code: 306 message: Query parameter value invalid "307": value: code: 307 message: Port is not configured to IO-Link "311": value: code: 311 message: IO-Link parameter access error "601": value: code: 601 message: IODD (representation) for this IO-Link device is not available '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "304": value: code: 304 message: deviceAlias not found "308": value: code: 308 message: IO-Link Device is not accessible "309": value: code: 309 message: IO-Link parameter not found "310": value: code: 310 message: IO-Link parameter access not supported by the device "312": value: code: 312 message: IO-Link parameter name is not unique '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported post: tags: - devices summary: >- Write a parameter value to the specific Device by the parameter name and subname. IODD support is required. description: >- Write a parameter value to the specific Device by the parameter name and subname. IODD support is required. operationId: postDevicesDeviceAliasParametersParameterNameSubindicesSubParameterNameValue parameters: - $ref: '#/components/parameters/deviceAlias' - $ref: '#/components/parameters/parameterName' - $ref: '#/components/parameters/subParameterName' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/deviceParameterSubindexValueGetPost' examples: format=byteArray: value: - 0 - 156 - 125 - 25 format=iodd: value: value: 15.2 responses: '204': description: Successful operation '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "104": value: code: 104 message: Action locked by another client "201": value: code: 201 message: JSON parsing failed "202": value: code: 202 message: JSON data value invalid "203": value: code: 203 message: JSON data type invalid "204": value: code: 204 message: Enumeration value unknown "205": value: code: 205 message: JSON data value out of range "206": value: code: 206 message: JSON data value out of bounds "208": value: code: 208 message: POST request without content "307": value: code: 307 message: Port is not configured to IO-Link "311": value: code: 311 message: IO-Link parameter access error "601": value: code: 601 message: IODD (representation) for this IO-Link device is not available "701": value: code: 701 message: Data set incomplete '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "304": value: code: 304 message: deviceAlias not found "308": value: code: 308 message: IO-Link Device is not accessible "309": value: code: 309 message: IO-Link parameter not found "310": value: code: 310 message: IO-Link parameter access not supported by the device "312": value: code: 312 message: IO-Link parameter name is not unique '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported '/devices/{deviceAlias}/blockparameterization': post: tags: - devices summary: >- Write or read one or more parameters using the block parameterization method. description: >- Write or read one or more parameters using the block parameterization method. operationId: postDevicesDeviceAliasBlockparameterization parameters: - $ref: '#/components/parameters/deviceAlias' - $ref: '#/components/parameters/format' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/deviceBlockParameterizationPost' examples: 'read, format=byteArray': value: direction: READ parameters: - identifier: index: 15 - identifier: index: 65 subIndex: 2 'read, format=iodd': value: direction: READ parameters: - identifier: parameterName: Application_tag - identifier: parameterName: Distance subParameterName: Quality 'write, format=byteArray': value: direction: WRITE parameters: - identifier: index: 123 content: - 15 - 232 - 22 - identifier: index: 233 subIndex: 2 content: - 23 - 149 - 206 'write, format=iodd': value: direction: WRITE parameters: - identifier: parameterName: Application_tag content: value: 'Level 2, row 3' - identifier: parameterName: Hysteresis subParameterName: Channel_B content: value: 123 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/deviceBlockParameterizationPostParametersAnswer' examples: 'read, format=byteArray': value: - identifier: index: 123 result: parameterExchangeResult: READ_SUCCESS content: - 15 - 232 - 22 - identifier: index: 233 subIndex: 2 result: parameterExchangeResult: READ_SUCCESS content: - 23 - 149 - 206 'read, format=iodd': value: - identifier: parameterName: Application_tag result: parameterExchangeResult: READ_SUCCESS content: value: 'Level 2, row 3' - identifier: parameterName: Hysteresis subParameterName: Channel_B result: parameterExchangeResult: READ_SUCCESS content: value: 123 'read, format=byteArray with error': value: - identifier: index: 123 result: parameterExchangeResult: ERROR iolinkError: code: 32802 message: Service temporarily not available – Device control - identifier: index: 233 result: parameterExchangeResult: ERROR iolinkError: code: 32803 message: Access denied 'write, format=byteArray': value: - identifier: index: 123 result: parameterExchangeResult: WRITE_SUCCESS - identifier: index: 233 result: parameterExchangeResult: WRITE_SUCCESS 'write, format=iodd': value: - identifier: parameterName: Application_tag result: parameterExchangeResult: WRITE_SUCCESS - identifier: parameterName: Hysteresis subParameterName: Channel_B result: parameterExchangeResult: WRITE_SUCCESS 'write, format=byteArray, with error': value: - identifier: index: 123 result: parameterExchangeResult: ERROR iolinkError: code: 32816 message: Parameter value out of range - identifier: index: 233 result: parameterExchangeResult: ERROR iolinkError: code: 32817 message: Parameter value above limit '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "104": value: code: 104 message: Action locked by another client "201": value: code: 201 message: JSON parsing failed "202": value: code: 202 message: JSON data value invalid "203": value: code: 203 message: JSON data type invalid "204": value: code: 204 message: Enumeration value unknown "205": value: code: 205 message: JSON data value out of range "206": value: code: 206 message: JSON data value out of bounds "208": value: code: 208 message: POST request without content "305": value: code: 305 message: Query parameter name invalid "306": value: code: 306 message: Query parameter value invalid "307": value: code: 307 message: Port is not configured to IO-Link "311": value: code: 311 message: IO-Link parameter access error "601": value: code: 601 message: IODD (representation) for this IO-Link device is not available "701": value: code: 701 message: Data set incomplete "702": value: code: 702 message: Data set not applicable "703": value: code: 703 message: Data set combination incompatible '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "103": value: code: 103 message: Operation not supported "304": value: code: 304 message: deviceAlias not found "308": value: code: 308 message: IO-Link Device is not accessible "310": value: code: 310 message: IO-Link parameter access not supported by the device '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "105": value: code: 105 message: IODD feature not supported '/devices/{deviceAlias}/events': get: tags: - devices parameters: - $ref: '#/components/parameters/deviceAlias' - $ref: '#/components/parameters/eventTop' - $ref: '#/components/parameters/eventBottom' summary: Reading the EventLog filtered for a specific Device. description: >- Reading the EventLog filtered for a specific Device. operationId: getDevicesDevicesAliasEvents responses: '200': description: >- Successful operation. In case of empty event log, an empty array is returned. content: application/json: schema: $ref: '#/components/schemas/deviceEventsGet' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "305": value: code: 305 message: Query parameter name invalid "306": value: code: 306 message: Query parameter value invalid '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "150": value: code: 150 message: Permission denied '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "304": value: code: 304 message: deviceAlias not found '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorObject' examples: "101": value: code: 101 message: Internal server error "102": value: code: 102 message: Internal communication error components: schemas: cycleTime: type: object required: - value - unit properties: value: type: number unit: type: string enum: - ms event: type: object ipConfiguration: type: string enum: - MANUAL - DHCP - AUTO_IP - DCP processData: allOf: - type: object required: - direction - format properties: direction: $ref: '#/components/schemas/content' format: $ref: '#/components/schemas/format' oneOf: - type: object required: - interval properties: interval: $ref: '#/components/schemas/cycleTime' - type: object required: - onChange properties: onChange: type: boolean format: type: string enum: - byteArray - iodd default: byteArray content: type: string enum: - getData - setData - getSetData default: getData eventOrigin: type: string enum: - ALL - GATEWAY - MASTERS - PORTS - DEVICES default: ALL eventMasterNumber: type: number minimum: 1 eventPortNumber: type: integer minimum: 1 eventdeviceAlias: type: string eventTop: type: number eventBottom: type: number identificationMasters: type: array items: type: object required: - masterNumber properties: masterNumber: type: number minimum: 1 serialNumber: type: string locationTag: type: string example: - masterNumber: 1 serialNumber: A12345678B locationTag: slot 5 - masterNumber: 2 serialNumber: 123A45B783 locationTag: slot 6 identificationGet: required: - vendorName - vendorId - masterId - masterType type: object properties: vendorName: type: string vendorId: type: integer minimum: 1 maximum: 65535 masterId: type: integer minimum: 1 maximum: 4294967295 masterType: type: string enum: - Unspecific - Master acc. V1.0 - Master acc. V1.1 - Failsafe_Master - Wireless_Master serialNumber: type: string orderCode: type: string productName: type: string productId: type: string hardwareRevision: type: string firmwareRevision: type: string vendorUrl: type: string manualUrl: type: string applicationSpecificTag: type: string locationTag: type: string functionTag: type: string example: vendorName: Vendor GmbH vendorId: 26 masterId: 42 masterType: Master acc. V1.0 serialNumber: IOLM123456 orderCode: PROD-123456 productName: IO-Link Master productId: PROD-123456 hardwareRevision: 3.2.1.444R firmwareRevision: 3.2.1.888R vendorUrl: 'http://www.io-link.com/io-link-master' manualUrl: 'http://www.io-link.com/io-link-master/documentation.pdf' applicationSpecificTag: Fallback reader at the end of the belt locationTag: Down under functionTag: Code reading identificationPost: type: object properties: applicationSpecificTag: type: string locationTag: type: string functionTag: type: string gatewayCapabilitiesGet: required: - ioddSupported - mqttSupported type: object properties: ioddSupported: type: boolean mqttSupported: type: boolean example: ioddSupported: true mqttSupported: true masterCapabilitiesGet: required: - numberOfPorts - maxPowerSupply type: object properties: numberOfPorts: type: integer minimum: 1 maxPowerSupply: type: object required: - value - unit properties: value: type: number unit: type: string example: numberOfPorts: 8 maxPowerSupply: value: 0.3 unit: A eventTime: description: >- Timestamp (format defined in DIN ISO 8601). This field can give an absolute time or a relative time. Both formats are defined in DIN ISO 8601. type: string eventSeverity: description: >- Indicates the severity of the message. The IO-Link EventType NOTIFICATION maps to NOTICE, WARNING to WARNING and ERROR to ERROR. type: string enum: - EMERGENCY - ALERT - CRITICAL - ERROR - WARNING - NOTICE - INFO - DEBUG eventOriginObject: type: object properties: gateway: type: string masterNumber: description: >- This property is mandatory for IO-Link Master Events, IO-Link Port Events and IO-Link Device Events. Should not be used for other log entries. type: integer minimum: 1 portNumber: description: >- This property is mandatory for IO-Link Port Events and IO-Link Device Events. Should not be used for other log entries. type: integer minimum: 1 deviceAlias: description: >- This property is mandatory for IO-Link Device Events. Should not be used for other log entries. type: string eventObject: type: object properties: code: description: >- IO-Link Port EventCode or IO-Link Device EventCode. This property is mandatory for IO-Link Port Events or IO-Link Device Events. type: number mode: description: >- IO-Link Port Event Mode or IO-Link Device EventMode. This property is mandatory for IO-Link Port Events or IO-Link Device Events. type: string enum: - SINGLESHOT - APPEARS - DISAPPEARS text: type: string gatewayEventsGet: type: array items: type: object required: - time - severity - origin - message properties: time: $ref: '#/components/schemas/eventTime' severity: $ref: '#/components/schemas/eventSeverity' origin: $ref: '#/components/schemas/eventOriginObject' message: $ref: '#/components/schemas/eventObject' blockParameterizationPostParametersRequest: type: array items: type: object required: - identifier properties: identifier: oneOf: - type: object required: - index properties: index: type: number subIndex: type: number - type: object required: - parameterName properties: parameterName: type: string subParameterName: type: string content: $ref: '#/components/schemas/deviceParameterValueGetPost' deviceBlockParameterizationPostParametersAnswer: type: array items: type: object required: - identifier - result properties: identifier: oneOf: - type: object required: - index properties: index: type: number subIndex: type: number - type: object required: - parameterName properties: parameterName: type: string subParameterName: type: string result: type: object required: - parameterExchangeResult properties: parameterExchangeResult: type: string enum: - WRITE_SUCCESS - READ_SUCCESS - ERROR content: $ref: '#/components/schemas/deviceParameterValueGetPost' iolinkError: $ref: '#/components/schemas/iolinkErrorObject' deviceEventsGet: type: array items: type: object required: - time - severity - origin - message properties: time: $ref: '#/components/schemas/eventTime' severity: $ref: '#/components/schemas/eventSeverity' origin: required: - master - port - deviceAlias allOf: - $ref: '#/components/schemas/eventOriginObject' message: required: - code - mode allOf: - $ref: '#/components/schemas/eventObject' example: - time: '2018-05-18T07:31:54.123Z' severity: WARNING origin: master: 1 port: 1 deviceAlias: Temperature_sensor_1 message: code: 16912 mode: APPEARS text: Device temperature over-run - Clear source of heat gatewayIdentificationGet: type: object required: - macAddress - vendorName properties: macAddress: type: string serialNumber: type: string productId: type: string vendorName: type: string productName: type: string hardwareRevision: type: string firmwareRevision: type: string productInstanceUri: type: string example: macAddress: '00:02:72:CE:A6:49' serialNumber: 'C134A746' productId: 'TMP34Z' vendorName: 'SensorCompany' productName: 'FlowSensor34' hardwareRevision: 'V3.45' firmwareRevision: 'V1.30' productInstanceUri: 'sensor.tmp.23.com' gatewayConfigurationGetPost: type: object required: - ethIpv4 properties: ethIpv4: type: array items: type: object required: - ipConfiguration properties: ipConfiguration: $ref: '#/components/schemas/ipConfiguration' ipAddress: type: string subnetMask: type: string standardGateway: type: string example: ethIpv4: - ipConfiguration: MANUAL ipAddress: 192.168.1.13 subnetMask: 255.255.255.0 standardGateway: 192.168.1.1 mqttConfigurationGetPost: type: object required: - clientMode properties: clientMode: type: string serverAddress: type: string username: type: string password: type: string lastWill: type: object required: - topic - message - qos - retain properties: topic: type: string message: type: string qos: type: string enum: - 0_ONLY_ONCE - 1_AT_LEAST_ONCE - 2_EXACTLY_ONCE retain: type: boolean keepAliveTime: type: integer mqttConfigurationTopic: allOf: - type: object required: - qos - deviceAlias properties: qos: type: string enum: - 0_ONLY_ONCE - 1_AT_LEAST_ONCE - 2_EXACTLY_ONCE deviceAlias: type: string description: Unique deviceAlias. - oneOf: - type: object properties: event: $ref: '#/components/schemas/event' processData: $ref: '#/components/schemas/processData' mqttConfigurationTopicPost: allOf: - type: object properties: topicName: type: string - $ref: '#/components/schemas/mqttConfigurationTopic' mqttConfigurationTopicGet: allOf: - type: object required: - topicId properties: topicId: type: integer - type: object required: - topicName properties: topicName: type: string - $ref: '#/components/schemas/mqttConfigurationTopic' example: topicId: 1 topicName: PD input qos: 1_AT_LEAST_ONCE deviceAlias: DT35 processData: direction: getData format: iodd interval: value: 10 unit: ms mqttConnectionStatusGet: allOf: - type: object required: - connectionStatus - serverAddress - upTime properties: connectionStatus: type: string enum: - CLIENT_INACTIVE - CONNECTION_ACCEPTED - UNACCEPTABLE_PROTOCOL_VERSION - IDENTIFIER_REJECTED - SERVER_UNAVAILABLE - BAD_USERNAME_OR_PASSWORD - NOT_AUTHORIZED serverAddress: type: string upTime: type: integer example: connectionStatus: CONNECTION_ACCEPTED serverAddress: 'http://broker-address.com' upTime: 1050 portStatusGet: type: object required: - statusInfo properties: statusInfo: type: string enum: - COMMUNICATION_LOST - DEACTIVATED - INCORRECT_DEVICE - DEVICE_STARTING - DEVICE_ONLINE - DIGITAL_INPUT_C/Q - DIGITAL_OUTPUT_C/Q - NOT_AVAILABLE ioLinkRevision: description: >- Mandatory if the portStatusInfo is INCORRECT_DEVICE, PREOPERATE or OPERATE. type: string enum: - '1.0' - '1.1' transmissionRate: description: >- Mandatory if the portStatusInfo is INCORRECT_DEVICE, PREOPERATE or OPERATE. type: string enum: - COM1 - COM2 - COM3 masterCycleTime: description: >- Mandatory if the portStatusInfo is INCORRECT_DEVICE, PREOPERATE or OPERATE. type: object allOf: - $ref: '#/components/schemas/cycleTime' example: statusInfo: DEVICE_ONLINE ioLinkRevision: '1.1' transmissionRate: COM2 masterCycleTime: value: 2.3 unit: ms deviceCapabilitiesGet: required: - minimumCycleTime - supportedProfiles type: object properties: minimumCycleTime: $ref: '#/components/schemas/cycleTime' supportedProfiles: type: array items: type: integer deviceIdentificationGet: required: - vendorId - deviceId - ioLinkRevision type: object properties: vendorId: type: integer minimum: 1 maximum: 65535 deviceId: type: integer minimum: 1 maximum: 16777215 ioLinkRevision: type: string enum: - '1.0' - '1.1' vendorName: description: Mandatory if the Device suports the ISDU. type: string vendorText: type: string productName: description: Mandatory if the Device suports the ISDU. type: string productId: type: string productText: type: string serialNumber: type: string hardwareRevision: type: string firmwareRevision: type: string applicationSpecificTag: type: string locationTag: type: string functionTag: type: string example: vendorId: 26 deviceId: 42 ioLinkRevision: '1.1' vendorName: SICK AG vendorText: Sensor Intelligence. productName: WTxx16 productId: PROD-123456 productText: Light switch serialNumber: IOLM123456 hardwareRevision: 3.2.1.444R firmwareRevision: 3.2.1.888R applicationSpecificTag: Fallback light switch at the end of the belt locationTag: Down under functionTag: Check end of belt portIdentificationPost: type: object properties: applicationSpecificTag: type: string example: Fallback light switch at the end of the belt locationTag: type: string example: Down under functionTag: type: string example: Check start of belt portCapabilitiesGet: type: object required: - maxPowerSupply - portType properties: maxPowerSupply: type: object required: - value - unit properties: value: type: number unit: type: string portType: type: string enum: - CLASS_A - CLASS_B - CLASS_A_WITH_PORT_POWER_OFF_ON - FAILSAFE_PORT_A_WITHOUT_SAFETY_DIGITAL_INPUTS - FAILSAFE_PORT_A_WITH_SAFETY_DIGITAL_INPUTS - FAILSAFE_PORT_B - WIRELESS_MASTER example: maxPowerSupply: value: 0.3 unit: A portType: CLASS_A iqConfigurationType: type: string enum: - NOT_SUPPORTED - DIGITAL_INPUT - DIGITAL_OUTPUT - POWER_2 portConfigurationGet: type: object required: - mode - iqConfiguration - deviceAlias properties: mode: type: string enum: - DEACTIVATED - IOLINK_MANUAL - IOLINK_AUTOSTART - DIGITAL_INPUT - DIGITAL_OUTPUT validationAndBackup: description: Used by the IO-Link Master just when the port's mode is IOLINK_MANUAL. type: string enum: - NO_DEVICE_CHECK - TYPE_COMPATIBLE_DEVICE_V1.0 - TYPE_COMPATIBLE_DEVICE_V1.1 - TYPE_COMPATIBLE_DEVICE_V1.1_BACKUP_AND_RESTORE - TYPE_COMPATIBLE_DEVICE_V1.1_RESTORE cycleTime: description: >- Used by the IO-Link Master just when the port's mode is IOLINK_MANUAL or IOLINK_AUTOSTART. Default value is 0 ms which means as fast as possible. type: object allOf: - $ref: '#/components/schemas/cycleTime' vendorId: description: >- Used by the IO-Link Master just when the port's mode is IOLINK_MANUAL and validationAndBackup is not NO_DEVICE_CHECK. type: integer minimum: 1 maximum: 65535 deviceId: description: >- Used by the IO-Link Master just when the port's mode is IOLINK_MANUAL and validationAndBackup is not NO_DEVICE_CHECK. type: integer minimum: 1 maximum: 16777215 iqConfiguration: $ref : '#/components/schemas/iqConfigurationType' deviceAlias: type: string example: mode: IOLINK_MANUAL validationAndBackup: TYPE_COMPATIBLE_DEVICE_V1.1 iqConfiguration: DIGITAL_INPUT cycleTime: value: 2.3 unit: ms vendorId: 26 deviceId: 333 deviceAlias: Distance_sensor_1 portConfigurationPost: type: object properties: mode: type: string enum: - DEACTIVATED - IOLINK_MANUAL - IOLINK_AUTOSTART - DIGITAL_INPUT - DIGITAL_OUTPUT validationAndBackup: description: >- Mandatory if the port's mode is IOLINK_MANUAL. Must not be used with mode other than IOL_MANUAL. type: string enum: - NO_DEVICE_CHECK - TYPE_COMPATIBLE_DEVICE_V1.0 - TYPE_COMPATIBLE_DEVICE_V1.1 - TYPE_COMPATIBLE_DEVICE_V1.1_BACKUP_AND_RESTORE - TYPE_COMPATIBLE_DEVICE_V1.1_RESTORE cycleTime: description: >- If no cycleTime configured with mode IOLINK_MANUAL or IOLINK_AUTOSTART, the possible fastest cycle time is used by the IO-Link Master. type: object allOf: - $ref: '#/components/schemas/cycleTime' vendorId: description: >- Mandatory if the port's mode is IOLINK_MANUAL and validationAndBackup is not NO_DEVICE_CHECK. type: integer minimum: 1 maximum: 65535 deviceId: description: >- Mandatory if the port's mode is IOLINK_MANUAL and validationAndBackup is not NO_DEVICE_CHECK. type: integer minimum: 1 maximum: 16777215 iqConfiguration: $ref : '#/components/schemas/iqConfigurationType' deviceAlias: type: string dataStorageGetPost: description: >- In case the Data Storage is empty, the header object is empty and the content is an empty string. type: object required: - header - content properties: header: oneOf: - type: object required: - vendorId - deviceId - ioLinkRevision properties: vendorId: type: integer minimum: 1 maximum: 65535 deviceId: type: integer minimum: 1 maximum: 16777215 ioLinkRevision: type: string enum: ['1.0', '1.1'] - type: object # empty object additionalProperties: false minProperties: 0 maxProperties: 0 content: description: Base64 coded DS data Ojects. Max size = 2KB*1.33. type: string processDataValue: type: object properties: ioLink: type: object description: > Process data in IO-Link mode required: - valid - value properties: valid: type: boolean description: > Process data validity value: oneOf: - $ref: '#/components/schemas/deviceByteArrayTypeValue' - $ref: '#/components/schemas/deviceSimpleTypeValue' - $ref: '#/components/schemas/deviceComplexTypeValue' description: > Process data value cqValue: type: boolean description: > IO-Link cable CQ (pin4) level if it is used as digital input or output (SIO mode). (false - 0 V, true - 24 V) iqValue: type: boolean description: > IO-Link cable IQ (pin2) level if it is used as digital input or output. (false - 0 V, true - 24 V) example: 'format=byteArray, pin4=IO-Link, pin2=sio': ioLink: valid: true value: - 15 - 123 - 126 - 236 iqValue: true 'format=iodd, pin4=IO-Link, pin2=deactivated/not available': iolink: valid: true value: Valve_1: value: true Valve_2: value: false 'format=byteArray/iodd, pin4=sio, pin2=deactivated/not available': cqValue: false deviceProcessDataValueGet: type: object description: > The cqValue is present in the 'getData' object if the CQ (pin4) is configured as digital input. The cqValue is present in the 'setData' object if the CQ (pin4) is configured as digital output. The ioLink is present either in the 'getData' or 'setData' or both objects if the CQ (pin4) is configured to IO-Link mode. The iqValue is present in the 'getData' object if the IQ (pin2) is configured as digital input. The iqValue is present in the 'setData' object if the IQ (pin4) is configured as digital output. properties: getData: $ref: '#/components/schemas/processDataValue' setData: $ref: '#/components/schemas/processDataValue' deviceProcessDataValuePost: $ref: '#/components/schemas/processDataValue' deviceByteArrayTypeValue: type: array description: The value in byteArray format. items: type: number minimum: 0 maximum: 255 deviceSimpleTypeValue: type: object properties: value: oneOf: - type: boolean - type: string - type: number description: The value (with simple type) in iodd format. required: - value deviceComplexTypeValue: type: object minProperties: 1 maxProperties: 255 description: The value (with complex type) in iodd format. additionalProperties: $ref: '#/components/schemas/deviceSimpleTypeValue' deviceParametersGet: type: array items: type: object required: - index - parameterName properties: index: type: number parameterName: type: string example: - index: 0 parameterName: Direct_Parameter_Page_1 - index: 1 parameterName: Direct_Parameter_Page_2 - index: 2 parameterName: System_Command deviceSubParametersGet: type: array items: type: object required: - subIndex - subParameterName properties: subIndex: type: number subParameterName: type: string example: - subIndex: 1 subParameterName: Master_command - subIndex: 2 subParameterName: Master_cycle_time - subIndex: 3 subParameterName: Minimum_cycle_time deviceParameterValueGetPost: oneOf: - $ref: '#/components/schemas/deviceByteArrayTypeValue' - $ref: '#/components/schemas/deviceSimpleTypeValue' - $ref: '#/components/schemas/deviceComplexTypeValue' deviceParameterSubindexValueGetPost: oneOf: - $ref: '#/components/schemas/deviceByteArrayTypeValue' - $ref: '#/components/schemas/deviceSimpleTypeValue' deviceBlockParameterizationPost: type: object required: - direction - parameters properties: direction: type: string enum: - WRITE - READ parameters: $ref: '#/components/schemas/blockParameterizationPostParametersRequest' ioddIdentification: type: object required: - vendorId - deviceId - version - releaseDate - ioLinkRevision properties: vendorId: type: number deviceId: type: number version: type: string releaseDate: type: string ioLinkRevision: type: string enum: - '1.0' - '1.1' ioddFile: description: The IODD XML file. type: string format: binary ioddsGet: type: array items: $ref: '#/components/schemas/ioddIdentification' example: - vendorId: 1234 deviceId: 4567 version: '4.3' releaseDate: '2018-01-02' ioLinkRevision: '1.1' - vendorId: 4321 deviceId: 8765 version: '2.1' releaseDate: '2015-01-02' ioLinkRevision: '1.1' iolinkErrorObject: type: object required: - code - message properties: code: type: integer message: type: string errorObject: type: object required: - code - message properties: code: type: integer message: type: string iolinkError: $ref: '#/components/schemas/iolinkErrorObject' parameters: vendorId: name: vendorId in: query description: IO-Link VendorID required: false schema: type: integer deviceId: name: deviceId in: query description: IO-Link DeviceID required: false schema: type: integer revision: name: revision in: query description: IO-Link Revision required: false schema: type: string enum: - '1.0' - '1.1' mqttTopicId: name: topicId in: path description: >- ID of a configured MQTT topic. This the position of the topic in the topics list. required: true schema: type: integer masterNumber: name: masterNumber in: path description: Master identification number starting with 1 schema: type: integer minimum: 1 required: true portNumber: name: portNumber in: path description: Port identification number starting with 1 schema: type: integer minimum: 1 required: true deviceAlias: name: deviceAlias in: path description: >- Device Name configured with the port/configuration URL. Default Device Name is 'masterNportM' where 'N' means the masterNumber and 'M' means the portNumber. schema: type: string required: true eventOrigin: name: origin in: query description: The event source to filter schema: $ref: '#/components/schemas/eventOrigin' eventMasterNumber: name: masterNumber in: query description: masterNumber is only applicable with origin=MASTERS and origin=PORTS schema: $ref: '#/components/schemas/eventMasterNumber' eventPortNumber: name: portNumber in: query description: portnumber is only applicable with origin=PORTS schema: $ref: '#/components/schemas/eventPortNumber' eventdeviceAlias: name: deviceAlias in: query description: deviceAlias is only applicable with origin=DEVICES schema: $ref: '#/components/schemas/eventdeviceAlias' eventTop: name: top in: query description: >- Delivers the oldest n events of the event buffer. top is mutually exclusive to bottom. schema: $ref: '#/components/schemas/eventTop' eventBottom: name: bottom in: query description: >- Delivers the youngest n events of the event buffer. bottom is mutually exclusive to top. schema: $ref: '#/components/schemas/eventBottom' format: name: format in: query description: Value format in response document schema: $ref: '#/components/schemas/format' index: name: index in: path description: Index of ISDU variable schema: type: integer required: true subindex: name: subindex in: path description: Subindex of ISDU variable with the given index schema: type: integer required: true parameterName: name: parameterName in: path description: >- Parameter name. Comes from the IODD but might be reformatted according to the JSON mapping specification. schema: type: string required: true subParameterName: name: subParameterName in: path description: >- Sub-parameter name. Comes from the IODD but might be reformatted according to the JSON mapping specification. schema: type: string required: true