applyToGroup Method

Starts the Apply to Group batch job for a group.

Class

Input Parameters

Parameter	Required	Description
ApplyToGroupIPName	Required	Name of Integration Procedure to execute for each members.
BatchSize	Optional: Default to 10	Batch Size is the chunk size for batch job.
applyToGroupFailed	Optional	Failed records.
cartType	Optional: Default to Quote	Quote or Order.
contextId	Required	Master quote or order ID.
groupCartId	Required	Group cart ID.
groupId	Required	Group ID.
hasPostProcess	Optional: Default to false	If true, it executes qualification rules after the apply-to-group job completes.
parentId	Required	Opportunity ID.
retrycount	Optional	The number of times of retry of failed members because of a ROW LOCK ERROR. Max retry count is 5 by default. But you can change it by setting the CPQ Configuration custom settings. `MS.ATG.MaxRetry = 5`
startJobVIPName	Optional	Name of the integration procedure, used for the queued apply-to-group job.

Output Parameters

Parameter	Description
isJobStarted	True or false: True if the apply to group job started. False if it’s not started.

Example Input Data

1{"ApplyToGroupIPName":"MultiService_ApplyToGroup","BatchSize":25,"applyToGroupFailed":"","cartType":"Quote","contextId":"0Q05g000000x5etCAA","groupCartId":"0Q05g000000x5f3CAA","groupId":"a3W5g000000LNyxEAG","groupIds":[],"hasPostProcess":"false","parentId":"0065g000006Lh4mAAC","retrycount":"","startJobVIPName":"MultiService_StartApplyToGroup"}

Example Output Data

1{"isJobStarted":true,"errorCode":"INVOKE-200","error":"OK"}