Procedure Plan Definitions (GET, POST)

Get the records of procedure plan definitions. Additionally, create a record of a procedure plan definition.

Resource

1/connect/procedure-plan-definitions

Resource Example

1https://{yourInstance}.salesforce.com/services/data/v68.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.

1{
2  "description": "Definition for Quote",
3  "developerName": "Quote_Definition_Sample",
4  "name": "Quote_Definition_Sample",
5  "processType": "Default",
6  "primaryObject": "BusinessHours",
7  "procedurePlanDefinitionVersions": [
8    {
9      "active": false,
10      "contextDefinition": "SalesTransactionContext__stdctx",
11      "readContextMapping": "QuoteEntitiesMapping",
12      "saveContextMapping": "QuoteEntitiesMapping",
13      "effectiveFrom": "2024-07-15T10:15:30.000Z",
14      "developerName": "Quote_Definition_V1",
15      "rank": 1
16    }
17  ]
18}

Response Body for POST

Procedure Plan Generic