Variable Value Controller

get
Authorizations
Path parameters
variableIdstringRequired
Responses
200

OK

*/*
Responseone of
all ofOptional
or
all ofOptional
or
all ofOptional
get
/api/variables/{variableId}/value
GET /api/variables/{variableId}/value HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "date": "2025-11-01T06:30:25.412Z",
  "variableShortInfo": {
    "project": "text",
    "name": "text",
    "code": "text",
    "dsc": "text",
    "frame": "text",
    "connection": "text",
    "device": "text"
  },
  "flags": {
    "ANY_ADDITIONAL_PROPERTY": true
  },
  "value": true,
  "extras": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "dateInMs": 1
}
post
Authorizations
Path parameters
variableIdstringRequired
Body
Other propertiesobjectOptional
Responses
204

No Content

No content
post
/api/variables/{variableId}/value
POST /api/variables/{variableId}/value HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "ANY_ADDITIONAL_PROPERTY": {}
}
No content
get
Authorizations
Query parameters
projectIdstringRequired
namestringRequired
Responses
200

OK

*/*
Responseone of
all ofOptional
or
all ofOptional
or
all ofOptional
get
/api/variables/value/by-project-and-name
GET /api/variables/value/by-project-and-name?projectId=text&name=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "date": "2025-11-01T06:30:25.412Z",
  "variableShortInfo": {
    "project": "text",
    "name": "text",
    "code": "text",
    "dsc": "text",
    "frame": "text",
    "connection": "text",
    "device": "text"
  },
  "flags": {
    "ANY_ADDITIONAL_PROPERTY": true
  },
  "value": true,
  "extras": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "dateInMs": 1
}
post
Authorizations
Query parameters
projectIdstringRequired
namestringRequired
Body
Other propertiesobjectOptional
Responses
204

No Content

No content
post
/api/variables/value/by-project-and-name
POST /api/variables/value/by-project-and-name?projectId=text&name=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "ANY_ADDITIONAL_PROPERTY": {}
}
No content
get
Authorizations
Responses
200

OK

*/*
get
/api/variables/values
GET /api/variables/values HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": {
    "date": "2025-11-01T06:30:25.412Z",
    "variableShortInfo": {
      "project": "text",
      "name": "text",
      "code": "text",
      "dsc": "text",
      "frame": "text",
      "connection": "text",
      "device": "text"
    },
    "flags": {
      "ANY_ADDITIONAL_PROPERTY": true
    },
    "value": true,
    "extras": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "dateInMs": 1
  }
}
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200

OK

*/*
get
/api/variables/values/by-project
GET /api/variables/values/by-project?projectId=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": {
    "date": "2025-11-01T06:30:25.412Z",
    "variableShortInfo": {
      "project": "text",
      "name": "text",
      "code": "text",
      "dsc": "text",
      "frame": "text",
      "connection": "text",
      "device": "text"
    },
    "flags": {
      "ANY_ADDITIONAL_PROPERTY": true
    },
    "value": true,
    "extras": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "dateInMs": 1
  }
}
get
Authorizations
Query parameters
projectIdstringRequired
namesstring[]Required
Responses
200

OK

*/*
get
/api/variables/values/by-project-and-names
GET /api/variables/values/by-project-and-names?projectId=text&names=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": {
    "date": "2025-11-01T06:30:25.412Z",
    "variableShortInfo": {
      "project": "text",
      "name": "text",
      "code": "text",
      "dsc": "text",
      "frame": "text",
      "connection": "text",
      "device": "text"
    },
    "flags": {
      "ANY_ADDITIONAL_PROPERTY": true
    },
    "value": true,
    "extras": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "dateInMs": 1
  }
}
get
Authorizations
Query parameters
variableIdsstring[]Required
Responses
200

OK

*/*
get
/api/variables/values/by-ids
GET /api/variables/values/by-ids?variableIds=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": {
    "date": "2025-11-01T06:30:25.412Z",
    "variableShortInfo": {
      "project": "text",
      "name": "text",
      "code": "text",
      "dsc": "text",
      "frame": "text",
      "connection": "text",
      "device": "text"
    },
    "flags": {
      "ANY_ADDITIONAL_PROPERTY": true
    },
    "value": true,
    "extras": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "dateInMs": 1
  }
}
get
Authorizations
Query parameters
frameIdstringRequired
Responses
200

OK

*/*
get
/api/variables/values/by-frame
GET /api/variables/values/by-frame?frameId=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": {
    "date": "2025-11-01T06:30:25.412Z",
    "variableShortInfo": {
      "project": "text",
      "name": "text",
      "code": "text",
      "dsc": "text",
      "frame": "text",
      "connection": "text",
      "device": "text"
    },
    "flags": {
      "ANY_ADDITIONAL_PROPERTY": true
    },
    "value": true,
    "extras": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "dateInMs": 1
  }
}
get
Authorizations
Query parameters
projectIdstringRequired
namesstring[]Required
startDatestring · date-timeRequired
endDatestring · date-timeRequired
Responses
200

OK

*/*
get
/api/variables/logged-values/stats/hourly/by-project-and-names
GET /api/variables/logged-values/stats/hourly/by-project-and-names?projectId=text&names=text&startDate=2025-11-01T06%3A30%3A25.412Z&endDate=2025-11-01T06%3A30%3A25.412Z HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": [
    {
      "sumValue": 1,
      "maxValue": 1,
      "variableId": 1,
      "middleValue": 1,
      "minValue": 1,
      "dttm": "2025-11-01T06:30:25.412Z",
      "firstValue": 1,
      "name": "text",
      "medianValue": 1,
      "maxDiffValue": 1,
      "avgValue": 1,
      "lastFirstDiffValue": 1,
      "lastValue": 1,
      "countValue": 1
    }
  ]
}
get
Authorizations
Query parameters
variableIdsstring[]Required
startDatestring · date-timeRequired
endDatestring · date-timeRequired
Responses
200

OK

*/*
get
/api/variables/logged-values/stats/hourly/by-ids
GET /api/variables/logged-values/stats/hourly/by-ids?variableIds=text&startDate=2025-11-01T06%3A30%3A25.412Z&endDate=2025-11-01T06%3A30%3A25.412Z HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "sumValue": 1,
    "maxValue": 1,
    "variableId": 1,
    "middleValue": 1,
    "minValue": 1,
    "dttm": "2025-11-01T06:30:25.412Z",
    "firstValue": 1,
    "name": "text",
    "medianValue": 1,
    "maxDiffValue": 1,
    "avgValue": 1,
    "lastFirstDiffValue": 1,
    "lastValue": 1,
    "countValue": 1
  }
]
get
Authorizations
Query parameters
projectIdstringRequired
namesstring[]Required
startDatestring · date-timeRequired
endDatestring · date-timeRequired
Responses
200

OK

*/*
get
/api/variables/logged-values/stats/daily/by-project-and-names
GET /api/variables/logged-values/stats/daily/by-project-and-names?projectId=text&names=text&startDate=2025-11-01T06%3A30%3A25.412Z&endDate=2025-11-01T06%3A30%3A25.412Z HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": [
    {
      "sumValue": 1,
      "maxValue": 1,
      "variableId": 1,
      "middleValue": 1,
      "minValue": 1,
      "dttm": "2025-11-01T06:30:25.412Z",
      "firstValue": 1,
      "name": "text",
      "medianValue": 1,
      "maxDiffValue": 1,
      "avgValue": 1,
      "lastFirstDiffValue": 1,
      "lastValue": 1,
      "countValue": 1
    }
  ]
}
get
Authorizations
Query parameters
variableIdsstring[]Required
startDatestring · date-timeRequired
endDatestring · date-timeRequired
Responses
200

OK

*/*
get
/api/variables/logged-values/stats/daily/by-ids
GET /api/variables/logged-values/stats/daily/by-ids?variableIds=text&startDate=2025-11-01T06%3A30%3A25.412Z&endDate=2025-11-01T06%3A30%3A25.412Z HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "sumValue": 1,
    "maxValue": 1,
    "variableId": 1,
    "middleValue": 1,
    "minValue": 1,
    "dttm": "2025-11-01T06:30:25.412Z",
    "firstValue": 1,
    "name": "text",
    "medianValue": 1,
    "maxDiffValue": 1,
    "avgValue": 1,
    "lastFirstDiffValue": 1,
    "lastValue": 1,
    "countValue": 1
  }
]
get
Authorizations
Query parameters
variableIdsstring[]Required
startDatestring · date-timeRequired
endDatestring · date-timeRequired
Responses
200

OK

*/*
get
/api/variables/logged-values/stats/daily/by-ids/pages
GET /api/variables/logged-values/stats/daily/by-ids/pages?variableIds=text&startDate=2025-11-01T06%3A30%3A25.412Z&endDate=2025-11-01T06%3A30%3A25.412Z&pageable=[object+Object] HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "totalElements": 1,
  "totalPages": 1,
  "first": true,
  "last": true,
  "size": 1,
  "content": [
    {
      "sumValue": 1,
      "maxValue": 1,
      "variableId": 1,
      "middleValue": 1,
      "minValue": 1,
      "dttm": "2025-11-01T06:30:25.412Z",
      "firstValue": 1,
      "name": "text",
      "medianValue": 1,
      "maxDiffValue": 1,
      "avgValue": 1,
      "lastFirstDiffValue": 1,
      "lastValue": 1,
      "countValue": 1
    }
  ],
  "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
variableIdsstring[]Required
startDatestring · date-timeRequired
endDatestring · date-timeRequired
intervalinteger · int32Optional
Responses
200

OK

*/*
get
/api/variables/logged-values/stats/by-ids
GET /api/variables/logged-values/stats/by-ids?variableIds=text&startDate=2025-11-01T06%3A30%3A25.412Z&endDate=2025-11-01T06%3A30%3A25.412Z HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "sumValue": 1,
    "maxValue": 1,
    "variableId": 1,
    "middleValue": 1,
    "minValue": 1,
    "dttm": "2025-11-01T06:30:25.412Z",
    "firstValue": 1,
    "name": "text",
    "medianValue": 1,
    "maxDiffValue": 1,
    "avgValue": 1,
    "lastFirstDiffValue": 1,
    "lastValue": 1,
    "countValue": 1
  }
]
get
Authorizations
Query parameters
variableIdsstring[]Required
startDatestring · date-timeRequired
endDatestring · date-timeRequired
Responses
200

OK

*/*
get
/api/variables/logged-values/by-ids
GET /api/variables/logged-values/by-ids?variableIds=text&startDate=2025-11-01T06%3A30%3A25.412Z&endDate=2025-11-01T06%3A30%3A25.412Z HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "projectId": "text",
    "extras": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "name": "text",
    "value": 1,
    "variableId": "text",
    "flags": {
      "ANY_ADDITIONAL_PROPERTY": true
    },
    "textValue": "text",
    "dttm": "2025-11-01T06:30:25.412Z",
    "project": "text"
  }
]
get
Authorizations
Query parameters
variableIdsstring[]Required
startDatestring · date-timeRequired
endDatestring · date-timeRequired
Responses
200

OK

*/*
get
/api/variables/logged-values/by-ids/pages
GET /api/variables/logged-values/by-ids/pages?variableIds=text&startDate=2025-11-01T06%3A30%3A25.412Z&endDate=2025-11-01T06%3A30%3A25.412Z&pageable=[object+Object] HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "totalElements": 1,
  "totalPages": 1,
  "first": true,
  "last": true,
  "size": 1,
  "content": [
    {
      "projectId": "text",
      "extras": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "name": "text",
      "value": 1,
      "variableId": "text",
      "flags": {
        "ANY_ADDITIONAL_PROPERTY": true
      },
      "textValue": "text",
      "dttm": "2025-11-01T06:30:25.412Z",
      "project": "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
}
PreviousFired Alarm ControllerNextVariable Controller Facade

Last updated