Procedure Plan Version Details (GET, PATCH, DELETE)

Get, update, or delete a procedure plan definition version record by using the record ID.

Resource

1/connect/procedure-plan-definitions/versions/{procedurePlanVersionId}

The procedurePlanVersionId property value is the ID or name of the procedure plan version record to perform the request for.

Resource Example

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/procedure-plan-definitions/versions/{1Cvxx0000004E1ACAU}

Available Version

62.0

HTTP Methods

DELETE, GET, PATCH

You can’t delete a procedure plan version if it’s the only procedure plan version in a procedure plan definition.

Response Body for GET

Procedure Plan Definition Version

Request Body for PATCH

JSON Example

1{
2  "active": false,
3  "developerName": "sample_version_input",
4  "effectiveFrom": "2024-07-09T00:00:00.000Z",
5  "contextDefinition": "SalesTransactionContext__stdctx",
6  "procedurePlanSections": [
7    {
8      "isInherited": false,
9      "procedurePlanOptions": [
10        {
11          "saveContextMapping": "AssetToSalesTransactionMapping",
12          "expressionSetDefinition": "9QAZ60000004ECOOA2",
13          "expressionSetLabel": "Revenue_Default_Pricing_Procedure",
14          "expressionSetApiName": "Revenue Default Pricing Procedure",
15          "logic": "1 AND 2 AND 3",
16          "priority": 1,
17          "procedurePlanCriterion": [
18            {
19              "conditionSequence": 1,
20              "fieldObject": "BillingCountry",
21              "fieldPath": "BillingCountry",
22              "literalValue": "test",
23              "operator": "Equals",
24              "dataType": "Text"
25            },
26            {
27              "conditionSequence": 2,
28              "fieldObject": "BillingPostalCode",
29              "fieldPath": "BillingPostalCode",
30              "literalValue": "sample",
31              "operator": "Equals",
32              "dataType": "Text"
33            },
34            {
35              "conditionSequence": 3,
36              "fieldObject": "LastActivityDate",
37              "fieldPath": "LastActivityDate",
38              "literalValue": "2024-07-14",
39              "operator": "LessThan",
40              "dataType": "Date"
41            }
42          ]
43        }
44      ],
45      "resolutionType": "RuleBased",
46      "sectionType": "PricingProcedure",
47      "sequence": 1,
48      "subSectionType": "PricingProcedure",
49      "recordId": "1FRZ60000008OIAOA2"
50    }
51  ],
52  "rank": 1,
53  "readContextMapping": "ProductDiscoveryContextMapping",
54  "saveContextMapping": "OrderEntitiesMapping"
55}

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

Properties

Name	Type	Description	Required or Optional	Available Version
`active`	Boolean	Indicates whether this procedure plan definition version is active (`true`) or not (`false`). You can’t edit or delete a procedure plan version that’s in the active state.	Required	62.0
`contextDefinition`	String	Context definition that’s associated with the procedure plan definition version record.	Required	62.0
`developerName`	String	Unique developer name of the procedure plan definition version.	Required	62.0
`effectiveFrom`	String	Date and time from when the procedure plan definition version comes into effect.	Required	62.0
`effectiveTo`	String	Date and time from when the procedure plan definition version is no longer in effect.	Required	62.0
`inheritedFrom`	String	Template this procedure plan definition version is created from.	This property is read-only.	62.0
`procedurePlanSections`	Procedure Plan Section Input[]	Procedure setup sections for a procedure plan definition. Each section enables the setup of a procedure type by using a rule-based criteria. Keep these considerations in mind when you modify this property. You can edit or delete a procedure plan section if it isn’t associated with an active procedure plan version or You can create a procedure plan section with rule-based resolution type if the primary object isn’t empty in the definition.	Required	62.0
`rank`	Integer	Current rank of the procedure plan definition version that’s used to decide the sequence of execution of a procedure plan definition version.	Required	62.0
`readContextMapping`	String	Mapping that’s used to read data from the mapped object and populate the context definition. This property value must be associated with a context definition.	Optional	62.0
`recordId`	String	ID of the procedure plan definition version record.	Required	62.0
`saveContextMapping`	String	Mapping that’s used to save data from the context definition and populate the mapped object. This property value must be associated with a context definition.	Optional	62.0
`status`	String	Status of the procedure plan definition version record.	Optional	62.0

Response Body for PATCH

Procedure Plan Generic