Variable Controller Facade

post

Authorizations

Query parameters

Body

filestring · binaryRequired

Responses

200

OK

*/*

Responseobject

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

POST /api/variables/import HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{}

post

Authorizations

Query parameters

Body

namestringOptional

typestringOptional

dscInstringOptional

projectIdstringRequired

frameIdstringOptional

connectionIdstringOptional

nameInstringOptional

deviceIdstringOptional

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

POST /api/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-24T08:01:20.184Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-07-24T08:01:20.184Z",
      "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",
      "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

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

GET /api/variables HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-24T08:01:20.184Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-24T08:01:20.184Z",
    "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",
    "connectionId": "text",
    "deviceId": "text"
  }
]

get

Authorizations

Path parameters

variableIdstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

GET /api/variables/{variableId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-24T08:01:20.184Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-24T08:01:20.184Z",
  "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",
  "connectionId": "text",
  "deviceId": "text"
}

delete

Authorizations

Path parameters

variableIdstringRequired

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

DELETE /api/variables/{variableId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content

get

Authorizations

Query parameters

projectIdstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

GET /api/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-24T08:01:20.184Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-07-24T08:01:20.184Z",
      "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",
      "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

projectIdstringOptional

includeIdsbooleanOptionalDefault: false

Responses

200

OK

*/*

Responseobject

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

GET /api/variables/export HTTP/1.1
Host: inscada.cloud
Accept: */*

{}

get

Authorizations

Query parameters

projectIdstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

GET /api/variables/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-24T08:01:20.184Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-24T08:01:20.184Z",
    "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",
    "connectionId": "text",
    "deviceId": "text"
  }
]

get

Authorizations

Query parameters

projectIdstringRequired

namesstring[]Required

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

GET /api/variables/by-project-and-names HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-24T08:01:20.184Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-24T08:01:20.184Z",
    "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",
    "connectionId": "text",
    "deviceId": "text"
  }
]

get

Authorizations

Query parameters

projectIdstringRequired

namestringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

GET /api/variables/by-project-and-name HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-24T08:01:20.184Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-24T08:01:20.184Z",
  "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",
  "connectionId": "text",
  "deviceId": "text"
}

get

Authorizations

Query parameters

variableIdsstring[]Required

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

GET /api/variables/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-24T08:01:20.184Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-24T08:01:20.184Z",
    "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",
    "connectionId": "text",
    "deviceId": "text"
  }
]

get

Authorizations

Query parameters

frameIdstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

GET /api/variables/by-frame HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-24T08:01:20.184Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-24T08:01:20.184Z",
    "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",
    "connectionId": "text",
    "deviceId": "text"
  }
]

delete

Authorizations

Query parameters

variableIdsstring[]Required

Responses

200

OK

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

DELETE /api/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

200

OK

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

DELETE /api/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