CnfgItemTypeDef

Represents the definition of a configuration item type. A configuration item type represents a category that is used to classify configuration items. The components share common characteristics. For example, server, application, and network device. 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

Description

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: The description of a configuration item type definition.

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.

IsComponent

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether a configuration item type is a component (true) or not. A component item type cannot exist as a standalone item.
Default value: false

IsCustom

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether a configuration item type is shipped out of the box (false) or is custom (true).
Default value: false

IsUsedForTransientCnfgItm

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Specifies whether the configuration items associated with this type are transient 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 configuration item type definition.

MasterLabel

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

Name

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

Status

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the status of a configuration item type definition in relation to other records where it’s referenced. This field is used internally to identify configuration item types which may be active or inactive but no actual configuration items were created using that type and are still in use. Values are Unused or Used.