Connect supports two types of attributes - standard and custom, with different ways to onboard that data as well. For details on setting standard attributes via API, review this article.
For details on setting either standard or custom attributes via the Property Config UI, review this article.
For instructions on setting custom attributes via API, continue reading below.
For Buildings
1) Set custom attributes for a building
Note: This mutation updates ALL matching custom attributes with the provided input, otherwise adds the provided custom attributes.
mutation {
setBuildingCustomAttributes(
input: {
entityId: "b119e985-ea4a-4d19-b135-0be70a3ab505"
customAttributes: [
{ key: "year of construction", value: "2020" }
}
) {
id
name
customAttributes {
key
value
}
}
}
2) Replace custom attributes for a building
Note: Removes any existing custom attributes and sets the provided custom attributes on the building.
mutation {
replaceBuildingCustomAttributes(
input: {
entityId: "b119e985-ea4a-4d19-b135-0be70a3ab505"
customAttributes: [
{ key: "height", value: "20 ft" }
{ key: "year of construction", value: "2021" }
]
}
) {
id
name
customAttributes {
key
value
}
}
}
3) Delete a custom attribute from a building
mutation {
deleteBuildingCustomAttribute(
input: {
entityId: "b119e985-ea4a-4d19-b135-0be70a3ab505"
customAttributeKey: "year of construction"
}
) {
id
name
customAttributes {
key
value
}
}
}
4) Retrieve custom attributes on a building (for example building by id query)
query {
building(id: "b119e985-ea4a-4d19-b135-0be70a3ab505") {
id
name
customAttributes {
key
value
}
}
}
For Equipment
1) Sets custom attributes for an equipment
Note: Updates all matching custom attributes with the provided input otherwise adds the provided custom attributes.
mutation{ setEquipmentCustomAttributes(input:{ entityId:"" customAttributes: [{ key:"" value:"" }] }){ id name customAttributes{ key value } } }
2) Replace custom attributes for an equipment
Note: Removes any existing custom attribute and sets the provided custom attributes on the equipment.
mutation {
replaceEquipmentCustomAttributes(
input: {
entityId: "b119e985-ea4a-4d19-b135-0be70a3ab505"
customAttributes: []
}
) {
id
name
customAttributes {
key
value
}
}
}
3) Delete a custom attribute from an equipment
mutation {
deleteEquipmentCustomAttribute(
input: {
entityId: "b119e985-ea4a-4d19-b135-0be70a3ab505"
customAttributeKey: "type of maintenance"
}
) {
id
name
customAttributes {
key
value
}
}
}
4) Retrieve custom attributes on an equipment (for example equipment by id query)
equipment {
building(id: "b119e985-ea4a-4d19-b135-0be70a3ab505") {
id
name
customAttributes {
key
value
}
}
}