AttributeDefinition

Represents a product, asset, or object attribute, for example, a hardward specification or software detail.

Introduced in API version 55.0.

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

  • Field Service must be enabled.
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort
  • Description: The data type of the attribute definition.
  • Possible values:
    • Checkbox — Checkbox
    • Date — Date
    • Datetime — Datetime
    • Number — Number
    • Picklist — Picklist
    • Text — Text
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The default value for this attribute.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Description of this attribute.

  • Type: string

  • Properties: Create, Filter, Group, Sort

  • Introduced: API version 57.0

  • Description:

    The unique name of the attribute definition record.

    This name must begin with a letter and use only alphanumeric characters and underscores. It can’t include spaces, end with an underscore, or have two consecutive underscores.

    The developer name is used for internal purpose and must be unique for all records (including deleted records). If the system doesn’t find the name unique, it automatically overrides the user input and creates a unique name. For external use, the developer name need not be fixed.

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Description:

    Indicates that the attribute definition is active. Active attributes definitions can be selected for assets.

    The default value is false.

  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Description:

    Indicates whether the attribute definition is required for an asset.

    The default value is false.

  • Default value: false

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name of the attribute.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort

  • Introduced: API version 56.0

  • Description:

    The ID of the attribute picklist with the valid values for this attribute.

    This field is a relationship field.

  • Relationship name: Picklist

  • Relationship type: relationship

  • Refers to: AttributePicklist

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 56.0
  • Description: The identifier of the attribute definition in an external system.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    The ID of the measurement unit for this attribute.

    This field is a relationship field.

  • Relationship name: UnitOfMeasure

  • Relationship type: relationship

  • Refers to: UnitOfMeasure

Add asset descriptors to the Asset object instead of creating multiple custom attributes on an asset. This helps scale to a high volume of various assets in the system. When you create the AttributeDefinition, you can provide a unique API name. If the API name is not unique, the system appends a number to the end of the API name. The value of this number depends on how many times the same name has been used.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.