Skip to main content

# CustomAttributeDefinition

A custom attribute definition.

    type CustomAttributeDefinition {
      id: ID!
      name: String
      defaultValue: String
      dataType: CustomAttributeDataType!
      systemTypes: [MonitoredSystemType!]!
      mandatory: Boolean!
      maxLength: Int
      values: [String!]
    }

### Fields​

#### `CustomAttributeDefinition.id` ● `ID!` non-null scalar​

The id of this definition.

#### `CustomAttributeDefinition.name` ● `String` scalar​

The name of this custom attribute type.

#### `CustomAttributeDefinition.defaultValue` ● `String` scalar​

An optional default value.

#### `CustomAttributeDefinition.dataType` ● `CustomAttributeDataType!` non-null enum​

A simple attribute value type: text, enum

#### `CustomAttributeDefinition.systemTypes` ● `[MonitoredSystemType!]!` non-null enum​

For which monitored system type the custom attribute can be used.

#### `CustomAttributeDefinition.mandatory` ● `Boolean!` non-null scalar​

Whether this attribute is mandatory or not.

#### `CustomAttributeDefinition.maxLength` ● `Int` scalar​

An optional max length for a value.

#### `CustomAttributeDefinition.values` ● `[String!]` list scalar​

If this is a enum (see datatype) this list contains the possible values for a custom attribute. If this is any other datatype the field will be null.

### Returned By​

`customAttributeDefinition` query ● `customAttributeDefinitions` query

### Member Of​

`CustomAttribute` object