---
schema_version: "1"
id: dcf6d8232884472aeef8d1d7efa777e966bda1dbd2ec3f8f5988aa3f0eec022f
title: RelationshipGraphDefinition
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/financial_services_cloud_object_reference/tooling_api_objects_relationshipgraphdefinition.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/tooling_api_objects_relationshipgraphdefinition.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 9047668ebc3a52142352fab91584834c2719cb4419bc1e81eb3f20f86f616361
description: Represents a definition of a graph that you can configure in your organization to traverse object hierarchies and record details, giving you a glimpse of how your business works. This object is available in API version 55.0 and later.
---
# RelationshipGraphDefinition

Represents a definition of a graph that you can configure in your organization to traverse object hierarchies and record details, giving you a glimpse of how your business works. This object is available in API version 55.0 and later.

![Important](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

## Supported SOAP API Calls

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

## Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

## Special Access Rules

The Financial Services Cloud permission set license is required to access this object.

## Fields

### DeveloperName

- **Type**: string
- **Properties**: Filter, Group, Sort
- **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. Label is **Record Type Name**.

### FullName

- **Type**: string
- **Properties**: Create, Group, Nillable
- **Description**: The full name of the associated relationship graph in Metadata API. The full name can include a namespace prefix. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

### IsActive

- **Type**: boolean
- **Properties**: Defaulted on create, Filter, Group, Sort
- **Description**: Indicates whether the relationship graph is available for use (true) or not (false).
    
    ![Note](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/images/icon_note.png)
    
    #### Note
    
    This field is read-only in API version 55.0.
- **Default value**: true

### IsTemplate

- **Type**: boolean
- **Properties**: Defaulted on create, Filter, Group, Sort
- **Description**: Indicates whether you can configure this relationship graph as a template (true) or not (false). In the UI, this field is **Set as Template**.
- **Default value**: false

### Language

- **Type**: picklist
- **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
- **Description**: The language of the relationship graph instance.
- **Possible values**:
    - da—Danish
    - de—German
    - en\_US—English
    - es—Spanish
    - es\_MX—Spanish (Mexico)
    - fi—Finnish
    - fr—French
    - it—Italian
    - ja—Japanese
    - ko—Korean
    - nl\_NL—Dutch
    - no—Norwegian
    - pt\_BR—Portuguese (Brazil)
    - ru—Russian
    - sv—Swedish
    - th—Thai
    - zh\_CN—Chinese (Simplified)
    - zh\_TW—Chinese (Traditional)

### ManageableState

- **Type**: ManageableState enumerated list
- **Properties**: Filter, Group, Nillable, Restricted picklist, Sort
- **Description**: Indicates the manageable state of the specified component that is contained in a package.
- **Possible values**:
    - beta
    - deleted
    - deprecated
    - deprecatedEditable
    - installed
    - installedEditable
    - released
    - unmanaged

### MasterLabel

- **Type**: string
- **Properties**: Filter, Group, Sort
- **Description**: Required. Label for the relationship graph instance. In the UI, this field is **Label**.

### Metadata

- **Type**: RelationshipGraphDefinition
- **Properties**: Create, Nillable, Update
- **Description**: The relationship graph’s metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

### NamespacePrefix

- **Type**: string
- **Properties**: Filter, Group, Nillable, Sort
- **Description**: The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation.
- **Possible values**:
    - In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer.
    - In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.

### RootObjectId

- **Type**: string
- **Properties**: Filter, Group, Sort
- **Description**: The ID of the root object, which is the starting point or parent node in the relationship graph. For example, in a graph that displays how accounts, contacts, and financial goals are related, the account object is the root object, and its ID is the RootObjectId.
    
    This field is a relationship field.
    
    ![Note](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/images/icon_note.png)
    
    #### Note
    
    Reserved for internal use.
- **Relationship Name**: RootObject
- **Relationship Type**: Lookup
- **Refers To**: EntityDefinition