Get Assets for Contract

Retrieve the assets for a specified contract ID.

1GET /v2/contracts/{contract_ID}/assets

Remote Method 

1getAssetsByContract

Handlers 

1REST Endpoint: APIAssetsContractsV2.cls
2Implementation: CpqAssetsContractsActionV2.cls

Apex Remote Service 

1CpqAppHandler

Apex Remote Input Map 

1methodName: getAssetsByContract
2contractId: 8001I0000000Thq
3effectiveAssetsDateFilter: 2020-04-05T07:00:00.000Z
4pagesize: 2

Package 

Communication (vlocity_cmt)

API Parameters and Response Format 

For API parameter names and descriptions, see Cart-Based API Swagger Reference.

Resource Information 

Response FormatJSON
Resource URL/services/apexrest/{namespace}/v2/contracts/{contract_ID}/assets

Example Request 

1GET
2/services/apexrest/vlocity_cmt/v2/contracts/8001I0000000Thq/assets?pagesize=2&includes=noContractAssets&effectiveAssetsDateFilter=2020-04-05T07:00:00.000Z

Example Response 

1{
2  "totalSize": 1,
3  "messages": [],
4  "records": [
5    {
6      "messages": [],
7      "actions": {
8        "assetchangesite": {
9          "rest": {
10            "params": {},
11            "method": "POST",
12            "link": "/services/apexrest/vlocity_cmt/v2/carts?subaction=assetChangeSite"
13          },
14          "remote": {
15            "params": {
16              "assetList": [
17                "02i1I00000058doQAA"
18              ],
19              "moveDate": null,
20              "toServiceLocation": null,
21              "fromServiceLocation": null
22            }
23          },
24          "client": {
25            "params": {}
26          }
27        },
28        "assettoquote": {
29          "rest": {
30            "params": {},
31            "method": "POST",
32            "link": "/services/apexrest/vlocity_cmt/v2/carts?subaction=assetToQuote"
33          },
34          "remote": {
35            "params": {
36              "assetList": [
37                "02i1I00000058doQAA"
38              ],
39              "requestDate": null
40            }
41          },
42          "client": {
43            "params": {}
44          }
45        },
46        "assettoorder": {
47          "rest": {
48            "params": {},
49            "method": "POST",
50            "link": "/services/apexrest/vlocity_cmt/v2/carts?subaction=assetToOrder"
51          },
52          "remote": {
53            "params": {
54              "assetList": [
55                "02i1I00000058doQAA"
56              ],
57              "requestDate": null
58            }
59          },
60          "client": {
61            "params": {}
62          }
63        }
64      },
65      "displaySequence": -1,
66      "Id": {
67        "value": "02i1I00000058doQAA",
68        "previousValue": null,
69        "originalValue": null,
70        "messages": [],
71        "label": "Asset ID",
72        "hidden": true,
73        "fieldName": "Id",
74        "editable": false,
75        "dataType": "ID",
76        "actions": {}
77      },
78      "Quantity": {
79        "value": 1,
80        "previousValue": null,
81        "originalValue": null,
82        "messages": [],
83        "label": "Quantity",
84        "hidden": true,
85        "fieldName": "Quantity",
86        "editable": false,
87        "dataType": "DOUBLE",
88        "actions": {}
89      },
90      "vlocity_cmt__ProvisioningStatus__c": {
91        "value": "Active",
92        "previousValue": null,
93        "originalValue": null,
94        "messages": [],
95        "label": "Provisioning Status",
96        "hidden": true,
97        "fieldName": "vlocity_cmt__ProvisioningStatus__c",
98        "editable": false,
99        "dataType": "STRING",
100        "actions": {}
101      },
102      "vlocity_cmt__RecurringTotal__c": {
103        "value": 10,
104        "previousValue": null,
105        "originalValue": null,
106        "messages": [],
107        "label": "Recurring Total",
108        "hidden": true,
109        "fieldName": "vlocity_cmt__RecurringTotal__c",
110        "editable": false,
111        "dataType": "CURRENCY",
112        "actions": {
113          "pricedetail": {
114            "rest": {
115              "params": {},
116              "method": "GET",
117              "link": "/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__RecurringTotal__c&effectiveAssetsDateFilter=2020-04-05T07:00:00.000Z"
118            },
119            "remote": {
120              "params": {
121                "effectiveAssetsDateFilter": "2020-04-05T07:00:00.000Z",
122                "priceDetailsFields": "vlocity_cmt__RecurringTotal__c",
123                "priceDetail": true,
124                "id": "02i1I00000058doQAA",
125                "accountId": "0011I000007ms8TQAQ",
126                "methodName": "getAssetPriceDetail"
127              }
128            },
129            "client": {
130              "records": [],
131              "params": {}
132            }
133          }
134        }
135      },
136      "vlocity_cmt__OneTimeTotal__c": {
137        "value": 100,
138        "previousValue": null,
139        "originalValue": null,
140        "messages": [],
141        "label": "One Time Total",
142        "hidden": true,
143        "fieldName": "vlocity_cmt__OneTimeTotal__c",
144        "editable": false,
145        "dataType": "CURRENCY",
146        "actions": {
147          "pricedetail": {
148            "rest": {
149              "params": {},
150              "method": "GET",
151              "link": "/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__OneTimeTotal__c&effectiveAssetsDateFilter=2020-04-05T07:00:00.000Z"
152            },
153            "remote": {
154              "params": {
155                "effectiveAssetsDateFilter": "2020-04-05T07:00:00.000Z",
156                "priceDetailsFields": "vlocity_cmt__OneTimeTotal__c",
157                "priceDetail": true,
158                "id": "02i1I00000058doQAA",
159                "accountId": "0011I000007ms8TQAQ",
160                "methodName": "getAssetPriceDetail"
161              }
162            },
163            "client": {
164              "records": [],
165              "params": {}
166            }
167          }
168        }
169      },
170      "vlocity_cmt__ContractId__c": {
171        "value": "8001I0000000ThqQAE",
172        "previousValue": null,
173        "originalValue": null,
174        "messages": [],
175        "label": "Contract",
176        "hidden": false,
177        "fieldName": "vlocity_cmt__ContractId__c",
178        "editable": false,
179        "dataType": "REFERENCE",
180        "actions": {}
181      },
182      "vlocity_cmt__LineNumber__c": {
183        "value": "0001",
184        "previousValue": null,
185        "originalValue": null,
186        "messages": [],
187        "label": "Line Number",
188        "hidden": true,
189        "fieldName": "vlocity_cmt__LineNumber__c",
190        "editable": false,
191        "dataType": "STRING",
192        "actions": {}
193      },
194      "vlocity_cmt__RootItemId__c": {
195        "value": "02i1I00000058doQAA",
196        "previousValue": null,
197        "originalValue": null,
198        "messages": [],
199        "label": "RootItemId",
200        "hidden": true,
201        "fieldName": "vlocity_cmt__RootItemId__c",
202        "editable": false,
203        "dataType": "STRING",
204        "actions": {}
205      },
206      "vlocity_cmt__OneTimeCharge__c": {
207        "value": 100,
208        "previousValue": null,
209        "originalValue": null,
210        "messages": [],
211        "label": "One Time Charge",
212        "hidden": true,
213        "fieldName": "vlocity_cmt__OneTimeCharge__c",
214        "editable": false,
215        "dataType": "CURRENCY",
216        "actions": {
217          "pricedetail": {
218            "rest": {
219              "params": {},
220              "method": "GET",
221              "link": "/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__OneTimeCharge__c&effectiveAssetsDateFilter=2020-04-05T07:00:00.000Z"
222            },
223            "remote": {
224              "params": {
225                "effectiveAssetsDateFilter": "2020-04-05T07:00:00.000Z",
226                "priceDetailsFields": "vlocity_cmt__OneTimeCharge__c",
227                "priceDetail": true,
228                "id": "02i1I00000058doQAA",
229                "accountId": "0011I000007ms8TQAQ",
230                "methodName": "getAssetPriceDetail"
231              }
232            },
233            "client": {
234              "records": [],
235              "params": {}
236            }
237          }
238        }
239      },
240      "vlocity_cmt__OneTimeCalculatedPrice__c": {
241        "value": 100,
242        "previousValue": null,
243        "originalValue": null,
244        "messages": [],
245        "label": "One Time Calculated Price",
246        "hidden": true,
247        "fieldName": "vlocity_cmt__OneTimeCalculatedPrice__c",
248        "editable": false,
249        "dataType": "CURRENCY",
250        "actions": {
251          "pricedetail": {
252            "rest": {
253              "params": {},
254              "method": "GET",
255              "link": "/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__OneTimeCalculatedPrice__c&effectiveAssetsDateFilter=2020-04-05T07:00:00.000Z"
256            },
257            "remote": {
258              "params": {
259                "effectiveAssetsDateFilter": "2020-04-05T07:00:00.000Z",
260                "priceDetailsFields": "vlocity_cmt__OneTimeCalculatedPrice__c",
261                "priceDetail": true,
262                "id": "02i1I00000058doQAA",
263                "accountId": "0011I000007ms8TQAQ",
264                "methodName": "getAssetPriceDetail"
265              }
266            },
267            "client": {
268              "records": [],
269              "params": {}
270            }
271          }
272        }
273      },
274      "vlocity_cmt__OneTimeManualDiscount__c": {
275        "value": 0,
276        "previousValue": null,
277        "originalValue": null,
278        "messages": [],
279        "label": "One Time Manual Discount",
280        "hidden": true,
281        "fieldName": "vlocity_cmt__OneTimeManualDiscount__c",
282        "editable": false,
283        "dataType": "PERCENT",
284        "actions": {}
285      },
286      "vlocity_cmt__RecurringCharge__c": {
287        "value": 10,
288        "previousValue": null,
289        "originalValue": null,
290        "messages": [],
291        "label": "Recurring Charge",
292        "hidden": true,
293        "fieldName": "vlocity_cmt__RecurringCharge__c",
294        "editable": false,
295        "dataType": "CURRENCY",
296        "actions": {
297          "pricedetail": {
298            "rest": {
299              "params": {},
300              "method": "GET",
301              "link": "/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__RecurringCharge__c&effectiveAssetsDateFilter=2020-04-05T07:00:00.000Z"
302            },
303            "remote": {
304              "params": {
305                "effectiveAssetsDateFilter": "2020-04-05T07:00:00.000Z",
306                "priceDetailsFields": "vlocity_cmt__RecurringCharge__c",
307                "priceDetail": true,
308                "id": "02i1I00000058doQAA",
309                "accountId": "0011I000007ms8TQAQ",
310                "methodName": "getAssetPriceDetail"
311              }
312            },
313            "client": {
314              "records": [],
315              "params": {}
316            }
317          }
318        }
319      },
320      "vlocity_cmt__RecurringCalculatedPrice__c": {
321        "value": 10,
322        "previousValue": null,
323        "originalValue": null,
324        "messages": [],
325        "label": "Recurring Calculated Price",
326        "hidden": true,
327        "fieldName": "vlocity_cmt__RecurringCalculatedPrice__c",
328        "editable": false,
329        "dataType": "CURRENCY",
330        "actions": {
331          "pricedetail": {
332            "rest": {
333              "params": {},
334              "method": "GET",
335              "link": "/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__RecurringCalculatedPrice__c&effectiveAssetsDateFilter=2020-04-05T07:00:00.000Z"
336            },
337            "remote": {
338              "params": {
339                "effectiveAssetsDateFilter": "2020-04-05T07:00:00.000Z",
340                "priceDetailsFields": "vlocity_cmt__RecurringCalculatedPrice__c",
341                "priceDetail": true,
342                "id": "02i1I00000058doQAA",
343                "accountId": "0011I000007ms8TQAQ",
344                "methodName": "getAssetPriceDetail"
345              }
346            },
347            "client": {
348              "records": [],
349              "params": {}
350            }
351          }
352        }
353      },
354      "vlocity_cmt__RecurringManualDiscount__c": {
355        "value": 0,
356        "previousValue": null,
357        "originalValue": null,
358        "messages": [],
359        "label": "Recurring Manual Discount",
360        "hidden": true,
361        "fieldName": "vlocity_cmt__RecurringManualDiscount__c",
362        "editable": false,
363        "dataType": "PERCENT",
364        "actions": {}
365      },
366      "vlocity_cmt__ServiceAccountId__c": {
367        "value": "0011I000007ms8TQAQ",
368        "previousValue": null,
369        "originalValue": null,
370        "messages": [],
371        "label": "Service Account",
372        "hidden": false,
373        "fieldName": "vlocity_cmt__ServiceAccountId__c",
374        "editable": false,
375        "dataType": "REFERENCE",
376        "actions": {}
377      },
378      "vlocity_cmt__BillingAccountId__c": {
379        "value": "0011I000007ms8TQAQ",
380        "previousValue": null,
381        "originalValue": null,
382        "messages": [],
383        "label": "Billing Account",
384        "hidden": false,
385        "fieldName": "vlocity_cmt__BillingAccountId__c",
386        "editable": false,
387        "dataType": "REFERENCE",
388        "actions": {}
389      },
390      "vlocity_cmt__PricingLogData__c": {
391        "value": "{\"LogData\":{\"OT_STD_PRC\":[{\"PriceListEntryId\":\"a2X1I0000009iFXUAY\",\"LogType\":\"PRICE\",\"PricingElementGlobalKey\":\"775e358f-31c4-e8de-e23d-e00bbbfedfa6\",\"StartValue\":100.00,\"SubType\":\"Standard\",\"Frequency\":null,\"ChargeTiming\":\"One-time\",\"EndValue\":100.00,\"DisplayText\":\"100$ OTSP\",\"PricingVariableCode\":\"OT_STD_PRC\",\"PricingElementId\":\"a2a1I000000Bar6QAC\",\"PromotionId\":null,\"OfferId\":null,\"PriceListId\":\"a2Y1I000000TlsrUAC\",\"BaseAdjustment\":null,\"BaseValue\":100.00,\"AdjustmentMethod\":null,\"AdjustmentValue\":0.00,\"Amount\":100.00,\"AdjustmentType\":\"None\",\"LogSequence\":0}],\"REC_MNTH_STD_PRC\":[{\"PriceListEntryId\":\"a2X1I0000009iFcUAI\",\"LogType\":\"PRICE\",\"PricingElementGlobalKey\":\"9ef41d53-1bba-017e-625a-b06ac2de2c28\",\"StartValue\":10.00,\"SubType\":\"Standard\",\"Frequency\":\"Monthly\",\"ChargeTiming\":\"Recurring\",\"EndValue\":10.00,\"DisplayText\":\"10$ RMSP\",\"PricingVariableCode\":\"REC_MNTH_STD_PRC\",\"PricingElementId\":\"a2a1I000000Bar1QAC\",\"PromotionId\":null,\"OfferId\":null,\"PriceListId\":\"a2Y1I000000TlsrUAC\",\"BaseAdjustment\":null,\"BaseValue\":10.00,\"AdjustmentMethod\":null,\"AdjustmentValue\":0.00,\"Amount\":10.00,\"AdjustmentType\":\"None\",\"LogSequence\":0}],\"OT_STD_PRC_CALC\":[{\"LogSequence\":0,\"DisplayText\":\"One Time Charge (100.00) - One Time Manual Discount (0.00%)\"}],\"OT_STD_PRC_TOTAL\":[{\"LogSequence\":0,\"DisplayText\":\"[One Time Calculated Price (100.00) + Rollup One Time Total (0.00)] x Quantity (1.00)\"}],\"REC_MNTH_STD_PRC_CALC\":[{\"LogSequence\":0,\"DisplayText\":\"Recurring Charge (10.00) - Recurring Manual Discount (0.00%)\"}],\"REC_MNTH_STD_PRC_TOTAL\":[{\"LogSequence\":0,\"DisplayText\":\"[Recurring Calculated Price (10.00) + Rollup Recurring Total (0.00)] x Quantity (1.00)\"}]},\"PricingVariableCodeFieldBinding\":{\"Quantity\":\"LINE_QUANTITY\",\"vlocity_cmt__EffectiveRecurringTotal__c\":\"EFF_REC_MNTH_STD_PRC_TOTAL\",\"vlocity_cmt__EffectiveOneTimeTotal__c\":\"EFF_OT_STD_PRC_TOTAL\",\"vlocity_cmt__OneTimeCalculatedPrice__c\":\"OT_STD_PRC_CALC\",\"vlocity_cmt__OneTimeManualDiscount__c\":\"OT_STD_PRC_DISC_PCT_MAN\",\"vlocity_cmt__OneTimeCharge__c\":\"OT_STD_PRC\",\"vlocity_cmt__RecurringTotal__c\":\"REC_MNTH_STD_PRC_TOTAL\",\"vlocity_cmt__RecurringCalculatedPrice__c\":\"REC_MNTH_STD_PRC_CALC\",\"vlocity_cmt__RecurringManualDiscount__c\":\"REC_MNTH_STD_PRC_DISC_PCT_MAN\",\"vlocity_cmt__RecurringCharge__c\":\"REC_MNTH_STD_PRC\",\"vlocity_cmt__OneTimeTotal__c\":\"OT_STD_PRC_TOTAL\",\"vlocity_cmt__EffectiveQuantity__c\":\"EFFECTIVE_QUANTITY\"},\"PriceAdjustmentPromoKeys\":[],\"PricingVariableCodeValues\":{\"LINE_QUANTITY\":1.00,\"OT_STD_PRC_DISC_PCT_MAN\":0.00,\"REC_MNTH_STD_PRC_DISC_PCT_MAN\":0.00,\"OT_STD_PRC\":100.00,\"OT_STD_PRC_CALC\":100.00,\"OT_STD_PRC_TOTAL\":100.00,\"REC_MNTH_STD_PRC\":10.00,\"REC_MNTH_STD_PRC_CALC\":10.00,\"REC_MNTH_STD_PRC_TOTAL\":10.00,\"ROLLUP_OT_STD_PRC_TOTAL\":0.00,\"ROLLUP_REC_MNTH_STD_PRC_TOTAL\":0.00,\"EFF_OT_STD_PRC_TOTAL\":100.00,\"EFF_REC_MNTH_STD_PRC_TOTAL\":10.00,\"EFFECTIVE_QUANTITY\":1.00},\"PricingVariableCodeBaseValues\":{\"OT_STD_PRC\":100.00,\"REC_MNTH_STD_PRC\":10.00},\"LogVersion\":\"1.0\",\"LastPricingTime\":\"2020-11-07T10:21:55.572Z\"}",
392        "previousValue": null,
393        "originalValue": null,
394        "messages": [],
395        "label": "Pricing Log",
396        "hidden": true,
397        "fieldName": "vlocity_cmt__PricingLogData__c",
398        "editable": false,
399        "dataType": "TEXTAREA",
400        "actions": {}
401      },
402      "vlocity_cmt__SequenceNumber__c": {
403        "value": 1,
404        "previousValue": null,
405        "originalValue": null,
406        "messages": [],
407        "label": "Sequence Number",
408        "hidden": true,
409        "fieldName": "vlocity_cmt__SequenceNumber__c",
410        "editable": false,
411        "dataType": "DOUBLE",
412        "actions": {}
413      },
414      "vlocity_cmt__PricebookEntryId__c": {
415        "value": "01u1I000000ZY4nQAG",
416        "previousValue": null,
417        "originalValue": null,
418        "messages": [],
419        "label": "PricebookEntryId",
420        "hidden": true,
421        "fieldName": "vlocity_cmt__PricebookEntryId__c",
422        "editable": false,
423        "dataType": "STRING",
424        "actions": {}
425      },
426      "vlocity_cmt__EffectiveQuantity__c": {
427        "value": 1,
428        "previousValue": null,
429        "originalValue": null,
430        "messages": [],
431        "label": "Effective Quantity",
432        "hidden": true,
433        "fieldName": "vlocity_cmt__EffectiveQuantity__c",
434        "editable": false,
435        "dataType": "DOUBLE",
436        "actions": {}
437      },
438      "vlocity_cmt__EffectiveRecurringTotal__c": {
439        "value": 10,
440        "previousValue": null,
441        "originalValue": null,
442        "messages": [],
443        "label": "Effective Recurring Total",
444        "hidden": true,
445        "fieldName": "vlocity_cmt__EffectiveRecurringTotal__c",
446        "editable": false,
447        "dataType": "CURRENCY",
448        "actions": {}
449      },
450      "vlocity_cmt__EffectiveOneTimeTotal__c": {
451        "value": 100,
452        "previousValue": null,
453        "originalValue": null,
454        "messages": [],
455        "label": "Effective One Time Total",
456        "hidden": true,
457        "fieldName": "vlocity_cmt__EffectiveOneTimeTotal__c",
458        "editable": false,
459        "dataType": "CURRENCY",
460        "actions": {}
461      },
462      "Name": "TestA",
463      "promotions": {
464        "totalSize": 0,
465        "messages": []
466      }
467    }
468  ]
469}