Revenue Cloud Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Procedure Plan Definitions (GET, POST)
Get the records of procedure plan definitions. Additionally, create a
record of a procedure plan definition.
- Resource
-
/connect/procedure-plan-definitions - Resource example
-
https://yourInstance.salesforce.com/services/data/v64.0/connect/procedure-plan-definitions?isTemplate=true - Available version
- 62.0
- HTTP methods
- GET, POST
- Request parameters for GET
-
Parameter Name Type Description Required or Optional Available Version isTemplate Boolean Indicates whether to return a list of file-based definitions (true) or not (false). This API request returns a list of database-based definitions, by default. Optional 62.0 - Response body for GET
- Procedure Plan Definitions
- Request body for POST
-
- JSON example
- This example shows a sample request to
create a procedure plan definition record by using the Procedure Plan Definitions (POST)
API.
{ "description": "Definition for Quote", "developerName": "Quote_Definition_Sample", "name": "Quote_Definition_Sample", "primaryObject": "BusinessHours", "procedurePlanDefinitionVersions": [ { "active": false, "contextDefinition": "SalesTransactionContext__stdctx", "readContextMapping": "QuoteEntitiesMapping", "saveContextMapping": "QuoteEntitiesMapping", "effectiveFrom": "2024-07-15T10:15:30.000Z", "developerName": "Quote_Definition_V1", "rank": 1 } ] } - 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 recordId String ID of the procedure plan definition record. Required if you’re invoking the Procedure Plan Definition By ID API (PATCH). 62.0
- Response body for POST
- Procedure Plan Generic