AssetRelationship

Represents a non-hierarchical relationship between assets due to an asset modification; for example, a replacement, upgrade, or other circumstance. In Revenue Lifecycle Management, this object represents an asset or assets grouped in a bundle or set.

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

Introduced in API version 40.0.

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

  • Some fields are available only in Revenue Cloud. Field availability is noted in the field detail column.

  • 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: masterdetail

  • Refers to: Asset

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: An auto-generated number identifying the asset relationship.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 57.0
  • Description: Describes the position of the main asset relative to the other assets in the relationship. This field is available in orgs with Revenue Cloud.
  • Possible values:
    • Add-on — Add-on — The main asset is an add-on.
    • Bundle — Bundle — The main asset is the bundle parent.
    • Set — Set — The asset is the main asset in the set.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date when the new asset was installed.

  • Type: string

  • Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update

  • Introduced: API version 57.0

  • 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 in orgs with Revenue Cloud.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 60.0

  • 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 in Revenue Cloud.

  • Relationship name: ProductRelatedComponent

  • Relationship type: relationship

  • Refers to: ProductRelatedComponent

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 57.0

  • Description:

    The unique identifier of the record that describes the relationship between the main and associated assets. This field is available in orgs with Revenue Cloud.

    This field is a relationship field.

  • Relationship name: ProductRelationshipType

  • Relationship type: relationship

  • Refers to: ProductRelationshipType

  • 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: relationship

  • Refers to: Asset

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 59.0
  • Description: Specifies whether the price of the related asset is included in the bundle price. in Revenue Cloud.
  • Possible values:
    • IncludedInBundlePrice — IncludedInBundlePrice
    • NotIncludedInBundlePrice — NotIncludedInBundlePrice
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 59.0
  • Description: Specifies how the quantity of the related asset changes relative to the quantity of the parent asset. in Revenue Cloud.
  • Possible values:
    • Constant — Constant
    • Proportional — Proportional
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 57.0
  • Description: Describes the position of the associated asset relative to other assets in the relationship. This field is available in orgs with Revenue Cloud.
  • Possible values:
    • Add-on — Add-on — The main asset is an add-on.
    • Bundle — Bundle — The main asset is the bundle parent.
    • Set — Set — The asset is the main asset in the set.
    • Simple — Simple — The asset is purchased individually and isn’t associated with variations.
    • Variation Parent — Variation Parent — —The main asset is the variation parent.

  • Type: picklist

  • Properties: 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.

    The default value is Replacement.

  • Possible values:

    • Crossgrade — 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 — Replacement (default) — 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 — 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.

  • Default value: Replacement

  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date when the modified asset is uninstalled.

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.