Suspending Assets
You can invoke this global method to suspend assets. You can process a maximum of 200 line items in each Suspend API call.
|
API |
Signature |
|---|---|
| suspendAssets |
static Apttus_Config2.CPQStruct.SuspendAssetResponseDO suspendAssets(Apttus_Config2.CPQStruct.SuspendAssetRequestDO request) |
|
Parameters |
||
|---|---|---|
Name |
Type |
Description |
| request | Apttus_Config2.CPQStruct.SuspendAssetRequestDO |
Request object invoked by the method. |
|
Request Data Object - Apttus_Config2.CPQStruct.SuspendAssetRequestDO |
|||
|---|---|---|---|
|
Field |
Type |
Description |
Is Required |
| assetIds | List<Id> |
List of asset IDs to be suspended. All the asset IDs must be valid and all the assets must be activated. |
Yes |
| CartId | Id |
Product configuration ID. |
Yes |
| CustomData | Map<String, String> |
Custom field values to be updated. For example, you can pass the reason for suspension as custom data. You can pass more than one custom field. |
No |
| NewEndDate | Date |
Date until which assets must remain suspended. This field is optional in the input. CPQ copies this date to the End Date field in the cart line item. Tip:
The end date passed for asset suspension must be less the end date of the asset. If you provide both start date and end date, CPQ considers the end date you provide in this field as the end date for asset suspension. If you do not provide both end date and term, CPQ considers the asset end date as the end date for asset suspension. |
No |
| NewStartDate | Date |
Date from which assets must be suspended. This field is mandatory in the input. |
Yes |
| Term | Integer |
Term for which assets must be suspended. This field is optional in the input. CPQ copies this date to the Start Date field in the cart line item. Tip:
If you do not provide the end date but provide the term, CPQ calculates the end date for asset suspension based on the asset suspension start date and term (according to the selling frequency). If you do not provide both end date and term, CPQ considers the asset end date as the end date for asset suspension. |
No |
|
Response Data Object - Apttus_Config2.CPQStruct.SuspendAssetResponseDO |
||
|---|---|---|
|
Field |
Type |
Description |
| Errors | List<String> |
Contains errors messages if any operations failed. |
| IsSuccess | Boolean |
Indicates whether the suspend asset operation is successful. |
| LineItemMap | Map<ID,Apttus_Config2__LineItem__c> |
Indicates the line items to be suspended. |
Code Sample
The following code sample helps you suspend assets.
