Edit a custom property

Request

Security

ApiKey(Required scopes: properties.update)

Path

idstringrequired

Custom Property ID

Bodyapplication/jsonrequired

labelstring, [ 1 .. 32 ] characters

Display label for user interfaces

enumValuesArray of strings, unique

Reorder or add to enum values. Must be a superset of existing values.

valuesArray of strings, uniquedeprecated

Moved to enumValues. Reorder or add to enum values. Must be a superset of existing values.

Payload

{
  "label": "string",
  "values": [
    "string"
  ],
  "enumValues": [
    "string"
  ]
}

Responses

The custom property

Bodyapplication/json

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": [
    "string"
  ],
  "enumValues": [
    "string"
  ]
}