CSC Apex API Developer Reference

csc.CreateSuccessPlanFromTemplateRequest

global with sharing class CreateSuccessPlanFromTemplateRequest extends CreateSObjectFromTemplateRequest

The request object which is passed to the service in order to create a new success plan from a template.

Enums

Options

Set of additional options to use in create success plan from template process. COPY_CS_SKILLS_FROM_PLAYBOOK: Value to indicate whether cs skills need to be copied from playbook or not. COPY_CS_SKILLS_FROM_SUCCESS_PLAN: Value to indicate whether cs skills need to be copied from success plan or not. IS_SYNCHRONOUS_PROCESS: Value to indicate whether the process will run synchronously.

Methods

CreateSuccessPlanFromTemplateRequest

global CreateSuccessPlanFromTemplateRequest(Id templateId)

A constructor method to create a request. Requests constructed with just a template ID will clone the template in its entirety, with the exception of the following fields: csc__Account__c, csc__Last_Business_Review__c, csc__Next_Business_Review__c, csc__Status__c, and csc__Success_Plan_Owner__c. User-defined custom fields are also not cloned.

Input Parameters

Name Type Description
templateId Id ID of the success plan template to be cloned.

CreateSuccessPlanFromTemplateRequest

global CreateSuccessPlanFromTemplateRequest(Id templateId, Set<CreateSuccessPlanFromTemplateRequest.Options> options)

A constructor method to create a request. Requests constructed with just a template ID will clone the template in its entirety, with the exception of the following fields: csc__Objective__c, csc__Playbook_Owner__c, and csc__Stage__c. User-generated custom fields are also not cloned.

Input Parameters

Name Type Description
templateId Id ID of the success plan template to be cloned.
options Set<CreateSuccessPlanFromTemplateRequest.Options> Set of additional options to use in create success plan from template process. Eg: COPY_CS_SKILLS_FROM_PLAYBOOK: Value to indicate whether cs skills need to be copied from playbook or not, COPY_CS_SKILLS_FROM_SUCCESS_PLAN: Value to indicate whether cs skills need to be copied from success plan or not, IS_SYNCHRONOUS_PROCESS: Value to indicate whether the process will run synchronously.

CreateSuccessPlanFromTemplateRequest

global CreateSuccessPlanFromTemplateRequest(Id templateId, Map<SObjectField, Object> fieldsToPopulate)

A constructor method to create a request.

Input Parameters

Name Type Description
templateId Id ID of the success plan template to be cloned.
fieldsToPopulate Map<SObjectField, Object> Key-value pairs denoting initial field values for the resulting success plan.

CreateSuccessPlanFromTemplateRequest

global CreateSuccessPlanFromTemplateRequest(Id templateId, Map<SObjectField, Object> fieldsToPopulate, Set<CreateSuccessPlanFromTemplateRequest.Options> options)

A constructor method to create a request.

Input Parameters

Name Type Description
templateId Id ID of the success plan template to be cloned.
fieldsToPopulate Map<SObjectField, Object> Key-value pairs denoting initial field values for the resulting playbook.
options Set<CreateSuccessPlanFromTemplateRequest.Options> Set of additional options to use in create success plan from template process. Eg: COPY_CS_SKILLS_FROM_PLAYBOOK: Value to indicate whether cs skills need to be copied from playbook or not, COPY_CS_SKILLS_FROM_SUCCESS_PLAN: Value to indicate whether cs skills need to be copied from success plan or not, IS_SYNCHRONOUS_PROCESS: Value to indicate whether the process will run synchronously.

CreateSuccessPlanFromTemplateRequest

global CreateSuccessPlanFromTemplateRequest(Id templateId, Map<SObjectField, Object> fieldsToPopulate, Map<SObjectType, Set<Id>> relatedRecordsIdMap)

A constructor method to create a request.

Input Parameters

Name Type Description
templateId Id ID of the success plan template to be cloned.
fieldsToPopulate Map<SObjectField, Object> Key-value pairs denoting initial field values for the resulting success plan.
relatedRecordsIdMap Map<SObjectType, Set<Id>> Key-value pairs denoting selected Ids of related SObjects for cloning.

CreateSuccessPlanFromTemplateRequest

global CreateSuccessPlanFromTemplateRequest(Id templateId, Map<SObjectField, Object> fieldsToPopulate, Map<SObjectType, Set<Id>> relatedRecordsIdMap, Set<CreateSuccessPlanFromTemplateRequest.Options> options)

A constructor method to create a request.

Input Parameters

Name Type Description
templateId Id ID of an existing success plan template to be cloned.
fieldsToPopulate Map<SObjectField, Object> Key-value pairs denoting initial field values for the resulting playbook.
relatedRecordsIdMap Map<SObjectType, Set<Id>> Key-value pairs denoting selected Ids of related SObjects for cloning.
options Set<CreateSuccessPlanFromTemplateRequest.Options> Set of additional options to use in create success plan from template process. Eg: COPY_CS_SKILLS_FROM_PLAYBOOK: Value to indicate whether cs skills need to be copied from playbook or not, COPY_CS_SKILLS_FROM_SUCCESS_PLAN: Value to indicate whether cs skills need to be copied from success plan or not, IS_SYNCHRONOUS_PROCESS: Value to indicate whether the process will run synchronously.
© Copyright 2009–2025 Certinia Inc. All rights reserved. Various trademarks held by their respective owners.