CnfgItemTypeAttrRelDef

Represents the definition of a relationship between a configuration item type and an attribute that’s applicable for the item type. For example, a server configuration item type has the attributes manufacturer, name, and IP address. This object is available in API version 65.0 and later.

Supported SOAP API Calls

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

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Fields

CnfgItemAttrDefId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The configuration item attribute definition that’s applied to an item type. This field is a relationship field.
Relationship Name: CnfgItemAttrDef
Refers To: CnfgItemAttrDef

CnfgItemTypeDefId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The configuration item type definition to which an attribute applies. This field is a relationship field.
Relationship Name: CnfgItemTypeDef
Refers To: CnfgItemTypeDef

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.

IsActive

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Specifies if the relationship between an attribute and a configuration type 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

IsHidden

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Specifies if an attribute is public or hidden for access for a specific configuration item type or not.
Default value: false

IsPrimary

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Specifies whether an attribute is a primary attribute for a specific configuration item type or not.
Default value: false

IsReadOnly

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Specifies whether it’s a ReadOnly attribute (true) or can be edited by Customer (false).
Default value: false

IsRequired

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Specifies whether an attribute is a required attribute for a specific configuration item type or not.
Default value: false

IsUsedInRelMap

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Specifies whether an attribute is used to determine relationships between two configuration items or not. While some attributes when related to an item type can be used in determining relationship mappings, other attributes are not used for this purpose.
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 configuration Item type attribute definition.

MasterLabel

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