Siemens WinCC Unified (GraphQL server)

{
  "body": {
    "query": "mutation Login($username: String!, $password: String!) { login(username: $username, password: $password) { token expires user { name fullName language autoLogoffSec } error { code description } } }",
    "variables": {
      "username": "<UMC user>",
      "password": "<password>"
    }
  }
}

{"data": {"login": {"token": "<token>", "expires": "2026-10-05T07:30:00.000Z", "user": {"name": "operator", "fullName": "Operator", "language": "en-US", "autoLogoffSec": 1800}, "error": {"code": "0", "description": "Success"}}}}

{
  "token": "<token>",
  "body": {
    "query": "query TagValues($names: [String!]!, $directRead: Boolean) { tagValues(names: $names, directRead: $directRead) { name value { value timestamp quality { quality subStatus } } error { code description } } }",
    "variables": {
      "names": [
        "Line1_Temperature",
        "Line1_Setpoint"
      ]
    }
  }
}

{"data": {"tagValues": [{"name": "Line1_Temperature", "value": {"value": 21.4, "timestamp": "2026-10-05T07:00:00.000Z", "quality": {"quality": "GOOD_CASCADE", "subStatus": "NON_SPECIFIC"}}, "error": {"code": "0", "description": "Success"}}]}}

{
  "token": "<token>",
  "body": {
    "query": "mutation WriteTagValues($input: [TagValueInput]!, $timestamp: Timestamp, $quality: QualityInput) { writeTagValues(input: $input, timestamp: $timestamp, quality: $quality) { name error { code description } } }",
    "variables": {
      "input": [
        {
          "name": "Line1_Setpoint",
          "value": 72.5
        }
      ]
    }
  }
}

{
  "token": "<token>",
  "body": {
    "query": "query Browse($nameFilters: [String], $objectTypeFilters: [ObjectTypesEnum], $language: String) { browse(nameFilters: $nameFilters, objectTypeFilters: $objectTypeFilters, language: $language) { name displayName objectType dataType } }",
    "variables": {
      "nameFilters": [
        "Line1_*"
      ],
      "objectTypeFilters": [
        "TAG"
      ],
      "language": "en-US"
    }
  }
}

{
  "token": "<token>",
  "body": {
    "query": "query LoggedTagValues($names: [String]!, $startTime: Timestamp, $endTime: Timestamp, $maxNumberOfValues: Int, $sortingMode: LoggedTagValuesSortingModeEnum) { loggedTagValues(names: $names, startTime: $startTime, endTime: $endTime, maxNumberOfValues: $maxNumberOfValues, sortingMode: $sortingMode) { loggingTagName error { code description } values { value { value timestamp quality { quality subStatus } } flags } } }",
    "variables": {
      "names": [
        "Line1_Temperature:Line1_Temperature_Log"
      ],
      "startTime": "2026-10-05T06:00:00.000Z",
      "endTime": "2026-10-05T07:00:00.000Z",
      "maxNumberOfValues": 1000,
      "sortingMode": "TIME_ASC"
    }
  }
}

{
  "token": "<token>",
  "body": {
    "query": "query ActiveAlarms($systemNames: [String], $filterString: String, $filterLanguage: String, $languages: [String]) { activeAlarms(systemNames: $systemNames, filterString: $filterString, filterLanguage: $filterLanguage, languages: $languages) { name instanceID alarmGroupID raiseTime acknowledgmentTime clearTime resetTime modificationTime state priority eventText infoText alarmClassName origin area path value hostName userName } }",
    "variables": {
      "filterString": "Priority >= 10",
      "languages": [
        "en-US"
      ]
    }
  }
}

{
  "token": "<token>",
  "body": {
    "query": "mutation AcknowledgeAlarms($input: [AlarmIdentifierInput]!) { acknowledgeAlarms(input: $input) { alarmName alarmInstanceID error { code description } } }",
    "variables": {
      "input": [
        {
          "name": "HMI_RT_1::Line1_Temperature:HighHigh",
          "instanceID": 0
        }
      ]
    }
  }
}

{
  "token": "<token>",
  "body": {
    "query": "query LoggedAlarms($systemNames: [String], $filterString: String, $languages: [String], $startTime: Timestamp, $endTime: Timestamp, $maxNumberOfResults: Int) { loggedAlarms(systemNames: $systemNames, filterString: $filterString, languages: $languages, startTime: $startTime, endTime: $endTime, maxNumberOfResults: $maxNumberOfResults) { name instanceID raiseTime acknowledgmentTime clearTime resetTime modificationTime state priority eventText origin area } }",
    "variables": {
      "startTime": "2026-10-05T00:00:00.000Z",
      "endTime": "2026-10-05T07:00:00.000Z",
      "maxNumberOfResults": 100
    }
  }
}

{
  "token": "<token>",
  "body": {
    "query": "mutation ExtendSession { extendSession { token expires error { code description } } }",
    "variables": {}
  }
}

# Example actions for the WinccUnifiedGraphql route (docs page). Not part of the route template.
# Secrets: WINCC_UNIFIED_USER / WINCC_UNIFIED_PASSWORD = a UMC user configured for Runtime (read rights for queries,
#   write rights for writeTagValues and the alarm mutations). The login mutation returns the token in the response
#   BODY (data.login.token), so an action can keep it internally and add it to every request. The session stays
#   open while there is activity; the keep-alive below renews it. On an "errors" reply, publish to the login topic again.
# Tag and alarm names below are examples: use the names from your WinCC Unified project (BrowseTags lists them).

DEFINE ACTION WinccUnifiedLogin
ON TOPIC "internal/wincc-unified/login" DO
    SET "user" WITH GET SECRET "WINCC_UNIFIED_USER"
    SET "password" WITH GET SECRET "WINCC_UNIFIED_PASSWORD"
    PUBLISH TOPIC "historian/siemens-wincc-unified/session/create" WITH { "body": { "query": "mutation ($u: String!, $p: String!) { login(username: $u, password: $p) { token expires error { code description } } }", "variables": { "u": {user}, "p": {password} } } }

DEFINE ACTION WinccUnifiedRememberToken
ON TOPIC "historian/siemens-wincc-unified/session/create/response" DO
    SET "token" WITH GET JSON "data.login.token" IN PAYLOAD AS STRING
    KEEP TOPIC "internal/wincc-unified/token" WITH {token}

DEFINE ACTION WinccUnifiedKeepAlive
ON EVERY 5 MINUTES DO
    SET "token" WITH GET TOPIC "internal/wincc-unified/token"
    PUBLISH TOPIC "historian/siemens-wincc-unified/session/update" WITH { "token": {token}, "body": { "query": "mutation { extendSession { expires error { code description } } }" } }

DEFINE ACTION WinccUnifiedPollLine1
ON EVERY 10 SECONDS DO
    SET "token" WITH GET TOPIC "internal/wincc-unified/token"
    PUBLISH TOPIC "historian/siemens-wincc-unified/tag-value/get" WITH { "token": {token}, "body": { "query": "query ($names: [String!]!) { tagValues(names: $names) { name value { value timestamp quality { quality } } error { code description } } }", "variables": { "names": [ "Line1_Temperature", "Line1_Setpoint", "Line1_Running" ] } } }

DEFINE ACTION WinccUnifiedWriteSetpoint
ON TOPIC "plant/line1/setpoint/set" DO
    SET "token" WITH GET TOPIC "internal/wincc-unified/token"
    SET "value" WITH PAYLOAD AS DOUBLE
    PUBLISH TOPIC "historian/siemens-wincc-unified/tag-value/update" WITH { "token": {token}, "body": { "query": "mutation ($input: [TagValueInput]!) { writeTagValues(input: $input) { name error { code description } } }", "variables": { "input": [ { "name": "Line1_Setpoint", "value": {value} } ] } } }

DEFINE ACTION WinccUnifiedPollAlarms
ON EVERY 30 SECONDS DO
    SET "token" WITH GET TOPIC "internal/wincc-unified/token"
    PUBLISH TOPIC "historian/siemens-wincc-unified/active-alarm/list" WITH { "token": {token}, "body": { "query": "query ($languages: [String]) { activeAlarms(languages: $languages) { name instanceID state priority raiseTime eventText } }", "variables": { "languages": [ "en-US" ] } } }

DEFINE ACTION WinccUnifiedAcknowledgeFromMqtt
ON TOPIC "plant/line1/alarm/ack" DO
    SET "token" WITH GET TOPIC "internal/wincc-unified/token"
    SET "alarm" WITH GET JSON "name" IN PAYLOAD AS STRING
    PUBLISH TOPIC "historian/siemens-wincc-unified/alarm/acknowledge" WITH { "token": {token}, "body": { "query": "mutation ($input: [AlarmIdentifierInput]!) { acknowledgeAlarms(input: $input) { alarmName alarmInstanceID error { code description } } }", "variables": { "input": [ { "name": {alarm}, "instanceID": 0 } ] } } }