Procedure Plan Evaluation Input

Input representation of the details used to evaluate a procedure plan definition.

JSON Example

This example shows a sample request to evaluate a procedure plan definition by using a primary object.

1{
2    "idList": ["a01DU000000BylcYAC"], 
3    "evaluationDate": "2024-07-08T10:15:30.000Z",
4    "processType": "Default", 
5    "sectionType": ["PricingProcedure"], 
6    "subSectionType": ["Revenue"] 
7  }

This example shows a sample request to evaluate a procedure plan definition by using a definition name.

1{
2    "evaluationDate": "2024-07-08T10:15:30.000Z",
3    "processType": "Default", 
4    "sectionType": ["PricingProcedure"], 
5    "subSectionType": ["Revenue"] 
6  }

Properties

Name	Type	Description	Required or Optional	Available Version
`evaluationDate`	String	Date when the evaluation is applicable. This property value must be within the date range when the procedure plan definition is effective.	Required	62.0
`idList`	String[]	List of record IDs of the procedure plan definitions to be evaluated.	Required only if you’re invoking the Procedure Plan Evaluation By Object (POST) API.	62.0
`processType`	String	Specifies the business processes that need a procedure plan for each sObject and definition. Valid values based on the available are `Billing`, `DRO`, `DeepClone`, `ProductDiscovery`, or `Revenue Cloud`. These values can be used based on the available license. If unspecified, the value is set to `Default`. If a procedure plan definition exist in the org with `processType` value as `null`, modify the value to `Default`.	Optional	63.0
`sectionType`	String[]	Name of section to be evaluated. Valid values are `PricingProcedure`, `ProductDiscoveryProcedure`, `ProductQualificationProcedure`, `PricingDiscoveryProcedure`, `DiscountSpreadServiceProcedure`, `RatingProcedure`, `Custom`, or `RatingDiscoveryProcedure`.	Optional	62.0
`subSectionType`	String[]	Name of subsection to be evaluated.	Optional	62.0
`subType`	String	Specifies the vertical or cloud-specific subclassification for the procedure plan definition.	Optional	68.0

The combination of the sectionType and subSectionType property values must be unique for every procedure plan version.