Procedure Plan Definition Input

Input representation of the details of a procedure plan definition.

JSON Example

This example shows a sample request to create a procedure plan definition record by using the Procedure Plan Definitions (POST) API.

1{
2  "description": "Definition for Quote",
3  "developerName": "Quote_Definition_Sample",
4  "name": "Quote_Definition_Sample",
5  "processType": "Default",
6  "primaryObject": "BusinessHours",
7  "procedurePlanDefinitionVersions": [
8    {
9      "active": false,
10      "contextDefinition": "SalesTransactionContext__stdctx",
11      "readContextMapping": "QuoteEntitiesMapping",
12      "saveContextMapping": "QuoteEntitiesMapping",
13      "effectiveFrom": "2024-07-15T10:15:30.000Z",
14      "developerName": "Quote_Definition_V1",
15      "rank": 1
16    }
17  ]
18}

This example shows a sample request to update a procedure plan definition by using the Procedure Plan Definition By ID (PATCH) API.

Note: The properties that aren’t specified in the input are deleted when updating the record.

1{
2  "description": "Default definition patch update",
3  "developerName": "Quote_Definition",
4  "name": "Quote_Definition",
5  "primaryObject": "Quote",
6  "recordId": "1FNxx0000004EsOGAU"
7}

Properties

Name	Type	Description	Required or Optional	Available Version
`description`	String	Description of the procedure plan definition.	Optional	62.0
`developerName`	String	Developer name of the procedure plan definition.	Required if you’re invoking the Procedure Plan Definitions API (POST).	62.0
`name`	String	Name of the procedure plan definition.	Optional	62.0
`primaryObject`	String	Source object that’s used to create a procedure with rule-based criteria. This property value must be a valid object name and must be unique in the ProcedurePlanDefinition object.	Required if you’re invoking the Procedure Plan Definitions API (POST) and if you’re creating a procedure with rule-based criteria.	62.0
`procedurePlanDefinitionVersions`	Procedure Plan Definition Version Input[]	List of versions of a procedure plan definition.	Required	62.0
`processType`	String	Specifies the business processes that need a procedure plan for each sObject and definition. Valid values 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`.	Required	63.0
`recordId`	String	ID of the procedure plan definition record.	Required if you’re invoking the Procedure Plan Definition By ID API (PATCH).	62.0
`subType`	String	Specifies the vertical or cloud-specific subclassification for the procedure plan definition.	Optional	68.0