Jump to

• Request
• Response

The resource used to view a single consolidated asset.

get

/crmRestApi/resources/11.13.18.05/consolidatedAssets/{AssetGroupId}

Request

Path Parameters

• AssetGroupId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : consolidatedAssets-item-response

Type: object

Show Source

• AccountAddress: string
  Title: Account Address

  Read Only: true

  Maximum Length: 429

  Customer Account Site Address
• AccountId: integer (int64)
  Title: Account ID

  Read Only: true

  Customer account identifier from Installed Base assets or Subscription Management product source data.
• AccountName: string
  Title: Account Name

  Read Only: true

  Maximum Length: 900

  Customer account name from Installed Base assets or Subscription Management product source data.
• AccountNumber: string
  Title: Account Number

  Read Only: true

  Maximum Length: 30

  Bill-to customer account number from Installed Base assets or Subscription Management product source data.
• AssetCount: number
  Title: Asset Count

  Read Only: true

  Number of active serialized asset rows represented by this asset group. Derived by counting nondeleted rows in CPQ_SERIALIZED_ASSETS.
• AssetEffectiveEndDate: string (date)
  Title: End Date

  Read Only: true

  Derived asset start date used by CPQ views for filtering and display.
• AssetEffectiveStartDate: string (date)
  Title: Start Date

  Read Only: true

  Derived asset end date used by CPQ views for filtering and display.
• AssetGroupId: integer
  Title: Asset Group ID

  Read Only: true

  Asset group identifier from the source sold asset group for this row.
• AssetGroupNumber: string
  Title: Asset Group Number

  Read Only: true

  Maximum Length: 80

  Asset group identifier from the source sold asset group for this row.
• AssetNumber: string
  Title: Asset Number

  Read Only: true

  Maximum Length: 80

  User-visible Installed Base asset number copied from the source asset.
• AssetProductType: string
  Title: Asset Product Type

  Read Only: true

  Maximum Length: 30

  Serialized asset bucket derived from the sales product type for routing and display.
• BillToAccountId: integer (int64)
  Title: Bill-to Account ID

  Read Only: true

  Bill-to customer account identifier from Installed Base assets for goods or Subscription Management product for subscriptions.
• BillToAccountName: string
  Title: Bill-to Account Name

  Read Only: true

  Maximum Length: 240

  Bill-to customer account name from Installed Base assets or Subscription Management product source data.
• BillToAccountNumber: string
  Title: Bill-to Account Number

  Read Only: true

  Maximum Length: 30

  Bill-to customer account number from Installed Base assets or Subscription Management product source data.
• BillToAccountSite: string
  Title: Bill-to Account Site

  Read Only: true

  Maximum Length: 429

  Bill-to party site address from Installed Base assets or derived from bill-to site use.
• BillToAccountSiteId: integer (int64)
  Title: Bill-to Account Site ID

  Read Only: true

  Customer Account Site ID
• BillToContactId: integer (int64)
  Title: Bill-to Contact ID

  Read Only: true

  Bill-to contact number from Installed Base assets for goods or Subscription Management for subscriptions.
• BillToContactName: string
  Title: Bill-to Contact Name

  Read Only: true

  Maximum Length: 900

  Bill-to contact name from Installed Base assets for goods or Subscription Management product for subscriptions.
• BillToContactNumber: string
  Title: Bill-to Contact Number

  Read Only: true

  Maximum Length: 30

  Bill-to contact number from Installed Base assets for goods or Subscription Management for subscriptions.
• BillToPartyId: integer (int64)
  Title: Bill-to Party ID

  Read Only: true

  Bill-to party identifier from Installed Base assets for goods or Subscription Management product for subscriptions.
• BillToPartyName: string
  Title: Bill-to Party Name

  Read Only: true

  Maximum Length: 900

  Bill-to party name from Installed Base assets for goods or Subscription Management product for subscriptions.
• BillToPartyNumber: string
  Title: Bill-to Party Number

  Read Only: true

  Maximum Length: 30

  Bill-to party number from Installed Base assets for goods or Subscription Management product for subscriptions.
• BillToPartySite: string
  Title: Bill-to Party Site

  Read Only: true

  Maximum Length: 429

  Bill-to party site address from Installed Base assets or derived from bill-to site use.
• BillToPartySiteId: integer (int64)
  Title: Bill-to Party Site ID

  Read Only: true

  Bill-to party site identifier from Installed Base assets or derived from bill-to site use.
• BillToSiteUseId: integer (int64)
  Title: Bill-to Site Use ID

  Read Only: true

  Bill-to customer site use identifier from Installed Base assets or Subscription Management product source data.
• BOMItemType: number
  Title: Structure Item Type

  Read Only: true

  Bill of material item type copied from Product Information Management.
• BOMItemTypeLabel: string
  Title: Structure Item Type Label

  Read Only: true

  Maximum Length: 30

  Display label derived from the bill of material item type value.
• ClosedDate: string (date)
  Title: Closed Date

  Read Only: true

  Closed date copied from the Subscription Management product for lifecycle handling.
• ConfigHeaderId: integer (int64)
  Title: Configuration Header ID

  Read Only: true

  Configuration header identifier preferred from the asset group or otherwise from the Installed Base asset.
• ConfigRevisionNumber: integer (int64)
  Title: Configuration Revision Number

  Read Only: true

  Configuration revision number preferred from the asset group or otherwise from the Installed Base asset.
• ConfiguratorPath: string
  Title: Configurator Path

  Read Only: true

  Maximum Length: 2000

  Configurator path preferred from asset group and otherwise from Installed Base asset.
• CoveredItemAssetGroupId: integer (int64)
  Title: Covered Item Asset Group ID

  Read Only: true

  Asset group identifier for the item covered by the Subscription Management product.
• Currency: string
  Title: Currency

  Read Only: true

  Maximum Length: 80

  Currency code from the Installed Base asset for goods or Subscription Management product for subscriptions.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 15

  Currency code from the Installed Base asset for goods or Subscription Management product for subscriptions.
• CurrentAddress: string
  Title: Current Address

  Read Only: true

  Maximum Length: 429

  Current address of the asset.
• CurrentOvnMatchingFlag: boolean
  Title: Current Object Version Number Matching

  Read Only: true

  Maximum Length: 1

  Indicator specifying whether the Installed Base, Subscription Management, and Group Object Version Numbers match. Reads True if the Installed Base Subscription Management and Group Object Version Numbers are the same as in the CPQ read model tables.
• CustomerId: integer (int64)
  Title: Customer ID

  Read Only: true

  Sold-to party identifier copied from the Installed Base customer party.
• CustomerName: string
  Title: Customer Name

  Read Only: true

  Maximum Length: 900

  Sold-to party name copied from the Installed Base customer party.
• CustomerNumber: string
  Title: Customer Number

  Read Only: true

  Maximum Length: 30

  Sold-to party number copied from the Installed Base customer party.
• FulfillLineId: integer (int64)
  Title: Fulfillment Line ID

  Read Only: true

  Fulfillment line identifier associated with the source asset group or asset.
• GroupEndDate: string (date)
  Title: Asset Group End Date

  Read Only: true

  End date copied from the source sold asset group.
• GroupStartDate: string (date)
  Title: Asset Group Start Date

  Read Only: true

  Start date copied from the source sold asset group.
• HasAssetChildren: string
  Title: Has Asset Children

  Read Only: true

  Maximum Length: 1

  Indicates whether this asset has at least one active child asset relationship.
• HasAssociatedAssets: string
  Title: Has Associated Assets

  Read Only: true

  Maximum Length: 1

  Indicates whether this subscription row has associated assets under the product.
• HasAssociations: string
  Title: Has Associations

  Read Only: true

  Maximum Length: 1

  Indicates whether this asset is associated with at least one subscription product.
• HasCoverages: string
  Title: Has Coverages

  Read Only: true

  Maximum Length: 1

  Indicates whether this asset is covered by at least one subscription coverage product.
• HasCoveredLevels: string
  Title: Has Covered Levels

  Read Only: true

  Maximum Length: 1

  Indicates whether this coverage row has covered levels under the subscription product.
• HasFutureState: string
  Title: Has Future Asset

  Read Only: true

  Maximum Length: 1

  Indicates whether this read-model row has a future-dated asset state from a renewal or amendment.
• IbEndDate: string (date-time)
  Title: Installed Base End Date

  Read Only: true

  Customer asset end date copied from the Installed Base asset.
• IbStartDate: string (date-time)
  Title: Installed Base Start Date

  Read Only: true

  Customer asset start date copied from the Installed Base asset.
• IbStatus: string
  Title: Asset Status

  Read Only: true

  Maximum Length: 80

  Operational status code copied from the Installed Base asset.
• IbStatusCode: string
  Title: Asset Status Code

  Read Only: true

  Maximum Length: 30

  Operational status code copied from the Installed Base asset.
• InactiveFlag: boolean
  Title: Inactive

  Read Only: true

  Maximum Length: 1

  Indicates whether the read-model row is inactive because it no longer qualifies.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Product item number copied from Product Information Management for display and search.
• ItemId: integer (int64)
  Title: Item Number

  Read Only: true

  Inventory item identifier copied from the Installed Base asset.
• ItemNumber: string
  Title: Item

  Read Only: true

  Maximum Length: 300

  Product item number copied from Product Information Management for display and search.
• ItemOrganizationId: integer (int64)
  Title: Organization ID

  Read Only: true

  Item organization identifier used with item ID for Product Master joins.
• ItemOrganizationName: string
  Title: Item Organization Name

  Read Only: true

  Maximum Length: 240

  Item organization identifier used with item ID for Product Master joins.
• ItemType: string
  Title: Item Type

  Read Only: true

  Maximum Length: 30

  Product item type copied from Product Information Management.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Who column that indicates the date and time of the last update of the row.
• LegalEntityId: integer (int64)
  Title: Legal Entity ID

  Read Only: true

  Legal entity identifier copied from the Subscription Management header.
• LegalEntityName: string
  Title: Legal Entity Name

  Read Only: true

  Maximum Length: 240

  Legal entity identifier copied from the Subscription Management header.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  Read Only: true

  Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• OssEndDate: string (date)
  Title: Subscription End Date

  Read Only: true

  End date copied from the Subscription Management product for lineage and reconciliation.
• OssStartDate: string (date)
  Title: Subscription Start Date

  Read Only: true

  Start date copied from the Subscription Management product for lineage and reconciliation.
• OssStatus: string
  Title: Subscription Status

  Read Only: true

  Maximum Length: 30

  Lifecycle status copied from the Subscription Management product.
• OssStatusCode: string
  Title: Subscription Status Code

  Read Only: true

  Maximum Length: 30

  Lifecycle status copied from the Subscription Management product.
• ParentAssetGroupId: integer (int64)
  Title: Parent Asset Group ID

  Read Only: true

  Parent asset group identifier derived from asset hierarchy and configuration context.
• ParentAssetId: integer (int64)
  Title: Parent Asset ID

  Read Only: true

  Immediate parent Installed Base asset derived from active asset relationships.
• Quantity: number
  Title: Quantity

  Read Only: true

  Product Instance Quantity copied from the Installed Base asset.
• RepresentativeAssetId: integer (int64)
  Title: Representative Asset ID

  Read Only: true

  Asset identifier selected as the representative serialized asset for the group. Used by the consolidated view to join back to CPQ_SERIALIZED_ASSETS for descriptive fields.
• RootAssetGroupId: integer (int64)
  Title: Root Asset Group ID

  Read Only: true

  Root asset group identifier derived from hierarchy and configuration context.
• RootAssetId: integer (int64)
  Title: Root Asset ID

  Read Only: true

  Root Installed Base asset derived from active asset relationships or set to self.
• SalesOrderId: integer (int64)
  Title: Sales Order ID

  Read Only: true

  Sales order header identifier from Installed Base assets or Subscription Management product source data.
• SalesOrderLineId: integer (int64)
  Title: Sales Order Line ID

  Read Only: true

  Sales order line identifier from Installed Base assets for goods or Subscription Management product for subscriptions.
• SalesOrderLineNumber: string
  Title: Sales Order Line Number

  Read Only: true

  Maximum Length: 100

  User-facing source sales order line number from Installed Base assets or Subscription Management product source data.
• SalesOrderNumber: string
  Title: Sales Order Number

  Read Only: true

  Maximum Length: 200

  User-facing source sales order number from Installed Base assets or Subscription Management product source data.
• SalesOrderSourceSystem: string
  Title: Sales Order Source System

  Read Only: true

  Maximum Length: 30

  Source system code for the sales order captured on the Installed Base asset.
• SalesProductType: string
  Title: Sales Product Type

  Read Only: true

  Maximum Length: 30

  Product sales classification copied from Product Information Management.
• SalesProductTypeCode: string
  Title: Sales Product Type Code

  Read Only: true

  Maximum Length: 30

  Product sales classification copied from Product Information Management.
• SerialNumber: string
  Title: Serial Number

  Read Only: true

  Maximum Length: 80

  Serial number copied from the source Installed Base asset when available.
• ShipToPartyId: integer (int64)
  Title: Ship-to Party ID

  Read Only: true

  Ship-to party identifier from Installed Base assets for goods or Subscription Management product for subscriptions.
• ShipToPartyName: string
  Title: Ship-to Party Name

  Read Only: true

  Maximum Length: 900

  Ship-to party name from Installed Base assets for goods or Subscription Management product for subscriptions.
• ShipToPartyNumber: string
  Title: Ship-to Party Number

  Read Only: true

  Maximum Length: 30

  Ship-to party number from Installed Base assets for goods or Subscription Management product for subscriptions.
• ShipToPartySite: string
  Title: Ship-to Party Site

  Read Only: true

  Maximum Length: 429

  Ship-to party site address from Installed Base assets for goods or Subscription Management product for subscriptions.
• ShipToPartySiteId: integer (int64)
  Title: Ship-to Party Site ID

  Read Only: true

  Ship-to party site identifier from Installed Base assets or Subscription Management product source data.
• SoldByBusinessUnitId: integer (int64)
  Title: Sold-by Business Unit ID

  Read Only: true

  Business unit identifier that sold the asset or subscription.
• SoldByBusinessUnitName: string
  Title: Sold-by Business Unit Name

  Read Only: true

  Maximum Length: 240

  Business unit identifier that sold the asset or subscription.
• SubscriptionId: integer (int64)
  Title: Subscription ID

  Read Only: true

  Subscription header identifier copied from the subscription header.
• SubscriptionNumber: string
  Title: Subscription Number

  Read Only: true

  Maximum Length: 120

  Subscription number copied from the subscription header for subscription rows.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  Read Only: true

  Subscription Management identifier used to join asset group rows to Subscription Management products.
• SubscriptionProductPuid: string
  Title: Subscription Product PUID

  Read Only: true

  Maximum Length: 120

  Public unique identifier copied from Subscription Management.
• SuspendedDate: string (date)
  Title: Suspended Date

  Read Only: true

  Suspended date copied from Subscription Management for lifecycle handling.
• UOM: string
  Title: UOM

  Read Only: true

  Maximum Length: 80

  Unit of measure code copied from the Installed Base asset.
• UOMCode: string
  Title: UOM Code

  Read Only: true

  Maximum Length: 3

  Unit of measure code copied from the Installed Base asset.

{
    "type":"object",
    "properties":{
        "AccountAddress":{
            "title":"Account Address",
            "maxLength":429,
            "type":"string",
            "description":"Customer Account Site Address",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountId":{
            "title":"Account ID",
            "type":"integer",
            "description":"Customer account identifier from Installed Base assets or Subscription Management product source data.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account Name",
            "maxLength":900,
            "type":"string",
            "description":"Customer account name from Installed Base assets or Subscription Management product source data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountNumber":{
            "title":"Account Number",
            "maxLength":30,
            "type":"string",
            "description":"Bill-to customer account number from Installed Base assets or Subscription Management product source data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetCount":{
            "title":"Asset Count",
            "type":"number",
            "description":"Number of active serialized asset rows represented by this asset group. Derived by counting nondeleted rows in CPQ_SERIALIZED_ASSETS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetEffectiveEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Derived asset start date used by CPQ views for filtering and display.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetEffectiveStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Derived asset end date used by CPQ views for filtering and display.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetGroupId":{
            "title":"Asset Group ID",
            "type":"integer",
            "description":"Asset group identifier from the source sold asset group for this row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetGroupNumber":{
            "title":"Asset Group Number",
            "maxLength":80,
            "type":"string",
            "description":"Asset group identifier from the source sold asset group for this row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":80,
            "type":"string",
            "description":"User-visible Installed Base asset number copied from the source asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetProductType":{
            "title":"Asset Product Type",
            "maxLength":30,
            "type":"string",
            "description":"Serialized asset bucket derived from the sales product type for routing and display.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BOMItemType":{
            "title":"Structure Item Type",
            "type":"number",
            "description":"Bill of material item type copied from Product Information Management.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BOMItemTypeLabel":{
            "title":"Structure Item Type Label",
            "maxLength":30,
            "type":"string",
            "description":"Display label derived from the bill of material item type value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToAccountId":{
            "title":"Bill-to Account ID",
            "type":"integer",
            "description":"Bill-to customer account identifier from Installed Base assets for goods or Subscription Management product for subscriptions.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillToAccountName":{
            "title":"Bill-to Account Name",
            "maxLength":240,
            "type":"string",
            "description":"Bill-to customer account name from Installed Base assets or Subscription Management product source data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToAccountNumber":{
            "title":"Bill-to Account Number",
            "maxLength":30,
            "type":"string",
            "description":"Bill-to customer account number from Installed Base assets or Subscription Management product source data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToAccountSite":{
            "title":"Bill-to Account Site",
            "maxLength":429,
            "type":"string",
            "description":"Bill-to party site address from Installed Base assets or derived from bill-to site use.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToAccountSiteId":{
            "title":"Bill-to Account Site ID",
            "type":"integer",
            "description":"Customer Account Site ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillToContactId":{
            "title":"Bill-to Contact ID",
            "type":"integer",
            "description":"Bill-to contact number from Installed Base assets for goods or Subscription Management for subscriptions.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillToContactName":{
            "title":"Bill-to Contact Name",
            "maxLength":900,
            "type":"string",
            "description":"Bill-to contact name from Installed Base assets for goods or Subscription Management product for subscriptions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToContactNumber":{
            "title":"Bill-to Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"Bill-to contact number from Installed Base assets for goods or Subscription Management for subscriptions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToPartyId":{
            "title":"Bill-to Party ID",
            "type":"integer",
            "description":"Bill-to party identifier from Installed Base assets for goods or Subscription Management product for subscriptions.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillToPartyName":{
            "title":"Bill-to Party Name",
            "maxLength":900,
            "type":"string",
            "description":"Bill-to party name from Installed Base assets for goods or Subscription Management product for subscriptions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToPartyNumber":{
            "title":"Bill-to Party Number",
            "maxLength":30,
            "type":"string",
            "description":"Bill-to party number from Installed Base assets for goods or Subscription Management product for subscriptions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToPartySite":{
            "title":"Bill-to Party Site",
            "maxLength":429,
            "type":"string",
            "description":"Bill-to party site address from Installed Base assets or derived from bill-to site use.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToPartySiteId":{
            "title":"Bill-to Party Site ID",
            "type":"integer",
            "description":"Bill-to party site identifier from Installed Base assets or derived from bill-to site use.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillToSiteUseId":{
            "title":"Bill-to Site Use ID",
            "type":"integer",
            "description":"Bill-to customer site use identifier from Installed Base assets or Subscription Management product source data.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClosedDate":{
            "title":"Closed Date",
            "type":"string",
            "description":"Closed date copied from the Subscription Management product for lifecycle handling.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConfigHeaderId":{
            "title":"Configuration Header ID",
            "type":"integer",
            "description":"Configuration header identifier preferred from the asset group or otherwise from the Installed Base asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConfigRevisionNumber":{
            "title":"Configuration Revision Number",
            "type":"integer",
            "description":"Configuration revision number preferred from the asset group or otherwise from the Installed Base asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConfiguratorPath":{
            "title":"Configurator Path",
            "maxLength":2000,
            "type":"string",
            "description":"Configurator path preferred from asset group and otherwise from Installed Base asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CoveredItemAssetGroupId":{
            "title":"Covered Item Asset Group ID",
            "type":"integer",
            "description":"Asset group identifier for the item covered by the Subscription Management product.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency",
            "maxLength":80,
            "type":"string",
            "description":"Currency code from the Installed Base asset for goods or Subscription Management product for subscriptions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Currency code from the Installed Base asset for goods or Subscription Management product for subscriptions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentAddress":{
            "title":"Current Address",
            "maxLength":429,
            "type":"string",
            "description":"Current address of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentOvnMatchingFlag":{
            "title":"Current Object Version Number Matching",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicator specifying whether the Installed Base, Subscription Management, and Group Object Version Numbers match. Reads True if the Installed Base Subscription Management and Group Object Version Numbers are the same as in the CPQ read model tables.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerId":{
            "title":"Customer ID",
            "type":"integer",
            "description":"Sold-to party identifier copied from the Installed Base customer party.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerName":{
            "title":"Customer Name",
            "maxLength":900,
            "type":"string",
            "description":"Sold-to party name copied from the Installed Base customer party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerNumber":{
            "title":"Customer Number",
            "maxLength":30,
            "type":"string",
            "description":"Sold-to party number copied from the Installed Base customer party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FulfillLineId":{
            "title":"Fulfillment Line ID",
            "type":"integer",
            "description":"Fulfillment line identifier associated with the source asset group or asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GroupEndDate":{
            "title":"Asset Group End Date",
            "type":"string",
            "description":"End date copied from the source sold asset group.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupStartDate":{
            "title":"Asset Group Start Date",
            "type":"string",
            "description":"Start date copied from the source sold asset group.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HasAssetChildren":{
            "title":"Has Asset Children",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this asset has at least one active child asset relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HasAssociatedAssets":{
            "title":"Has Associated Assets",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this subscription row has associated assets under the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HasAssociations":{
            "title":"Has Associations",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this asset is associated with at least one subscription product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HasCoverages":{
            "title":"Has Coverages",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this asset is covered by at least one subscription coverage product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HasCoveredLevels":{
            "title":"Has Covered Levels",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this coverage row has covered levels under the subscription product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HasFutureState":{
            "title":"Has Future Asset",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this read-model row has a future-dated asset state from a renewal or amendment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IbEndDate":{
            "title":"Installed Base End Date",
            "type":"string",
            "description":"Customer asset end date copied from the Installed Base asset.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IbStartDate":{
            "title":"Installed Base Start Date",
            "type":"string",
            "description":"Customer asset start date copied from the Installed Base asset.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IbStatus":{
            "title":"Asset Status",
            "maxLength":80,
            "type":"string",
            "description":"Operational status code copied from the Installed Base asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IbStatusCode":{
            "title":"Asset Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Operational status code copied from the Installed Base asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InactiveFlag":{
            "title":"Inactive",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the read-model row is inactive because it no longer qualifies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Product item number copied from Product Information Management for display and search.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item Number",
            "type":"integer",
            "description":"Inventory item identifier copied from the Installed Base asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Product item number copied from Product Information Management for display and search.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemOrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"Item organization identifier used with item ID for Product Master joins.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemOrganizationName":{
            "title":"Item Organization Name",
            "maxLength":240,
            "type":"string",
            "description":"Item organization identifier used with item ID for Product Master joins.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemType":{
            "title":"Item Type",
            "maxLength":30,
            "type":"string",
            "description":"Product item type copied from Product Information Management.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Who column that indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalEntityId":{
            "title":"Legal Entity ID",
            "type":"integer",
            "description":"Legal entity identifier copied from the Subscription Management header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LegalEntityName":{
            "title":"Legal Entity Name",
            "maxLength":240,
            "type":"string",
            "description":"Legal entity identifier copied from the Subscription Management header.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OssEndDate":{
            "title":"Subscription End Date",
            "type":"string",
            "description":"End date copied from the Subscription Management product for lineage and reconciliation.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OssStartDate":{
            "title":"Subscription Start Date",
            "type":"string",
            "description":"Start date copied from the Subscription Management product for lineage and reconciliation.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OssStatus":{
            "title":"Subscription Status",
            "maxLength":30,
            "type":"string",
            "description":"Lifecycle status copied from the Subscription Management product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OssStatusCode":{
            "title":"Subscription Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Lifecycle status copied from the Subscription Management product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentAssetGroupId":{
            "title":"Parent Asset Group ID",
            "type":"integer",
            "description":"Parent asset group identifier derived from asset hierarchy and configuration context.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentAssetId":{
            "title":"Parent Asset ID",
            "type":"integer",
            "description":"Immediate parent Installed Base asset derived from active asset relationships.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Product Instance Quantity copied from the Installed Base asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RepresentativeAssetId":{
            "title":"Representative Asset ID",
            "type":"integer",
            "description":"Asset identifier selected as the representative serialized asset for the group. Used by the consolidated view to join back to CPQ_SERIALIZED_ASSETS for descriptive fields.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RootAssetGroupId":{
            "title":"Root Asset Group ID",
            "type":"integer",
            "description":"Root asset group identifier derived from hierarchy and configuration context.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RootAssetId":{
            "title":"Root Asset ID",
            "type":"integer",
            "description":"Root Installed Base asset derived from active asset relationships or set to self.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrderId":{
            "title":"Sales Order ID",
            "type":"integer",
            "description":"Sales order header identifier from Installed Base assets or Subscription Management product source data.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrderLineId":{
            "title":"Sales Order Line ID",
            "type":"integer",
            "description":"Sales order line identifier from Installed Base assets for goods or Subscription Management product for subscriptions.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrderLineNumber":{
            "title":"Sales Order Line Number",
            "maxLength":100,
            "type":"string",
            "description":"User-facing source sales order line number from Installed Base assets or Subscription Management product source data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderNumber":{
            "title":"Sales Order Number",
            "maxLength":200,
            "type":"string",
            "description":"User-facing source sales order number from Installed Base assets or Subscription Management product source data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderSourceSystem":{
            "title":"Sales Order Source System",
            "maxLength":30,
            "type":"string",
            "description":"Source system code for the sales order captured on the Installed Base asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesProductType":{
            "title":"Sales Product Type",
            "maxLength":30,
            "type":"string",
            "description":"Product sales classification copied from Product Information Management.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesProductTypeCode":{
            "title":"Sales Product Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Product sales classification copied from Product Information Management.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Serial number copied from the source Installed Base asset when available.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToPartyId":{
            "title":"Ship-to Party ID",
            "type":"integer",
            "description":"Ship-to party identifier from Installed Base assets for goods or Subscription Management product for subscriptions.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipToPartyName":{
            "title":"Ship-to Party Name",
            "maxLength":900,
            "type":"string",
            "description":"Ship-to party name from Installed Base assets for goods or Subscription Management product for subscriptions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToPartyNumber":{
            "title":"Ship-to Party Number",
            "maxLength":30,
            "type":"string",
            "description":"Ship-to party number from Installed Base assets for goods or Subscription Management product for subscriptions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToPartySite":{
            "title":"Ship-to Party Site",
            "maxLength":429,
            "type":"string",
            "description":"Ship-to party site address from Installed Base assets for goods or Subscription Management product for subscriptions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToPartySiteId":{
            "title":"Ship-to Party Site ID",
            "type":"integer",
            "description":"Ship-to party site identifier from Installed Base assets or Subscription Management product source data.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SoldByBusinessUnitId":{
            "title":"Sold-by Business Unit ID",
            "type":"integer",
            "description":"Business unit identifier that sold the asset or subscription.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SoldByBusinessUnitName":{
            "title":"Sold-by Business Unit Name",
            "maxLength":240,
            "type":"string",
            "description":"Business unit identifier that sold the asset or subscription.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"Subscription header identifier copied from the subscription header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"Subscription number copied from the subscription header for subscription rows.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"Subscription Management identifier used to join asset group rows to Subscription Management products.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"Public unique identifier copied from Subscription Management.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuspendedDate":{
            "title":"Suspended Date",
            "type":"string",
            "description":"Suspended date copied from Subscription Management for lifecycle handling.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOM":{
            "title":"UOM",
            "maxLength":80,
            "type":"string",
            "description":"Unit of measure code copied from the Installed Base asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":3,
            "type":"string",
            "description":"Unit of measure code copied from the Installed Base asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top