CnfgItemAttrDef

Represents the definition of an attribute or a property for a configuration item. Each attribute of a configuration item can be defined with characterists such as whether the attribute is hidden, mandatory, what’s the data type, status, and so on. For example, CI name, CI owner, Status, and so on. This object is available in API version 65.0 and later.

Supported SOAP API Calls

create(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

GET, HEAD, PATCH, POST, Query

Fields

CnfgItemAttrPicklistDefId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The attribute picklist definition related to this attribute when the attribute supports multiple possible values. This field is a relationship field.
Relationship Name: CnfgItemAttrPicklistDef
Refers To: CnfgItemAttrPicklistDef

DataType

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: The data type of a configuration item attribute, such as integer, text, boolean, or picklist.
Possible values:
- Boolean
- Date
- Double
- Integer
- Text

DeveloperName

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. This field is automatically generated, but you can supply your own value if you create the record using the API. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record.

DisplayOrder

Type: string
Properties: Autonumber, Defaulted on create, Filter, Sort
Description: The display order of an attribute that determines the sequence in which the attribute is shown to a user.

IsActive

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Specifies whether an attribute is active or not.
Default value: false

IsCustom

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Specifies whether it’s a custom attribute (true) or a predefined attribute that’s shipped out of the box (false).
Default value: false

IsDataValidationRequired

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Specifies whether the attribute requires data validation at field-level (true) or not (false).

IsHidden

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Specifies whether this attribute is hidden from display or not.
Default value: false

IsMain

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the attribute displays on the configuration item details page when the Show Main Properties toggle is on (true) or not (false).
Default value: false

IsRequired

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Specifies whether an attribute is required as mandatory or not.
Default value: false

IsSearchable

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether this attribute is included in configuration item search queries (true) or not (false).
Default value: false

IsUsedForCorrelation

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Specifies whether this attribute is used to correlate two configuration item records or not.
Default value: false

Language

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The combined language and locale ISO code, which controls the language of the CnfgItemAttrDef.

MasterLabel

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: The label for this CnfgItemAttrDef value. This display value is the internal label that doesn’t get translated.

MatchingType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Indicates how configuration item search filters compare values for this attribute. Applies only to text and picklist attributes. Exact requires an exact match. Fuzzy matches approximate values.
Possible values:
- Exact
- Fuzzy

Name

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: The name of a configuration item attribute.

ReferenceObject

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Name of the platform object referenced by this lookup-relationship attribute. For example, account, lead, and user.