Procedure Plan Version Details (GET, PATCH, DELETE)
Get, update, or delete a procedure plan definition version record by using the record ID.
The procedurePlanVersionId property value is the ID or name of the procedure plan version record to perform the request for.
62.0
DELETE, GET, PATCH
You can’t delete a procedure plan version if it’s the only procedure plan version in a procedure plan definition.
Procedure Plan Definition Version
JSON Example
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 |