Newer Version Available

This content describes an older version of this product. View Latest

AssetRelationship

Represents a non-hierarchical relationship between assets due to an asset modification; for example, a replacement, upgrade, or other circumstance. In Subscription Management and CoreCPQ, this object represents an asset or assets grouped in a bundle or set. This object is available in API version 41.0 and later.

Asset relationships appear in the Primary Assets and Related Assets related lists on asset records in the UI.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

The AssetRole, ProductRelationshipTypeId, and RelatedAssetRole fields are available in version 58.0 and later when Subscription Management is enabled.

Fields

Field Name Details
AssetId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The unique identifier of the new asset, which is the asset that is taking the place of the existing asset.
This field is a relationship field.
Relationship Name
Asset
Relationship Type
Lookup
Refers To
Asset
AssetRelationshipNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
An auto-generated number identifying the asset relationship.
AssetRole
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Describes the position of the main asset relative to the other assets in the relationship.
This field is available in API version 58.0 and later. This field is available if Subscription Management is enabled.
Possible values are:
  • Add-on—The main asset is an add-on.
  • Bundle—The main asset is the bundle parent.
  • Set—The asset is the main asset in the set.
  • Simple—The asset is purchased individually and isn’t associated with variations.
  • Variation Parent——The main asset is the variation parent.
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Three-letter ISO 4217 currency code associated with the asset. The default value is USD.
FromDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date when the new asset is installed.
GroupingKey
Type
string
Properties
Filter, Group, idLookup, Nillable, Sort
Description
Read-only field used to indicate the bundle that an asset belongs to. For example, if two assets have the same GroupingKey value, then it means that the assets are bundled together.
This field is available in API v.60.0 and later. This field is available if Subscription Management or CoreCPQ is enabled.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
Its label in the user interface is Last Modified Date.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate), but not viewed it.
ProductRelationshipTypeId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The unique identifier of the record that describes the relationship between the main and associated assets.
This field is available in API version 58.0 and later. This field is available if Subscription Management is enabled.
This field is a relationship field.
Relationship Name
ProductRelationshipType
Relationship Type
Lookup
Refers To
ProductRelationshipType
ProductRelatedComponent
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The product related component that’s associated with the asset relationship.
This field is a relationship field.
This field is available in API 60.0 and later.
Relationship Name
ProductRelatedComponent
Relationship Type
Lookup
Refers To
ProductRelatedComponent
RelatedAssetId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The existing asset that is being modified.
This field is a relationship field.
Relationship Name
RelatedAsset
Relationship Type
Lookup
Refers To
Asset
RelatedAssetRole
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Describes the position of the associated asset relative to other assets in the relationship.
This field is available in API version 58.0 and later. This field is available if Subscription Management is enabled.
Possible values are:
  • Add-on—The main asset is an add-on.
  • Bundle—The main asset is the bundle parent.
  • Set—The asset is the main asset in the set.
  • Simple—The asset is purchased individually and isn’t associated with variations.
  • Variation Parent——The main asset is the variation parent.
RelationshipType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The type of relationship between the existing asset and the new asset. This field comes with three values—Replacement, Upgrade, and Crossgrade—, but you can create more values in Setup.
Possible values are:
  • Crossgrade—The new asset is a crossgrade of an existing asset. For example, changing a subscription to a plan with the same service, but that runs for a longer amount of time.
  • Replacement—The new asset is replacing an existing asset. For example, a customer’s faulty widget that was under warranty is being replaced with a new one.
  • Upgrade—The new asset is an upgrade of an existing asset. For example, upgrading a customer’s existing subscription plan to a new plan with more services.
The default value is Replacement.
ToDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date when the modified asset is uninstalled.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

AssetRelationshipChangeEvent (Available in API version 58.0)
Change events are available for the object.
AssetRelationshipFeed
Feed tracking is available for the object.
AssetRelationshipHistory
History is available for tracked fields of the object.
AssetRelationshipOwnerSharingRule (Available in API version 58.0)
Sharing rules are available for the object.
AssetRelationshipShare (Available in API version 58.0)
Sharing is available for the object.