getGroups Method

Returns a list of groups under a Master/Enterprise (Mega) quote or order, specific for a member-type.

Class 

Input Parameters 

ParameterRequiredDescription
parentIdRequiredOpportunity ID.
contextIdRequiredParent cart ID (Master or Enterprise quote or order ID).
pageSizeOptional: Defaults to 20Page size for pagination.
offsetOptional: Defaults to 0Offset for pagination.
cartTypeOptional: Defaults to QuoteQuote or order.
memberTypeOptional: Defaults to return all the typesCPQ Group Member Type Name. For example: ServicePoint.
isGroupAssociatedWithCartOptional: Defaults to trueTrue value will try to fetch and return the corresponding Group-Cart record as well.
searchByOptionalSub-string to search within the group and it’s members. Returns matching search results as a response.

Output Parameters 

ParameterDescription
resultJSONResult with Group and corresponding Cart record (If applicable). Please see sample output for details.

Example Input Data 

1{"parentId":"0060b00000vGbYbAAK","contextId":"0Q00b000000znTYCAY","pageSize":20,"offset":0,"memberType":"ServicePoint","cartType":"Quote"}

Example Output Data 

1{"totalSize":0,"records":[{"actions":{"getGroupedServices":{"rest":{"params":{},"method":null,"link":null},"remote":{"params":{"methodName":"getGroupedServices","groupCartId":"0Q00b000000znTiCAI","offset":0,"pageSize":20,"contextId":"0Q00b000000znTYCAY","parentId":"0060b00000vGbYbAAK","groupId":"a4M0b000002CWMGEA4"}},"client":{"params":{}}},"getGroupMembers":{"rest":{"params":{},"method":null,"link":null},"remote":{"params":{"methodName":"getGroupMembers","offset":0,"pageSize":20,"contextId":"0Q00b000000znTYCAY","parentId":"0060b00000vGbYbAAK","groupId":"a4M0b000002CWMGEA4"}},"client":{"params":{}}}},"displaySequence":-1,"groupId":"a4M0b000002CWMGEA4","itemsCount":1,"groupName":"Group-1","groupCartId":"0Q00b000000znTiCAI","groupCartURL":"apex/h_cpq_ecomm__MultiServiceHybridCPQ?id=0Q00b000000znTiCAI&parentId=0060b00000vGbYbAAK&groupCart=true&groupId=a4M0b000002CWMGEA4&contextId=0Q00b000000znTYCAY&cartType=Quote","groupCart":{"attributes":{"type":"Quote","url":"/services/data/v49.0/sobjects/Quote/0Q00b000000znTiCAI"},"h_cpq_ecomm__IsPriced__c":false,"h_cpq_ecomm__IsValidated__c":false,"Id":"0Q00b000000znTiCAI","RecordTypeId":"0120b000000hxEhAAI"},"hasUnappliedGroupItems":true,"Id":{"value":"a4M0b000002CWMGEA4","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__MemberCount__c":{"value":1,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__LockedBy__c":{"value":null,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"Name":{"value":"Group-1","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__Description__c":{"value":null,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__MemberType__c":{"value":"ServicePoint","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__MultiServiceMessageData__c":{"value":null,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__LockedFor__c":{"value":null,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__AsyncJobId__c":{"value":null,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__AsyncOperation__c":{"value":null,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__HasUnappliedGroupItems__c":{"value":true,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__GroupCartId__c":{"value":"0Q00b000000znTiCAI","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__GroupCartId__r":{"h_cpq_ecomm__IsValidated__c":false,"h_cpq_ecomm__IsPriced__c":false,"h_cpq_ecomm__TrackingNumber__c":null,"h_cpq_ecomm__MultiServiceMessageData__c":null,"h_cpq_ecomm__DefaultServicePointId__c":null}}],"data":{"groupTotalCount":1}}"masterCartId":"0Q04x000000gZbWCAU","error":"OK"}