CnfgMgmtRelationTypeDef

Represents the relationship between configuration item types or configuration items as defined in the CMDB. For example, Depends on or Connected to. 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

ColorCode

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: A specific color value such as hex, RGB, or named assigned to visually represent the relationship type for easier identification and categorization.

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.

DirectRelationshipName

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: The main name assigned to the relationship type for consistent labeling and referencing.

InverseRelationshipName

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: An alternative or mirrored name of the relationship type, used for reverse lookup, searching, or display purposes. For example, the inverse of Runs on is Hosts.

IsActive

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the relationship type is archived (true) or active (false). Archived relationship types are retained for reference but not actively used or updated.
Default value: false

IsCustom

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Specifies if the relationship type is a custom relationship type as defined by the user (true) or a ready-to-use relationship type that’s predefined and shipped out of the box (false).
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 management relationship type definition.

LineStrokeSpecification

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the width, style, or color of a line element for consistent visual rendering.

MasterLabel

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

Status

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Indicates the current usage status of the relationship type, specifying whether it is actively referenced by CI relationships. Values are Unused or Used.