{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"usage",
"associated_objects",
"wsdl_segment",
"field_reference"
],
"title": "AttributeDefinition - Data API",
"description": "Represents a product, asset, or object attribute, for example, a hardward specification or software detail. This object is available in API version 57.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"DataType": {
"type": "picklist",
"properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
"description": "The data type of the attribute definition. Possible values are: Checkbox Date Datetime Number Picklist Text"
},
"DefaultValue": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The default value for this attribute."
},
"Description": {
"type": "textarea",
"properties": "Create, Nillable, Update",
"description": "Description of this attribute."
},
"DeveloperName": {
"type": "string",
"properties": "Create, Filter, Group, Sort",
"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."
},
"IsActive": {
"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."
},
"IsRequired": {
"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."
},
"Label": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The label for the attribute. Displays a friendly name for the attribute, for example, threshold monitor lightning component and recordset filter criteria rule."
},
"LastReferencedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The date the attribute definition was last referenced."
},
"LastViewedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The date the attribute definition was last viewed."
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "The name of the attribute."
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "The owner of the attribute definition. This field is a polymorphic relationship field.",
"relationship_name": "Owner",
"relationship_type": "Lookup",
"refers_to": "Group, User"
},
"PicklistId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"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": "Lookup",
"refers_to": "AttributePicklist"
},
"SourceSystemIdentifier": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The identifier of the attribute definition in an external system."
},
"UnitOfMeasureId": {
"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": "Lookup",
"refers_to": "UnitOfMeasure"
}
},
"special_access_rules": "Field Service must be enabled.",
"usage": "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.",
"associated_objects": "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 and later.\n\n- **AttributeDefinitionHistory**: History is available for tracked fields of the object.\n- **AttributeDefinitionOwnerSharingRule**: Sharing rules are available for the object.\n- **AttributeDefinitionShare**: Sharing is available for the object.",
"wsdl_segment": "```xml\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n\n\n \n \n \n \n \n \n\n```",
"field_reference": {
"Code": {
"field_label": "Code",
"type": "string",
"length": "80"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"CurrencyIsoCode": {
"field_label": "Currency ISO Code",
"type": "picklist",
"length": "3"
},
"DataType": {
"field_label": "Data Type",
"type": "picklist",
"length": "255"
},
"DefaultHelpText": {
"field_label": "Default Help Text",
"type": "textarea",
"length": "32000"
},
"DefaultValue": {
"field_label": "Default Value",
"type": "string",
"length": "255"
},
"Description": {
"field_label": "Description",
"type": "textarea",
"length": "32000"
},
"DeveloperName": {
"field_label": "API Name",
"type": "string",
"length": "80"
},
"Id": {
"field_label": "Attribute Definition ID",
"type": "id",
"length": "18"
},
"IsActive": {
"field_label": "Active",
"type": "boolean"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"IsRequired": {
"field_label": "Required",
"type": "boolean"
},
"Label": {
"field_label": "Label",
"type": "string",
"length": "255"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"LastReferencedDate": {
"field_label": "Last Referenced Date",
"type": "datetime"
},
"LastViewedDate": {
"field_label": "Last Viewed Date",
"type": "datetime"
},
"Name": {
"field_label": "Name",
"type": "string",
"length": "255"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"PicklistId": {
"field_label": "Attribute Picklist ID",
"type": "reference",
"length": "18"
},
"SourceSystemIdentifier": {
"field_label": "Source System ID",
"type": "string",
"length": "255"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"UnitOfMeasureId": {
"field_label": "Unit of Measure ID",
"type": "reference",
"length": "18"
},
"ValueDescription": {
"field_label": "Value Description",
"type": "textarea",
"length": "32000"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}