Mqtt Variable Controller

get
Authorizations
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/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",
    "keepLastValues": true,
    "unit": "text",
    "engZeroScale": 1,
    "fractionalDigitCount": 1,
    "name": "text",
    "logExpressionId": "text",
    "logType": "No Log",
    "logExpressionCode": "text",
    "valueExpressionCode": "text",
    "valueExpressionId": "text",
    "isPulseOff": true,
    "frameId": "text",
    "setMinValue": 1,
    "pulseOffDuration": 1,
    "code": "text",
    "engFullScale": 1,
    "pulseOnDuration": 1,
    "logThreshold": 1,
    "rawFullScale": 1,
    "isPulseOn": true,
    "valueExpressionType": "NONE",
    "logMaxValue": 1,
    "setMaxValue": 1,
    "logMinValue": 1,
    "isActive": true,
    "projectId": "text",
    "rawZeroScale": 1,
    "logPeriod": 1,
    "dsc": "text",
    "type": "Boolean",
    "connectionId": "text",
    "deviceId": "text"
  }
]
post
Authorizations
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
keepLastValuesbooleanRequired
unitstringOptional
engZeroScalenumber · doubleOptional
fractionalDigitCountinteger · int32Optional
namestring · max: 100Required
logExpressionIdstringOptional
logTypestring · enumOptionalPossible values:
logExpressionCodestring · max: 4000Optional
valueExpressionCodestring · max: 4000Optional
valueExpressionIdstringOptional
isPulseOffbooleanRequired
frameIdstringOptional
setMinValuenumber · doubleOptional
pulseOffDurationinteger · int32Optional
codestring · max: 20Optional
engFullScalenumber · doubleOptional
pulseOnDurationinteger · int32Optional
logThresholdnumber · doubleOptional
rawFullScalenumber · doubleOptional
isPulseOnbooleanRequired
valueExpressionTypestring · enumOptionalPossible values:
logMaxValuenumber · doubleOptional
setMaxValuenumber · doubleOptional
logMinValuenumber · doubleOptional
isActivebooleanRequired
projectIdstringOptional
rawZeroScalenumber · doubleOptional
logPeriodinteger · int32 · min: 1Optional
dscstring · max: 255Optional
typestring · enumRequiredPossible values:
connectionIdstringOptional
deviceIdstringOptional
Responses
200
OK
*/*
post
POST /api/protocols/mqtt/variables HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 619

{
  "id": "text",
  "keepLastValues": true,
  "unit": "text",
  "engZeroScale": 1,
  "fractionalDigitCount": 1,
  "name": "text",
  "logExpressionId": "text",
  "logType": "No Log",
  "logExpressionCode": "text",
  "valueExpressionCode": "text",
  "valueExpressionId": "text",
  "isPulseOff": true,
  "frameId": "text",
  "setMinValue": 1,
  "pulseOffDuration": 1,
  "code": "text",
  "engFullScale": 1,
  "pulseOnDuration": 1,
  "logThreshold": 1,
  "rawFullScale": 1,
  "isPulseOn": true,
  "valueExpressionType": "NONE",
  "logMaxValue": 1,
  "setMaxValue": 1,
  "logMinValue": 1,
  "isActive": true,
  "projectId": "text",
  "rawZeroScale": 1,
  "logPeriod": 1,
  "dsc": "text",
  "type": "Boolean",
  "connectionId": "text",
  "deviceId": "text"
}
{
  "creationDate": "2025-07-05T19:24:32.798Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T19:24:32.798Z",
  "id": "text",
  "keepLastValues": true,
  "unit": "text",
  "engZeroScale": 1,
  "fractionalDigitCount": 1,
  "name": "text",
  "logExpressionId": "text",
  "logType": "No Log",
  "logExpressionCode": "text",
  "valueExpressionCode": "text",
  "valueExpressionId": "text",
  "isPulseOff": true,
  "frameId": "text",
  "setMinValue": 1,
  "pulseOffDuration": 1,
  "code": "text",
  "engFullScale": 1,
  "pulseOnDuration": 1,
  "logThreshold": 1,
  "rawFullScale": 1,
  "isPulseOn": true,
  "valueExpressionType": "NONE",
  "logMaxValue": 1,
  "setMaxValue": 1,
  "logMinValue": 1,
  "isActive": true,
  "projectId": "text",
  "rawZeroScale": 1,
  "logPeriod": 1,
  "dsc": "text",
  "type": "Boolean",
  "connectionId": "text",
  "deviceId": "text"
}
put
Authorizations
Bodyobject[]
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
keepLastValuesbooleanRequired
unitstringOptional
engZeroScalenumber · doubleOptional
fractionalDigitCountinteger · int32Optional
namestring · max: 100Required
logExpressionIdstringOptional
logTypestring · enumOptionalPossible values:
logExpressionCodestring · max: 4000Optional
valueExpressionCodestring · max: 4000Optional
valueExpressionIdstringOptional
isPulseOffbooleanRequired
frameIdstringOptional
setMinValuenumber · doubleOptional
pulseOffDurationinteger · int32Optional
codestring · max: 20Optional
engFullScalenumber · doubleOptional
pulseOnDurationinteger · int32Optional
logThresholdnumber · doubleOptional
rawFullScalenumber · doubleOptional
isPulseOnbooleanRequired
valueExpressionTypestring · enumOptionalPossible values:
logMaxValuenumber · doubleOptional
setMaxValuenumber · doubleOptional
logMinValuenumber · doubleOptional
isActivebooleanRequired
projectIdstringOptional
rawZeroScalenumber · doubleOptional
logPeriodinteger · int32 · min: 1Optional
dscstring · max: 255Optional
typestring · enumRequiredPossible values:
connectionIdstringOptional
deviceIdstringOptional
Responses
204
No Content
put
PUT /api/protocols/mqtt/variables HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 621

[
  {
    "id": "text",
    "keepLastValues": true,
    "unit": "text",
    "engZeroScale": 1,
    "fractionalDigitCount": 1,
    "name": "text",
    "logExpressionId": "text",
    "logType": "No Log",
    "logExpressionCode": "text",
    "valueExpressionCode": "text",
    "valueExpressionId": "text",
    "isPulseOff": true,
    "frameId": "text",
    "setMinValue": 1,
    "pulseOffDuration": 1,
    "code": "text",
    "engFullScale": 1,
    "pulseOnDuration": 1,
    "logThreshold": 1,
    "rawFullScale": 1,
    "isPulseOn": true,
    "valueExpressionType": "NONE",
    "logMaxValue": 1,
    "setMaxValue": 1,
    "logMinValue": 1,
    "isActive": true,
    "projectId": "text",
    "rawZeroScale": 1,
    "logPeriod": 1,
    "dsc": "text",
    "type": "Boolean",
    "connectionId": "text",
    "deviceId": "text"
  }
]

No content

get
Authorizations
Path parameters
variableIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/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",
  "keepLastValues": true,
  "unit": "text",
  "engZeroScale": 1,
  "fractionalDigitCount": 1,
  "name": "text",
  "logExpressionId": "text",
  "logType": "No Log",
  "logExpressionCode": "text",
  "valueExpressionCode": "text",
  "valueExpressionId": "text",
  "isPulseOff": true,
  "frameId": "text",
  "setMinValue": 1,
  "pulseOffDuration": 1,
  "code": "text",
  "engFullScale": 1,
  "pulseOnDuration": 1,
  "logThreshold": 1,
  "rawFullScale": 1,
  "isPulseOn": true,
  "valueExpressionType": "NONE",
  "logMaxValue": 1,
  "setMaxValue": 1,
  "logMinValue": 1,
  "isActive": true,
  "projectId": "text",
  "rawZeroScale": 1,
  "logPeriod": 1,
  "dsc": "text",
  "type": "Boolean",
  "connectionId": "text",
  "deviceId": "text"
}
put
Authorizations
Path parameters
variableIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
keepLastValuesbooleanRequired
unitstringOptional
engZeroScalenumber · doubleOptional
fractionalDigitCountinteger · int32Optional
namestring · max: 100Required
logExpressionIdstringOptional
logTypestring · enumOptionalPossible values:
logExpressionCodestring · max: 4000Optional
valueExpressionCodestring · max: 4000Optional
valueExpressionIdstringOptional
isPulseOffbooleanRequired
frameIdstringOptional
setMinValuenumber · doubleOptional
pulseOffDurationinteger · int32Optional
codestring · max: 20Optional
engFullScalenumber · doubleOptional
pulseOnDurationinteger · int32Optional
logThresholdnumber · doubleOptional
rawFullScalenumber · doubleOptional
isPulseOnbooleanRequired
valueExpressionTypestring · enumOptionalPossible values:
logMaxValuenumber · doubleOptional
setMaxValuenumber · doubleOptional
logMinValuenumber · doubleOptional
isActivebooleanRequired
projectIdstringOptional
rawZeroScalenumber · doubleOptional
logPeriodinteger · int32 · min: 1Optional
dscstring · max: 255Optional
typestring · enumRequiredPossible values:
connectionIdstringOptional
deviceIdstringOptional
Responses
204
No Content
put
PUT /api/protocols/mqtt/variables/{variableId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 619

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

No content

delete
Authorizations
Path parameters
variableIdstringRequired
Responses
204
No Content
delete
DELETE /api/protocols/mqtt/variables/{variableId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content

post
Authorizations
Query parameters
Body
namestringOptional
typestringOptional
dscInstringOptional
projectIdstringRequired
frameIdstringOptional
connectionIdstringOptional
nameInstringOptional
deviceIdstringOptional
Responses
200
OK
*/*
post
POST /api/protocols/mqtt/variables/filter/pages HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "name": "text",
  "type": "text",
  "dscIn": "text",
  "projectId": "text",
  "frameId": "text",
  "connectionId": "text",
  "nameIn": "text",
  "deviceId": "text"
}
{
  "totalElements": 1,
  "totalPages": 1,
  "first": true,
  "last": true,
  "size": 1,
  "content": [
    {
      "creationDate": "2025-07-05T19:24:32.798Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-07-05T19:24:32.798Z",
      "id": "text",
      "keepLastValues": true,
      "unit": "text",
      "engZeroScale": 1,
      "fractionalDigitCount": 1,
      "name": "text",
      "logExpressionId": "text",
      "logType": "No Log",
      "logExpressionCode": "text",
      "valueExpressionCode": "text",
      "valueExpressionId": "text",
      "isPulseOff": true,
      "frameId": "text",
      "setMinValue": 1,
      "pulseOffDuration": 1,
      "code": "text",
      "engFullScale": 1,
      "pulseOnDuration": 1,
      "logThreshold": 1,
      "rawFullScale": 1,
      "isPulseOn": true,
      "valueExpressionType": "NONE",
      "logMaxValue": 1,
      "setMaxValue": 1,
      "logMinValue": 1,
      "isActive": true,
      "projectId": "text",
      "rawZeroScale": 1,
      "logPeriod": 1,
      "dsc": "text",
      "type": "Boolean",
      "connectionId": "text",
      "deviceId": "text"
    }
  ],
  "number": 1,
  "sort": [
    {
      "direction": "text",
      "nullHandling": "text",
      "ascending": true,
      "property": "text",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 1,
  "pageable": {
    "offset": 1,
    "sort": [
      {
        "direction": "text",
        "nullHandling": "text",
        "ascending": true,
        "property": "text",
        "ignoreCase": true
      }
    ],
    "pageNumber": 1,
    "unpaged": true,
    "paged": true,
    "pageSize": 1
  },
  "empty": true
}
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/variables/pages/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*
{
  "totalElements": 1,
  "totalPages": 1,
  "first": true,
  "last": true,
  "size": 1,
  "content": [
    {
      "creationDate": "2025-07-05T19:24:32.798Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-07-05T19:24:32.798Z",
      "id": "text",
      "keepLastValues": true,
      "unit": "text",
      "engZeroScale": 1,
      "fractionalDigitCount": 1,
      "name": "text",
      "logExpressionId": "text",
      "logType": "No Log",
      "logExpressionCode": "text",
      "valueExpressionCode": "text",
      "valueExpressionId": "text",
      "isPulseOff": true,
      "frameId": "text",
      "setMinValue": 1,
      "pulseOffDuration": 1,
      "code": "text",
      "engFullScale": 1,
      "pulseOnDuration": 1,
      "logThreshold": 1,
      "rawFullScale": 1,
      "isPulseOn": true,
      "valueExpressionType": "NONE",
      "logMaxValue": 1,
      "setMaxValue": 1,
      "logMinValue": 1,
      "isActive": true,
      "projectId": "text",
      "rawZeroScale": 1,
      "logPeriod": 1,
      "dsc": "text",
      "type": "Boolean",
      "connectionId": "text",
      "deviceId": "text"
    }
  ],
  "number": 1,
  "sort": [
    {
      "direction": "text",
      "nullHandling": "text",
      "ascending": true,
      "property": "text",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 1,
  "pageable": {
    "offset": 1,
    "sort": [
      {
        "direction": "text",
        "nullHandling": "text",
        "ascending": true,
        "property": "text",
        "ignoreCase": true
      }
    ],
    "pageNumber": 1,
    "unpaged": true,
    "paged": true,
    "pageSize": 1
  },
  "empty": true
}
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/variables/by-project 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",
    "keepLastValues": true,
    "unit": "text",
    "engZeroScale": 1,
    "fractionalDigitCount": 1,
    "name": "text",
    "logExpressionId": "text",
    "logType": "No Log",
    "logExpressionCode": "text",
    "valueExpressionCode": "text",
    "valueExpressionId": "text",
    "isPulseOff": true,
    "frameId": "text",
    "setMinValue": 1,
    "pulseOffDuration": 1,
    "code": "text",
    "engFullScale": 1,
    "pulseOnDuration": 1,
    "logThreshold": 1,
    "rawFullScale": 1,
    "isPulseOn": true,
    "valueExpressionType": "NONE",
    "logMaxValue": 1,
    "setMaxValue": 1,
    "logMinValue": 1,
    "isActive": true,
    "projectId": "text",
    "rawZeroScale": 1,
    "logPeriod": 1,
    "dsc": "text",
    "type": "Boolean",
    "connectionId": "text",
    "deviceId": "text"
  }
]
get
Authorizations
Query parameters
projectIdstringRequired
namestringRequired
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/variables/by-project-and-name 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",
  "keepLastValues": true,
  "unit": "text",
  "engZeroScale": 1,
  "fractionalDigitCount": 1,
  "name": "text",
  "logExpressionId": "text",
  "logType": "No Log",
  "logExpressionCode": "text",
  "valueExpressionCode": "text",
  "valueExpressionId": "text",
  "isPulseOff": true,
  "frameId": "text",
  "setMinValue": 1,
  "pulseOffDuration": 1,
  "code": "text",
  "engFullScale": 1,
  "pulseOnDuration": 1,
  "logThreshold": 1,
  "rawFullScale": 1,
  "isPulseOn": true,
  "valueExpressionType": "NONE",
  "logMaxValue": 1,
  "setMaxValue": 1,
  "logMinValue": 1,
  "isActive": true,
  "projectId": "text",
  "rawZeroScale": 1,
  "logPeriod": 1,
  "dsc": "text",
  "type": "Boolean",
  "connectionId": "text",
  "deviceId": "text"
}
get
Authorizations
Query parameters
variableIdsstring[]Required
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/variables/by-ids 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",
    "keepLastValues": true,
    "unit": "text",
    "engZeroScale": 1,
    "fractionalDigitCount": 1,
    "name": "text",
    "logExpressionId": "text",
    "logType": "No Log",
    "logExpressionCode": "text",
    "valueExpressionCode": "text",
    "valueExpressionId": "text",
    "isPulseOff": true,
    "frameId": "text",
    "setMinValue": 1,
    "pulseOffDuration": 1,
    "code": "text",
    "engFullScale": 1,
    "pulseOnDuration": 1,
    "logThreshold": 1,
    "rawFullScale": 1,
    "isPulseOn": true,
    "valueExpressionType": "NONE",
    "logMaxValue": 1,
    "setMaxValue": 1,
    "logMinValue": 1,
    "isActive": true,
    "projectId": "text",
    "rawZeroScale": 1,
    "logPeriod": 1,
    "dsc": "text",
    "type": "Boolean",
    "connectionId": "text",
    "deviceId": "text"
  }
]
get
Authorizations
Query parameters
frameIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/variables/by-frame 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",
    "keepLastValues": true,
    "unit": "text",
    "engZeroScale": 1,
    "fractionalDigitCount": 1,
    "name": "text",
    "logExpressionId": "text",
    "logType": "No Log",
    "logExpressionCode": "text",
    "valueExpressionCode": "text",
    "valueExpressionId": "text",
    "isPulseOff": true,
    "frameId": "text",
    "setMinValue": 1,
    "pulseOffDuration": 1,
    "code": "text",
    "engFullScale": 1,
    "pulseOnDuration": 1,
    "logThreshold": 1,
    "rawFullScale": 1,
    "isPulseOn": true,
    "valueExpressionType": "NONE",
    "logMaxValue": 1,
    "setMaxValue": 1,
    "logMinValue": 1,
    "isActive": true,
    "projectId": "text",
    "rawZeroScale": 1,
    "logPeriod": 1,
    "dsc": "text",
    "type": "Boolean",
    "connectionId": "text",
    "deviceId": "text"
  }
]
delete
Authorizations
Query parameters
variableIdsstring[]Required
Responses
204
No Content
delete
DELETE /api/protocols/mqtt/variables/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

No content

delete
Authorizations
Body
namestringOptional
typestringOptional
dscInstringOptional
projectIdstringRequired
frameIdstringOptional
connectionIdstringOptional
nameInstringOptional
deviceIdstringOptional
Responses
204
No Content
delete
DELETE /api/protocols/mqtt/variables/filter HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "name": "text",
  "type": "text",
  "dscIn": "text",
  "projectId": "text",
  "frameId": "text",
  "connectionId": "text",
  "nameIn": "text",
  "deviceId": "text"
}

No content