Swagger UI

External Devices Management
 3.13.0.RELEASE 

[ Base URL: localhost:2002/externaldevices ]

IMPORTANT - The Try it Out button will generate curl requests for examples, but executing them through the UI will not work as authentication has not been set up. This page is for documentation only.

Send email to the developer
Mozilla Public License V2.0

notification

Passing of notifications to be handled by the external-devices service

Parameters

NameDescription
notification
object
(body)

Notification to be passed on to an external device

{
  "opfabSignalId": "ALARM"
}

Responses

CodeDescription
200

OK sound was triggered on external device

400

Bad request - notification could not be handled (bad notification object,no external device configured for user, etc.)

401

Authentication required

404

Could not send notification to device because it has no known driver

device

Live device management (connection, etc.)

Parameters

No parameters

Responses

CodeDescription
200

OK

[
  {
    "id": "CDS_1",
    "resolvedAddress": "123.45.67.89",
    "port": 4300,
    "isConnected": true
  }
]

Fetch device with given deviceId

Parameters

NameDescription
deviceId *
string
(path)

device Id

Responses

CodeDescription
200

OK

{
  "id": "CDS_1",
  "resolvedAddress": "123.45.67.89",
  "port": 4300,
  "isConnected": true
}
404

Required device not found

Parameters

NameDescription
deviceId *
string
(path)

the id of the device configuration to enable

Responses

CodeDescription
200

OK Device was enabled

401

Authentication required

403

Forbidden - ADMIN role necessary

404

Required device not found

Parameters

NameDescription
deviceId *
string
(path)

the id of the device configuration to disable

Responses

CodeDescription
200

OK Device was disabled

401

Authentication required

403

Forbidden - ADMIN role necessary

404

Required device not found

deviceConfiguration

Management of device configurations

Parameters

NameDescription
deviceConfiguration
object
(body)

Device configuration to be created

{
  "id": "CDS_1",
  "host": "localhost",
  "port": 4300,
  "signalMappingId": "default_CDS_mapping",
  "isEnabled": true
}

Responses

CodeDescription
201

OK Device configuration was created

400

Bad request (wrong configuration data, duplicate, etc.)

401

Authentication required

403

Forbidden - ADMIN role necessary

Parameters

No parameters

Responses

CodeDescription
200

OK

[
  {
    "id": "CDS_1",
    "host": "localhost",
    "port": 4300,
    "signalMappingId": "default_CDS_mapping",
    "isEnabled": true
  }
]
401

Authentication required

403

Forbidden - ADMIN role necessary

Parameters

NameDescription
deviceId *
string
(path)

id of the device configuration

Responses

CodeDescription
200

OK

{
  "id": "CDS_1",
  "host": "localhost",
  "port": 4300,
  "signalMappingId": "default_CDS_mapping",
  "isEnabled": true
}
401

Authentication required

403

Forbidden - ADMIN role necessary

404

Device configuration not found

Parameters

NameDescription
deviceId *
string
(path)

id of the device configuration to be deleted

Responses

CodeDescription
200

OK Device configuration was deleted

401

Authentication required

403

Forbidden - ADMIN role necessary

404

Device configuration not found

signalMapping

Management of signal mappings

Parameters

NameDescription
signalMapping
object
(body)

Signal mapping to be created

{
  "id": "default_CDS_mapping",
  "supportedSignals": {
    "ALARM": 1,
    "ACTION": 2,
    "COMPLIANT": 3,
    "INFORMATION": 4
  }
}

Responses

CodeDescription
201

OK Signal mapping was created

401

Authentication required

Parameters

No parameters

Responses

CodeDescription
200

OK

[
  {
    "id": "default_CDS_mapping",
    "supportedSignals": {
      "ALARM": 1,
      "ACTION": 2,
      "COMPLIANT": 3,
      "INFORMATION": 4
    }
  }
]
401

Authentication required

403

Forbidden - ADMIN role necessary

Parameters

NameDescription
signalMappingId *
string
(path)

id of the signal mapping

Responses

CodeDescription
200

OK

{
  "id": "default_CDS_mapping",
  "supportedSignals": {
    "ALARM": 1,
    "ACTION": 2,
    "COMPLIANT": 3,
    "INFORMATION": 4
  }
}
401

Authentication required

403

Forbidden - ADMIN role necessary

404

Signal mapping not found

Parameters

NameDescription
signalMappingId *
string
(path)

id of the signal mapping to be deleted

Responses

CodeDescription
200

OK Signal mapping was deleted

401

Authentication required

403

Forbidden - ADMIN role necessary

404

Signal mapping not found

userConfiguration

Management of user configurations

Parameters

NameDescription
userConfiguration
object
(body)

User configuration to be created

{
  "userLogin": "operator1_fr",
  "externalDeviceIds": [
    "CDS_1",
    "CDS_2"
  ]
}

Responses

CodeDescription
201

OK User configuration was created

401

Authentication required

Parameters

No parameters

Responses

CodeDescription
200

OK

[
  {
    "userLogin": "operator1_fr",
    "externalDeviceIds": [
      "CDS_1",
      "CDS_2"
    ]
  }
]
401

Authentication required

403

Forbidden - ADMIN role necessary

Parameters

NameDescription
userLogin *
string
(path)

login of the user

Responses

CodeDescription
200

OK

{
  "userLogin": "operator1_fr",
  "externalDeviceIds": [
    "CDS_1",
    "CDS_2"
  ]
}
401

Authentication required

403

Forbidden - ADMIN role necessary

404

User configuration not found

Parameters

NameDescription
userLogin *
string
(path)

login of the user whose configuration should be deleted

Responses

CodeDescription
200

OK user configuration was deleted

401

Authentication required

403

Forbidden - ADMIN role necessary

404

User configuration not found