You are here:
getUngroupedRecords Method
Returns a set of paginated non-members of a specific member-type.
Input Parameters
Parameter |
Required |
Description |
|---|---|---|
parentId |
Required |
Opportunity ID. |
contextId |
Required |
Parent cart ID (Master or Enterprise quote or order ID). |
pageSize |
Optional: Defaults to 20 |
Page size for pagination. |
offset |
Optional: Defaults to 0 |
Offset for pagination. |
cartType |
Optional: Defaults to Quote |
Quote or order. |
memberType |
Optional: Defaults to return all the types |
CPQ Group Member Type Name. For example: ServicePoint. |
filters |
Optional |
Consists of Field to search on and the sub-string value to search
against, separated by colon(:). Supports multiple such sets, separated
by comma(,). Example:
|
sortBy |
Optional |
Field to sort on along with the sort order. Example:
|
Output Parameters
Parameter |
Description |
|---|---|
result |
JSONResult with non-member records for a specific member-type. |
Example Input Data
{"parentId":"0060b00000vGbYbAAK","contextId":"0Q00b000000znTYCAY","offset":0,"pageSize":20,"memberType":"ServicePoint","cartType":"Quote"}Example Output Data
{"totalSize":0,"records":[{"displaySequence":-1,"Name":{"value":"May06_Acc01-Premise - ServicePoint - 2","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__PremisesId__r":{"Name":"May06_Acc01-Premise","h_cpq_ecomm__StreetAddress__c":"lone Street","h_cpq_ecomm__City__c":"San Francisco","h_cpq_ecomm__PostalCode__c":"30080"},"h_cpq_ecomm__IsKeyAtPremises__c":{"value":false,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__LoadProfile__c":{"value":"SMB Low","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__MarketIdentifier__c":{"value":"Identifier - 572.1531770676341 - 2","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__ActivationDate__c":{"value":"2020-05-07","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__UtilityProvider__c":{"value":"Other","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__VoltageLevel__c":{"value":"Low","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__AverageMonthlyUsage__c":{"value":9122,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__OperationArea__c":{"value":null,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"Id":{"value":"a3h0b00000CwSUDAA3","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}}}],"data":{"totalCount":1}}