S 7 Template Controller
get
Authorizations
Path parameters
deviceIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/s7/templates/devices/{deviceId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
"creationDate": "2025-07-05T20:11:07.613Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T20:11:07.613Z",
"id": "text",
"properties": "text",
"dsc": "text",
"name": "text",
"scanType": "Periodic",
"scanTime": 1
}
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
scanTypestring · enumRequiredPossible values:
scanTimeinteger · int32 · min: 1Required
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
put
PUT /api/protocols/s7/templates/devices/{deviceId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 95
{
"id": "text",
"properties": "text",
"dsc": "text",
"name": "text",
"scanType": "Periodic",
"scanTime": 1
}
No content
delete
Authorizations
Path parameters
deviceIdstringRequired
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
delete
DELETE /api/protocols/s7/templates/devices/{deviceId} HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
get
Authorizations
Path parameters
deviceIdstringRequired
frameIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/s7/templates/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
"creationDate": "2025-07-05T20:11:07.613Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T20:11:07.613Z",
"id": "text",
"deviceId": "text",
"dsc": "text",
"scanTimeFactor": 1,
"name": "text",
"isWritable": true,
"isReadable": true,
"minutesOffset": 1,
"startAddress": 1,
"dbNumber": 1,
"quantity": 1,
"type": "System Information (Caller)"
}
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
startAddressinteger · int32Required
dbNumberinteger · int32Optional
quantityinteger · int32 · min: 1Required
typestring · enumRequiredPossible values:
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
put
PUT /api/protocols/s7/templates/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 211
{
"id": "text",
"deviceId": "text",
"dsc": "text",
"scanTimeFactor": 1,
"name": "text",
"isWritable": true,
"isReadable": true,
"minutesOffset": 1,
"startAddress": 1,
"dbNumber": 1,
"quantity": 1,
"type": "System Information (Caller)"
}
No content
delete
Authorizations
Path parameters
deviceIdstringRequired
frameIdstringRequired
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
delete
DELETE /api/protocols/s7/templates/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
get
Authorizations
Path parameters
deviceIdstringRequired
frameIdstringRequired
variableIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/s7/templates/devices/{deviceId}/frames/{frameId}/variables/{variableId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
"creationDate": "2025-07-05T20:11:07.613Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T20:11:07.613Z",
"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",
"bitOffset": 1,
"type": "BIT",
"startAddress": 1,
"maxLen": 1,
"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
bitOffsetinteger · int32Optional
typestring · enumRequiredPossible values:
startAddressinteger · int32Required
maxLeninteger · int32Optional
deviceIdstringOptional
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
put
PUT /api/protocols/s7/templates/devices/{deviceId}/frames/{frameId}/variables/{variableId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 616
{
"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",
"bitOffset": 1,
"type": "BIT",
"startAddress": 1,
"maxLen": 1,
"deviceId": "text"
}
No content
delete
Authorizations
Path parameters
deviceIdstringRequired
frameIdstringRequired
variableIdstringRequired
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
delete
DELETE /api/protocols/s7/templates/devices/{deviceId}/frames/{frameId}/variables/{variableId} HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
get
Authorizations
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/s7/templates/devices HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T20:11:07.613Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T20:11:07.613Z",
"id": "text",
"properties": "text",
"dsc": "text",
"name": "text",
"scanType": "Periodic",
"scanTime": 1
}
]
post
Authorizations
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
propertiesstringOptional
dscstring · max: 255Optional
namestring · max: 100Required
scanTypestring · enumRequiredPossible values:
scanTimeinteger · int32 · min: 1Required
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/protocols/s7/templates/devices HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 95
{
"id": "text",
"properties": "text",
"dsc": "text",
"name": "text",
"scanType": "Periodic",
"scanTime": 1
}
{
"creationDate": "2025-07-05T20:11:07.613Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T20:11:07.613Z",
"id": "text",
"properties": "text",
"dsc": "text",
"name": "text",
"scanType": "Periodic",
"scanTime": 1
}
get
Authorizations
Path parameters
deviceIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/s7/templates/devices/{deviceId}/frames HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T20:11:07.613Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T20:11:07.613Z",
"id": "text",
"deviceId": "text",
"dsc": "text",
"scanTimeFactor": 1,
"name": "text",
"isWritable": true,
"isReadable": true,
"minutesOffset": 1,
"startAddress": 1,
"dbNumber": 1,
"quantity": 1,
"type": "System Information (Caller)"
}
]
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
startAddressinteger · int32Required
dbNumberinteger · int32Optional
quantityinteger · int32 · min: 1Required
typestring · enumRequiredPossible values:
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/protocols/s7/templates/devices/{deviceId}/frames HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 211
{
"id": "text",
"deviceId": "text",
"dsc": "text",
"scanTimeFactor": 1,
"name": "text",
"isWritable": true,
"isReadable": true,
"minutesOffset": 1,
"startAddress": 1,
"dbNumber": 1,
"quantity": 1,
"type": "System Information (Caller)"
}
{
"creationDate": "2025-07-05T20:11:07.613Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T20:11:07.613Z",
"id": "text",
"deviceId": "text",
"dsc": "text",
"scanTimeFactor": 1,
"name": "text",
"isWritable": true,
"isReadable": true,
"minutesOffset": 1,
"startAddress": 1,
"dbNumber": 1,
"quantity": 1,
"type": "System Information (Caller)"
}
get
Authorizations
Path parameters
deviceIdstringRequired
frameIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/s7/templates/devices/{deviceId}/frames/{frameId}/variables HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T20:11:07.613Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T20:11:07.613Z",
"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",
"bitOffset": 1,
"type": "BIT",
"startAddress": 1,
"maxLen": 1,
"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
bitOffsetinteger · int32Optional
typestring · enumRequiredPossible values:
startAddressinteger · int32Required
maxLeninteger · int32Optional
deviceIdstringOptional
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/protocols/s7/templates/devices/{deviceId}/frames/{frameId}/variables HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 616
{
"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",
"bitOffset": 1,
"type": "BIT",
"startAddress": 1,
"maxLen": 1,
"deviceId": "text"
}
{
"creationDate": "2025-07-05T20:11:07.613Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T20:11:07.613Z",
"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",
"bitOffset": 1,
"type": "BIT",
"startAddress": 1,
"maxLen": 1,
"deviceId": "text"
}