---

Variables allow you to define specific sets of registers to read from devices in bulk requests.

---

Important

All requests in this documentation follow this endpoint structure:

/io.clbs.openhes.services.svcapi.ApiService/{endpoint}

Replace {endpoint} with the specific API action listed in each section.

---

Create Variables

To create a variable, send a request with the register IDs and a unique variable name to the CreateVariable endpoint.

• Variable names are case-sensitive.

Example request:

{
  "spec": {
    "registerId": [
      "0195a843-960c-768d-997a-e4985a0c4225"
    ]
  },
  "metadata": {
    "name": "LP A+"
  }
}

The response contains a unique variable ID.

Example response:

"0195ae80-6d1f-7d62-98db-8a0c1d5ade9f"

→ API OBJECT documentation (Create Variable)

---

Update Variables

To update an existing variable, send a request with a complete definition to the UpdateVariable endpoint.

• Always send a full definition, not just updated fields.
• Include the variable id, generation, and name in the metadata.
• You can acquire these details by sending a request to the ListVariables endpoint. For details, see Search and Filter Data.

Example request:

  {
    "spec": {
      "registerId": [
        "01958f8a-be03-71cd-9cba-9a6fec08c301",
        "0195a843-960c-768d-997a-e4985a0c4225"
      ]
    },
    "metadata": {
      "id" : "0195ae80-6d1f-7d62-98db-8a0c1d5ade9f",
      "generation": 2,
      "name": "LP A+"
    }
  }

---

Delete Variables

To delete a variable, send a request with the variable ID to the DeleteVariable endpoint.

---

Use Variables in Bulks

When creating bulk requests to read data, you can include variables to define which registers should be read from the devices.

To specify variables in a bulk, add the variables attribute to the CreateBulk request.

• Use the variable name, not variable ID, when specifying the variables. Names are case-sensitive.
• For details about bulks, see Read Data From Devices.

Example request:

{
    "spec": {
        "actions": [
            {
                "variables": ["A+","A-"],
                "getPeriodicalProfile": {
                    "to": "2025-03-16T00:00:00.000000000Z",
                    "from": "2025-03-15T00:00:00.000000000Z"
                }
            },
            {
                "variables": [],
                "getRegister": {}
            }            
            
        ],
        "devices": {
            "list": [
                {
                    "deviceId": "4c42859a-39ea-415f-ae0e-d642224a9eb5",
                    "jobId": "4c42859a-39ea-415f-ae1e-d642224a9eb5"
                },
                {
                    "deviceId": "d4c3ce45-2081-40e6-8e60-b2ac5b3db356",
                    "jobId": "d4c3ce45-2081-49e6-8e60-b2ac5b3db356"
                }
            ],
        },
        "settings": {
            "attempts": [
                2
            ],
            "priority": 0,
            "expiresAt": "2025-03-20T11:00:00.000000000Z",
            "retryDelay": "30s",
            "maxDuration": "3600s"
        },
        "correlationId": "unicorn-jeb-correlation-id-73036d0c-0ff5-43f4-8037-0a0906fea6a1"
    },
    "metadata": {
        "name": "test small lists of device"
    }
}

---