Revenue Cloud Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
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.
{ "description": "Default Definition", "developerName": "Quote_Definition", "name": "Quote_Definition", "primaryObject": "Quote", "procedurePlanDefinitionVersions": [ { "active": false, "contextDefinition": "11Oxx0000006PZ7EAM", "effectiveFrom": "2024-02-03T10:15:30.000Z", "effectiveTo": "2024-02-03T10:15:30.000Z", "readContextMapping": "MedicalHistoryMapping", "recordId": "1Cvxx0000004E1ACAU", "saveContextMapping": "MedicalHistoryMapping", "success": true } ], "recordId": "1FNxx0000004GkWGAU", "success": true } - This example shows a sample response for the Procedure Plan Definition By ID (PATCH)
request.
{ "procedurePlanDefinitionVersions":[], "recordId":"1FNDU00000000EX4AY", "success":true }
| 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 |
| 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 |