Discover mass write point groups

curl --request POST \
  --url https://api.kodelabs.com/kodeos/api/v1/mass-write/point-groups/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": {
    "buildingIds": [
      "<string>"
    ],
    "canonicalTypes": [
      "VAV"
    ],
    "kinds": [
      "Number"
    ],
    "fields": [
      "Space Temp Setpoint"
    ],
    "connectorTypes": [
      "API_JACE"
    ],
    "areaIds": [
      "<string>"
    ],
    "deviceIds": [
      "<string>"
    ],
    "nameContains": "Zone",
    "excludePointIds": [
      "<string>"
    ]
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: {
      buildingIds: ['<string>'],
      canonicalTypes: ['VAV'],
      kinds: ['Number'],
      fields: ['Space Temp Setpoint'],
      connectorTypes: ['API_JACE'],
      areaIds: ['<string>'],
      deviceIds: ['<string>'],
      nameContains: 'Zone',
      excludePointIds: ['<string>']
    }
  })
};

fetch('https://api.kodelabs.com/kodeos/api/v1/mass-write/point-groups/query', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.kodelabs.com/kodeos/api/v1/mass-write/point-groups/query"

payload = { "query": {
        "buildingIds": ["<string>"],
        "canonicalTypes": ["VAV"],
        "kinds": ["Number"],
        "fields": ["Space Temp Setpoint"],
        "connectorTypes": ["API_JACE"],
        "areaIds": ["<string>"],
        "deviceIds": ["<string>"],
        "nameContains": "Zone",
        "excludePointIds": ["<string>"]
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api.kodelabs.com/kodeos/api/v1/mass-write/point-groups/query' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "query": {
    "buildingIds": [
      "<string>"
    ],
    "canonicalTypes": [
      "VAV"
    ],
    "kinds": [
      "Number"
    ],
    "fields": [
      "Space Temp Setpoint"
    ],
    "connectorTypes": [
      "API_JACE"
    ],
    "areaIds": [
      "<string>"
    ],
    "deviceIds": [
      "<string>"
    ],
    "nameContains": "Zone",
    "excludePointIds": [
      "<string>"
    ]
  }
}'

{
  "data": [
    {
      "groupKey": "mw1.Yz3kR1a2B3c4D5e6F7g8H9",
      "kind": "Number",
      "connectorType": "API_JACE",
      "field": "Space Temp Setpoint",
      "templated": true,
      "unit": {
        "id": "fahrenheit",
        "symbol": "°F"
      },
      "pointEnum": [
        "False",
        "True"
      ],
      "points": 16,
      "fields": [
        {
          "id": "priority",
          "name": "Priority",
          "dataType": "STRING",
          "inputType": "SELECT",
          "required": true,
          "requiredWhen": {
            "match": "ALL",
            "conditions": [
              {
                "fieldId": "priority",
                "operator": "IN",
                "values": [
                  "override",
                  "set"
                ]
              }
            ]
          },
          "options": [
            {
              "id": "override",
              "name": "Override"
            }
          ],
          "unit": "°F"
        }
      ]
    }
  ],
  "page": 123,
  "limit": 123,
  "pageCount": 123,
  "itemCount": 123,
  "scope": "<string>",
  "buildings": 1,
  "points": 300
}

POST

https://api.kodelabs.com/kodeos

api

mass-write

point-groups

query

Discover mass write point groups

curl --request POST \
  --url https://api.kodelabs.com/kodeos/api/v1/mass-write/point-groups/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": {
    "buildingIds": [
      "<string>"
    ],
    "canonicalTypes": [
      "VAV"
    ],
    "kinds": [
      "Number"
    ],
    "fields": [
      "Space Temp Setpoint"
    ],
    "connectorTypes": [
      "API_JACE"
    ],
    "areaIds": [
      "<string>"
    ],
    "deviceIds": [
      "<string>"
    ],
    "nameContains": "Zone",
    "excludePointIds": [
      "<string>"
    ]
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: {
      buildingIds: ['<string>'],
      canonicalTypes: ['VAV'],
      kinds: ['Number'],
      fields: ['Space Temp Setpoint'],
      connectorTypes: ['API_JACE'],
      areaIds: ['<string>'],
      deviceIds: ['<string>'],
      nameContains: 'Zone',
      excludePointIds: ['<string>']
    }
  })
};

fetch('https://api.kodelabs.com/kodeos/api/v1/mass-write/point-groups/query', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.kodelabs.com/kodeos/api/v1/mass-write/point-groups/query"

payload = { "query": {
        "buildingIds": ["<string>"],
        "canonicalTypes": ["VAV"],
        "kinds": ["Number"],
        "fields": ["Space Temp Setpoint"],
        "connectorTypes": ["API_JACE"],
        "areaIds": ["<string>"],
        "deviceIds": ["<string>"],
        "nameContains": "Zone",
        "excludePointIds": ["<string>"]
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api.kodelabs.com/kodeos/api/v1/mass-write/point-groups/query' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "query": {
    "buildingIds": [
      "<string>"
    ],
    "canonicalTypes": [
      "VAV"
    ],
    "kinds": [
      "Number"
    ],
    "fields": [
      "Space Temp Setpoint"
    ],
    "connectorTypes": [
      "API_JACE"
    ],
    "areaIds": [
      "<string>"
    ],
    "deviceIds": [
      "<string>"
    ],
    "nameContains": "Zone",
    "excludePointIds": [
      "<string>"
    ]
  }
}'

{
  "data": [
    {
      "groupKey": "mw1.Yz3kR1a2B3c4D5e6F7g8H9",
      "kind": "Number",
      "connectorType": "API_JACE",
      "field": "Space Temp Setpoint",
      "templated": true,
      "unit": {
        "id": "fahrenheit",
        "symbol": "°F"
      },
      "pointEnum": [
        "False",
        "True"
      ],
      "points": 16,
      "fields": [
        {
          "id": "priority",
          "name": "Priority",
          "dataType": "STRING",
          "inputType": "SELECT",
          "required": true,
          "requiredWhen": {
            "match": "ALL",
            "conditions": [
              {
                "fieldId": "priority",
                "operator": "IN",
                "values": [
                  "override",
                  "set"
                ]
              }
            ]
          },
          "options": [
            {
              "id": "override",
              "name": "Override"
            }
          ],
          "unit": "°F"
        }
      ]
    }
  ],
  "page": 123,
  "limit": 123,
  "pageCount": 123,
  "itemCount": 123,
  "scope": "<string>",
  "buildings": 1,
  "points": 300
}

A group holds writable points of the same kind, connector type, field, and unit or enum values. Use the groups to build the writes of a plan for Validate or apply a mass write. The body holds a query. Only buildingIds is required. Every other member is a filter. A point must match every filter you send. A filter you leave out, or send as an empty list, does not restrict the result.

KODE API ignores a key it does not know, so a misspelled filter does not narrow the query. It widens it. Check points in the response before you write.

Only writable points are grouped. A query can match at most 30,000 points. A building outside your account returns 400, the same as a building that does not exist.

scope is PORTFOLIO when matched points are in more than one building. buildings and points count across all pages. KODE API ignores q, asc, and dsc. Groups come in a fixed order.

Authorizations

Authorization

string

header

required

Paste an access token from Create an access token. Tokens expire, so request a new one if you receive 401.

Query Parameters

limit

integer<int32>

default:50

Number of items per page, from 1 to 200. The default is 50.

Required range: 1 <= x <= 200

page

integer<int32>

default:1

Page number to return. The first page is 1.

Required range: x >= 1

Body

application/json

query

object

required

Selects the points to group.

Show child attributes

Response

A page of point groups.

data

object[]

Show child attributes

page

integer<int32>

limit

integer<int32>

pageCount

integer<int32>

itemCount

integer<int32>

scope

string

PORTFOLIO when the matched points are in more than one building. Otherwise BUILDING.

buildings

integer<int32>

Number of buildings with matched points.

Example:

1

points

integer<int64>

Number of points matched across all pages.

Example:

300

Get started

Guides

API reference

Discover mass write point groups

Authorizations

Query Parameters

Body

Response