Custom Properties

Custom properties are typed metadata which you can assign to devices, events, sessions, and episodes.

For example, you can create a device custom property identified with a key locationId and a type of string. This enables you to assign a location to each of your devices, view that data in Foxglove, and filter devices by a location ID.

Operations

List custom properties

Request

Security

ApiKey(Required scopes: properties.list)

Query

resourceTypestring

Filter properties matching a resource type

Enum:"device""event""session""episode"

Payload

// No request payload

Responses

The custom properties

Bodyapplication/json

Array [

idstringrequired

ID of the custom property

keystring, [ 1 .. 32 ] characters^[A-Za-z0-9_-]+$required

Immutable key that identifies this property in queries. For example, use the key partNumber in the query partNumber:456.

labelstring, [ 1 .. 32 ] charactersrequired

Display label for user interfaces. May be changed after saving.

resourceTypestringrequired

Resource type to which this custom property may be assigned

Enum:"device""event""session""episode"

valueTypestringrequired

The type of the values associated with this custom property Number values will be treated as IEEE 754 64-bit floats.

Enum:"string""multiline-string""number""enum""boolean""multi-enum"

enumValuesArray of strings, unique

Allowed string values; required if valueType is "enum"

valuesArray of strings, uniquedeprecated

Moved to enumValues. Allowed string values; required if valueType is "enum"

]

Response

[
  {
    "id": "string",
    "key": "string",
    "label": "string",
    "resourceType": "device",
    "valueType": "string",
    "values": [ … ],
    "enumValues": [ … ]
  }
]