Procedure Plan Definition

Output representation of the details of a single procedure plan definition.

JSON Example

This example shows a sample response for the Procedure Plan Definition By ID (GET) request.

1{
2     "description": "Default Definition",
3     "developerName": "Quote_Definition",
4     "name": "Quote_Definition",
5     "primaryObject": "Quote",
6     "procedurePlanDefinitionVersions": [
7     {
8      "active": false,
9      "contextDefinition": "11Oxx0000006PZ7EAM",
10      "effectiveFrom": "2024-02-03T10:15:30.000Z",
11      "effectiveTo": "2024-02-03T10:15:30.000Z",
12      "readContextMapping": "MedicalHistoryMapping",
13      "recordId": "1Cvxx0000004E1ACAU",
14      "saveContextMapping": "MedicalHistoryMapping",
15      "success": true,
16      "processType": "Default"
17    }
18  ],
19  "recordId": "1FNxx0000004GkWGAU",
20  "processType": "Default",
21  "success": true
22}

This example shows a sample response for the Procedure Plan Definition By ID (PATCH) request.

1{
2  "procedurePlanDefinitionVersions":[],
3  "recordId":"1FNDU00000000EX4AY",
4  "processType": "Default",
5  "success":true
6  }

Property Name	Type	Description	Filter Group and Version	Available Version
`description`	String	Description for the procedure plan definition.	Small, 62.0	62.0
`developerName`	String	Developer name of the procedure plan definition.	Small, 62.0	62.0
`error`	Procedure Plan Generic Error[]	Details of the error encountered during the processing of the API request.	Small, 62.0	62.0
`name`	String	Name of the procedure plan definition.	Small, 62.0	62.0
`primaryObject`	String	Object that’s associated with the procedure plan definition.	Small, 62.0	62.0
`procedurePlanDefinitionVersions`	Procedure Plan Definition Version[]	Details of the versions of a procedure plan definition.	Small, 62.0	62.0
`processType`	String	Business processes that’s specified that requires a procedure plan for each sObject and definition.	Small, 63.0	63.0
`recordId`	String	ID of the procedure plan definition record.	Small, 62.0	62.0
`success`	Boolean	Indicates whether the API request is successful (`true`) or not (`false`).	Small, 62.0	62.0