Modbus Template Controller

get
Authorizations
Path parameters
deviceIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/modbus/templates/devices/{deviceId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
  "creationDate": "2025-07-05T19:24:32.798Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:24:32.798Z",
  "id": "text",
  "properties": "text",
  "dsc": "text",
  "name": "text",
  "scanTime": 1,
  "retainFlag": true,
  "stationAddress": 1,
  "scanType": "Periodic"
}
put
Authorizations
Path parameters
deviceIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
propertiesstringOptional
dscstring · max: 255Optional
namestring · max: 100Required
scanTimeinteger · int32 · min: 1Required
retainFlagbooleanOptional
stationAddressinteger · int32Required
scanTypestring · enumRequiredPossible values:
Responses
204
No Content
put
PUT /api/protocols/modbus/templates/devices/{deviceId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "id": "text",
  "properties": "text",
  "dsc": "text",
  "name": "text",
  "scanTime": 1,
  "retainFlag": true,
  "stationAddress": 1,
  "scanType": "Periodic"
}

No content

delete
Authorizations
Path parameters
deviceIdstringRequired
Responses
204
No Content
delete
DELETE /api/protocols/modbus/templates/devices/{deviceId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content

get
Authorizations
Path parameters
deviceIdstringRequired
frameIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/modbus/templates/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
  "creationDate": "2025-07-05T19:24:32.798Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:24:32.798Z",
  "id": "text",
  "deviceId": "text",
  "dsc": "text",
  "scanTimeFactor": 1,
  "name": "text",
  "isWritable": true,
  "isReadable": true,
  "minutesOffset": 1,
  "quantity": 1,
  "type": "Coil",
  "interFrameDelay": 1,
  "startAddress": 1
}
put
Authorizations
Path parameters
deviceIdstringRequired
frameIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
deviceIdstringOptional
dscstring · max: 255Optional
scanTimeFactorinteger · int32Optional
namestring · max: 100Required
isWritablebooleanRequired
isReadablebooleanRequired
minutesOffsetinteger · int32Optional
quantityinteger · int32 · min: 1Required
typestring · enumRequiredPossible values:
interFrameDelayinteger · int32Optional
startAddressinteger · int32Required
Responses
204
No Content
put
PUT /api/protocols/modbus/templates/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "id": "text",
  "deviceId": "text",
  "dsc": "text",
  "scanTimeFactor": 1,
  "name": "text",
  "isWritable": true,
  "isReadable": true,
  "minutesOffset": 1,
  "quantity": 1,
  "type": "Coil",
  "interFrameDelay": 1,
  "startAddress": 1
}

No content

delete
Authorizations
Path parameters
deviceIdstringRequired
frameIdstringRequired
Responses
204
No Content
delete
DELETE /api/protocols/modbus/templates/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content

get
Authorizations
Path parameters
deviceIdstringRequired
frameIdstringRequired
variableIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/modbus/templates/devices/{deviceId}/frames/{frameId}/variables/{variableId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
  "creationDate": "2025-07-05T19:24:32.798Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:24:32.798Z",
  "id": "text",
  "engFullScale": 1,
  "logMaxValue": 1,
  "fractionalDigitCount": 1,
  "isPulseOn": true,
  "logExpressionCode": "text",
  "frameId": "text",
  "valueExpressionType": "NONE",
  "logMinValue": 1,
  "rawZeroScale": 1,
  "valueExpressionCode": "text",
  "isActive": true,
  "code": "text",
  "valueExpressionId": "text",
  "setMaxValue": 1,
  "logType": "No Log",
  "setMinValue": 1,
  "keepLastValues": true,
  "logThreshold": 1,
  "isPulseOff": true,
  "logPeriod": 1,
  "pulseOffDuration": 1,
  "pulseOnDuration": 1,
  "engZeroScale": 1,
  "dsc": "text",
  "unit": "text",
  "logExpressionId": "text",
  "rawFullScale": 1,
  "name": "text",
  "type": "Float",
  "startAddress": 1,
  "length": 1,
  "wordSwapFlag": true,
  "bitOffset": 1,
  "byteSwapFlag": true,
  "deviceId": "text"
}
put
Authorizations
Path parameters
deviceIdstringRequired
frameIdstringRequired
variableIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
engFullScalenumber · doubleOptional
logMaxValuenumber · doubleOptional
fractionalDigitCountinteger · int32Optional
isPulseOnbooleanRequired
logExpressionCodestring · max: 4000Optional
frameIdstringOptional
valueExpressionTypestring · enumOptionalPossible values:
logMinValuenumber · doubleOptional
rawZeroScalenumber · doubleOptional
valueExpressionCodestring · max: 4000Optional
isActivebooleanRequired
codestring · max: 20Optional
valueExpressionIdstringOptional
setMaxValuenumber · doubleOptional
logTypestring · enumOptionalPossible values:
setMinValuenumber · doubleOptional
keepLastValuesbooleanRequired
logThresholdnumber · doubleOptional
isPulseOffbooleanRequired
logPeriodinteger · int32 · min: 1Optional
pulseOffDurationinteger · int32Optional
pulseOnDurationinteger · int32Optional
engZeroScalenumber · doubleOptional
dscstring · max: 255Optional
unitstringOptional
logExpressionIdstringOptional
rawFullScalenumber · doubleOptional
namestring · max: 100Required
typestring · enumRequiredPossible values:
startAddressinteger · int32Required
lengthinteger · int32 · max: 246Optional
wordSwapFlagbooleanOptional
bitOffsetinteger · int32 · max: 15Optional
byteSwapFlagbooleanOptional
deviceIdstringOptional
Responses
204
No Content
put
PUT /api/protocols/modbus/templates/devices/{deviceId}/frames/{frameId}/variables/{variableId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 658

{
  "id": "text",
  "engFullScale": 1,
  "logMaxValue": 1,
  "fractionalDigitCount": 1,
  "isPulseOn": true,
  "logExpressionCode": "text",
  "frameId": "text",
  "valueExpressionType": "NONE",
  "logMinValue": 1,
  "rawZeroScale": 1,
  "valueExpressionCode": "text",
  "isActive": true,
  "code": "text",
  "valueExpressionId": "text",
  "setMaxValue": 1,
  "logType": "No Log",
  "setMinValue": 1,
  "keepLastValues": true,
  "logThreshold": 1,
  "isPulseOff": true,
  "logPeriod": 1,
  "pulseOffDuration": 1,
  "pulseOnDuration": 1,
  "engZeroScale": 1,
  "dsc": "text",
  "unit": "text",
  "logExpressionId": "text",
  "rawFullScale": 1,
  "name": "text",
  "type": "Float",
  "startAddress": 1,
  "length": 1,
  "wordSwapFlag": true,
  "bitOffset": 1,
  "byteSwapFlag": true,
  "deviceId": "text"
}

No content

delete
Authorizations
Path parameters
deviceIdstringRequired
frameIdstringRequired
variableIdstringRequired
Responses
204
No Content
delete
DELETE /api/protocols/modbus/templates/devices/{deviceId}/frames/{frameId}/variables/{variableId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content

get
Authorizations
Responses
200
OK
*/*
get
GET /api/protocols/modbus/templates/devices HTTP/1.1
Host: inscada.cloud
Accept: */*
[
  {
    "creationDate": "2025-07-05T19:24:32.798Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T19:24:32.798Z",
    "id": "text",
    "properties": "text",
    "dsc": "text",
    "name": "text",
    "scanTime": 1,
    "retainFlag": true,
    "stationAddress": 1,
    "scanType": "Periodic"
  }
]
post
Authorizations
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
propertiesstringOptional
dscstring · max: 255Optional
namestring · max: 100Required
scanTimeinteger · int32 · min: 1Required
retainFlagbooleanOptional
stationAddressinteger · int32Required
scanTypestring · enumRequiredPossible values:
Responses
200
OK
*/*
post
POST /api/protocols/modbus/templates/devices HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "id": "text",
  "properties": "text",
  "dsc": "text",
  "name": "text",
  "scanTime": 1,
  "retainFlag": true,
  "stationAddress": 1,
  "scanType": "Periodic"
}
{
  "creationDate": "2025-07-05T19:24:32.798Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:24:32.798Z",
  "id": "text",
  "properties": "text",
  "dsc": "text",
  "name": "text",
  "scanTime": 1,
  "retainFlag": true,
  "stationAddress": 1,
  "scanType": "Periodic"
}
get
Authorizations
Path parameters
deviceIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/modbus/templates/devices/{deviceId}/frames HTTP/1.1
Host: inscada.cloud
Accept: */*
[
  {
    "creationDate": "2025-07-05T19:24:32.798Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T19:24:32.798Z",
    "id": "text",
    "deviceId": "text",
    "dsc": "text",
    "scanTimeFactor": 1,
    "name": "text",
    "isWritable": true,
    "isReadable": true,
    "minutesOffset": 1,
    "quantity": 1,
    "type": "Coil",
    "interFrameDelay": 1,
    "startAddress": 1
  }
]
post
Authorizations
Path parameters
deviceIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
deviceIdstringOptional
dscstring · max: 255Optional
scanTimeFactorinteger · int32Optional
namestring · max: 100Required
isWritablebooleanRequired
isReadablebooleanRequired
minutesOffsetinteger · int32Optional
quantityinteger · int32 · min: 1Required
typestring · enumRequiredPossible values:
interFrameDelayinteger · int32Optional
startAddressinteger · int32Required
Responses
200
OK
*/*
post
POST /api/protocols/modbus/templates/devices/{deviceId}/frames HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "id": "text",
  "deviceId": "text",
  "dsc": "text",
  "scanTimeFactor": 1,
  "name": "text",
  "isWritable": true,
  "isReadable": true,
  "minutesOffset": 1,
  "quantity": 1,
  "type": "Coil",
  "interFrameDelay": 1,
  "startAddress": 1
}
{
  "creationDate": "2025-07-05T19:24:32.798Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:24:32.798Z",
  "id": "text",
  "deviceId": "text",
  "dsc": "text",
  "scanTimeFactor": 1,
  "name": "text",
  "isWritable": true,
  "isReadable": true,
  "minutesOffset": 1,
  "quantity": 1,
  "type": "Coil",
  "interFrameDelay": 1,
  "startAddress": 1
}
get
Authorizations
Path parameters
deviceIdstringRequired
frameIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/modbus/templates/devices/{deviceId}/frames/{frameId}/variables HTTP/1.1
Host: inscada.cloud
Accept: */*
[
  {
    "creationDate": "2025-07-05T19:24:32.798Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T19:24:32.798Z",
    "id": "text",
    "engFullScale": 1,
    "logMaxValue": 1,
    "fractionalDigitCount": 1,
    "isPulseOn": true,
    "logExpressionCode": "text",
    "frameId": "text",
    "valueExpressionType": "NONE",
    "logMinValue": 1,
    "rawZeroScale": 1,
    "valueExpressionCode": "text",
    "isActive": true,
    "code": "text",
    "valueExpressionId": "text",
    "setMaxValue": 1,
    "logType": "No Log",
    "setMinValue": 1,
    "keepLastValues": true,
    "logThreshold": 1,
    "isPulseOff": true,
    "logPeriod": 1,
    "pulseOffDuration": 1,
    "pulseOnDuration": 1,
    "engZeroScale": 1,
    "dsc": "text",
    "unit": "text",
    "logExpressionId": "text",
    "rawFullScale": 1,
    "name": "text",
    "type": "Float",
    "startAddress": 1,
    "length": 1,
    "wordSwapFlag": true,
    "bitOffset": 1,
    "byteSwapFlag": true,
    "deviceId": "text"
  }
]
post
Authorizations
Path parameters
deviceIdstringRequired
frameIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
engFullScalenumber · doubleOptional
logMaxValuenumber · doubleOptional
fractionalDigitCountinteger · int32Optional
isPulseOnbooleanRequired
logExpressionCodestring · max: 4000Optional
frameIdstringOptional
valueExpressionTypestring · enumOptionalPossible values:
logMinValuenumber · doubleOptional
rawZeroScalenumber · doubleOptional
valueExpressionCodestring · max: 4000Optional
isActivebooleanRequired
codestring · max: 20Optional
valueExpressionIdstringOptional
setMaxValuenumber · doubleOptional
logTypestring · enumOptionalPossible values:
setMinValuenumber · doubleOptional
keepLastValuesbooleanRequired
logThresholdnumber · doubleOptional
isPulseOffbooleanRequired
logPeriodinteger · int32 · min: 1Optional
pulseOffDurationinteger · int32Optional
pulseOnDurationinteger · int32Optional
engZeroScalenumber · doubleOptional
dscstring · max: 255Optional
unitstringOptional
logExpressionIdstringOptional
rawFullScalenumber · doubleOptional
namestring · max: 100Required
typestring · enumRequiredPossible values:
startAddressinteger · int32Required
lengthinteger · int32 · max: 246Optional
wordSwapFlagbooleanOptional
bitOffsetinteger · int32 · max: 15Optional
byteSwapFlagbooleanOptional
deviceIdstringOptional
Responses
200
OK
*/*
post
POST /api/protocols/modbus/templates/devices/{deviceId}/frames/{frameId}/variables HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 658

{
  "id": "text",
  "engFullScale": 1,
  "logMaxValue": 1,
  "fractionalDigitCount": 1,
  "isPulseOn": true,
  "logExpressionCode": "text",
  "frameId": "text",
  "valueExpressionType": "NONE",
  "logMinValue": 1,
  "rawZeroScale": 1,
  "valueExpressionCode": "text",
  "isActive": true,
  "code": "text",
  "valueExpressionId": "text",
  "setMaxValue": 1,
  "logType": "No Log",
  "setMinValue": 1,
  "keepLastValues": true,
  "logThreshold": 1,
  "isPulseOff": true,
  "logPeriod": 1,
  "pulseOffDuration": 1,
  "pulseOnDuration": 1,
  "engZeroScale": 1,
  "dsc": "text",
  "unit": "text",
  "logExpressionId": "text",
  "rawFullScale": 1,
  "name": "text",
  "type": "Float",
  "startAddress": 1,
  "length": 1,
  "wordSwapFlag": true,
  "bitOffset": 1,
  "byteSwapFlag": true,
  "deviceId": "text"
}
{
  "creationDate": "2025-07-05T19:24:32.798Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:24:32.798Z",
  "id": "text",
  "engFullScale": 1,
  "logMaxValue": 1,
  "fractionalDigitCount": 1,
  "isPulseOn": true,
  "logExpressionCode": "text",
  "frameId": "text",
  "valueExpressionType": "NONE",
  "logMinValue": 1,
  "rawZeroScale": 1,
  "valueExpressionCode": "text",
  "isActive": true,
  "code": "text",
  "valueExpressionId": "text",
  "setMaxValue": 1,
  "logType": "No Log",
  "setMinValue": 1,
  "keepLastValues": true,
  "logThreshold": 1,
  "isPulseOff": true,
  "logPeriod": 1,
  "pulseOffDuration": 1,
  "pulseOnDuration": 1,
  "engZeroScale": 1,
  "dsc": "text",
  "unit": "text",
  "logExpressionId": "text",
  "rawFullScale": 1,
  "name": "text",
  "type": "Float",
  "startAddress": 1,
  "length": 1,
  "wordSwapFlag": true,
  "bitOffset": 1,
  "byteSwapFlag": true,
  "deviceId": "text"
}