Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
# Adds the "Authorization: Bearer <access_token>" header.
$http.AuthToken = "<access_token>"
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://domain.com/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId",$sbResponseBody)
if ($success -eq $false) {
$($http.LastErrorText)
exit
}
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($http.LastHeader)
$("Failed.")
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "apiName": "myExpressionSet",
# "contextDefinitions": [
# ],
# "id": "9QLHo000000LBjEOAW",
# "name": "myExpressionSet",
# "usageType": "Bre",
# "versions": [
# {
# "apiName": "myExpressionSet_V1",
# "description": "myExpressionSet V1 Description",
# "enabled": true,
# "id": "9QMHo000000LBjJOAW",
# "name": "myExpressionSet V1",
# "rank": 1,
# "showExplExternally": true,
# "startDate": "2023-09-06T09:27:06.000Z",
# "steps": [
# {
# "actionType": "AssignParameterValues",
# "assignment": {
# "assignedParameter": "condition_output__1",
# "expression": "true"
# },
# "description": "my Description",
# "name": "myCalculation",
# "resultIncluded": true,
# "sequenceNumber": 1,
# "shouldExposeConditionDetails": false,
# "shouldExposeExecPathMsgOnly": true,
# "shouldShowExplExternally": false,
# "stepType": "BusinessKnowledgeModel"
# }
# ],
# "variables": [
# {
# "collection": false,
# "dataType": "Boolean",
# "description": "condition_output__1",
# "input": false,
# "name": "condition_output__1",
# "output": true,
# "type": "Variable",
# "value": "False"
# },
# {
# "collection": false,
# "dataType": "Boolean",
# "description": "condition_output__2",
# "input": false,
# "name": "condition_output__2",
# "output": false,
# "type": "Variable",
# "value": "False"
# }
# ],
# "versionNumber": 1
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$apiName = $jResp.StringOf("apiName")
$id = $jResp.StringOf("id")
$name = $jResp.StringOf("name")
$usageType = $jResp.StringOf("usageType")
$i = 0
$count_i = $jResp.SizeOfArray("contextDefinitions")
while ($i -lt $count_i) {
$jResp.I = $i
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("versions")
while ($i -lt $count_i) {
$jResp.I = $i
$apiName = $jResp.StringOf("versions[i].apiName")
$description = $jResp.StringOf("versions[i].description")
$enabled = $jResp.BoolOf("versions[i].enabled")
$id = $jResp.StringOf("versions[i].id")
$name = $jResp.StringOf("versions[i].name")
$rank = $jResp.IntOf("versions[i].rank")
$showExplExternally = $jResp.BoolOf("versions[i].showExplExternally")
$startDate = $jResp.StringOf("versions[i].startDate")
$versionNumber = $jResp.IntOf("versions[i].versionNumber")
$j = 0
$count_j = $jResp.SizeOfArray("versions[i].steps")
while ($j -lt $count_j) {
$jResp.J = $j
$actionType = $jResp.StringOf("versions[i].steps[j].actionType")
$AssignedParameter = $jResp.StringOf("versions[i].steps[j].assignment.assignedParameter")
$Expression = $jResp.StringOf("versions[i].steps[j].assignment.expression")
$description = $jResp.StringOf("versions[i].steps[j].description")
$name = $jResp.StringOf("versions[i].steps[j].name")
$resultIncluded = $jResp.BoolOf("versions[i].steps[j].resultIncluded")
$sequenceNumber = $jResp.IntOf("versions[i].steps[j].sequenceNumber")
$shouldExposeConditionDetails = $jResp.BoolOf("versions[i].steps[j].shouldExposeConditionDetails")
$shouldExposeExecPathMsgOnly = $jResp.BoolOf("versions[i].steps[j].shouldExposeExecPathMsgOnly")
$shouldShowExplExternally = $jResp.BoolOf("versions[i].steps[j].shouldShowExplExternally")
$stepType = $jResp.StringOf("versions[i].steps[j].stepType")
$j = $j + 1
}
$j = 0
$count_j = $jResp.SizeOfArray("versions[i].variables")
while ($j -lt $count_j) {
$jResp.J = $j
$collection = $jResp.BoolOf("versions[i].variables[j].collection")
$dataType = $jResp.StringOf("versions[i].variables[j].dataType")
$description = $jResp.StringOf("versions[i].variables[j].description")
$input = $jResp.BoolOf("versions[i].variables[j].input")
$name = $jResp.StringOf("versions[i].variables[j].name")
$output = $jResp.BoolOf("versions[i].variables[j].output")
$v_type = $jResp.StringOf("versions[i].variables[j].type")
$value = $jResp.StringOf("versions[i].variables[j].value")
$j = $j + 1
}
$i = $i + 1
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId
Postman Collection Item JSON
{
"name": "Expression Set Retrieve",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"business-rules",
"expression-set",
":expressionSetId"
],
"variable": [
{
"key": "expressionSetId",
"value": "9QLHo000000LBngOAG",
"description": "Expression Set Id: For Example 9QLHo000000LBjEOAW"
}
]
},
"description": "# Expression Set Retrieve and Delete (DELETE, GET)\n\nEndpoints to read, and delete expression set.Resource\n\n```\n/connect/business-rules/expression-set/${expressionSetId}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect\n /business-rules/expressionSet/$11Oxx0000006PcLEAU\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nDELETE, GET\n\nRequest body for GET\n\nRoot XML tag\n\nJSON example\n\n```\n{\n \"name\": \"CTX Mapping ES\",\n \"apiName\": \"CTX_Mapping_ES_1\",\n \"description\": \"...\",\n \"usageType\": \"Bre\",\n \"contextDefinitions\": [\n {\n \"id\": \"11Oxx0000006PcLEAU\"\n }\n ],\n \"versions\": [\n {\n \"name\": \"CTX_Mapping_ES_1 V1\",\n \"apiName\": \"CTX_Mapping_ES_1_V1\",\n \"description\": \"Sample CTX Mapping\",\n \"startDate\": \"2022-11-14T20:31:47.000+0000\",\n \"endDate\": \"2022-11-14T20:31:47.000+0000\",\n \"versionNumber\": 1,\n \"rank\": 1,\n \"enabled\": true,\n \"showExplExternally\": false,\n \"steps\": [\n {\n \"name\": \"Condition1\",\n \"description\": \"Condition step for conditions w.r.t product\",\n \"sequenceNumber\": 1,\n \"resultIncluded\": true,\n \"stepType\": \"Condition\",\n \"conditionExpression\": {\n \"expression\": \"productName == 'iPhone' && productColor == 'Red'\",\n \"resultParameter\": \"condition_output__1\"\n }\n }\n ],\n \"variables\": [\n {\n \"name\": \"productName\",\n \"collection\": false,\n \"dataType\": \"Text\",\n \"description\": \"productName\",\n \"input\": true,\n \"output\": false,\n \"type\": \"Variable\"\n },\n {\n \"name\": \"productColor\",\n \"collection\": false,\n \"dataType\": \"Text\",\n \"description\": \"productColor\",\n \"input\": true,\n \"output\": false,\n \"type\": \"Variable\"\n },\n {\n \"name\": \"condition_output__1\",\n \"dataType\": \"Boolean\",\n \"description\": \"condition_output__1\",\n \"input\": false,\n \"output\": true,\n \"resultStep\": \"Condition1\",\n \"type\": \"Variable\"\n }\n ]\n }\n ]\n}\n\n ```\n\nProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| apiName | String | Unique name of the expression set. | Required | 58.0 |\n| contextDefinitions | [Context Definition Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_context_definition_input.htm) | List of context definitions in an expression set. | Optional | 58.0 |\n| description | String | Description of the expression set. | Optional | 58.0 |\n| name | String | Name of the expression set. | Required | 58.0 |\n| usageType | String | Usage type of the expression set. <br> <br>Valid values are: <br> <br>\\- AiAcceleratorSubscriberChurnPrediction—Used for Industries Einstein <br> <br>\\- Bre—Used for Business Rules Engine <br> <br>\\- CustomLoyalty—Used for Loyalty Management <br> <br>\\- DefaultPricing—Used for Pricing Plans in Enterprise Product Catalog (EPC) by Communications Cloud <br> <br>\\- Qualification—Used for Industries Communications, Media, and Energy (CME) <br> <br>\\- RecordAlert—Used for Financial Services Cloud <br> <br>\\- ShipAndDebit—Used for Manufacturing Cloud <br> <br>\\- TierProcessing—Used for Loyalty Management <br> <br>\\- TransactionJournal—Used for Loyalty Management <br> <br>\\- WarrantyClaim—Used for Manufacturing Cloud | Required | 58.0 |\n| versions | [Expression Set Version Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_expression_set_version.htm)\\[\\] | List of the expression set versions. | Optional | 58.0 |\n\nResponse body for GET[Expression Set Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_expression_set_output.htm)"
},
"response": [
{
"name": "Status200-RecordFound",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"business-rules",
"expression-set",
":expressionSetId"
],
"variable": [
{
"key": "expressionSetId",
"value": "9QLHo000000LBjEOAW",
"description": "Expression Set Id: For Example 9QLHo000000LBjEOAW"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 06 Sep 2023 09:34:42 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"apiName\": \"myExpressionSet\",\n \"contextDefinitions\": [],\n \"id\": \"9QLHo000000LBjEOAW\",\n \"name\": \"myExpressionSet\",\n \"usageType\": \"Bre\",\n \"versions\": [\n {\n \"apiName\": \"myExpressionSet_V1\",\n \"description\": \"myExpressionSet V1 Description\",\n \"enabled\": true,\n \"id\": \"9QMHo000000LBjJOAW\",\n \"name\": \"myExpressionSet V1\",\n \"rank\": 1,\n \"showExplExternally\": true,\n \"startDate\": \"2023-09-06T09:27:06.000Z\",\n \"steps\": [\n {\n \"actionType\": \"AssignParameterValues\",\n \"assignment\": {\n \"assignedParameter\": \"condition_output__1\",\n \"expression\": \"true\"\n },\n \"description\": \"my Description\",\n \"name\": \"myCalculation\",\n \"resultIncluded\": true,\n \"sequenceNumber\": 1,\n \"shouldExposeConditionDetails\": false,\n \"shouldExposeExecPathMsgOnly\": true,\n \"shouldShowExplExternally\": false,\n \"stepType\": \"BusinessKnowledgeModel\"\n }\n ],\n \"variables\": [\n {\n \"collection\": false,\n \"dataType\": \"Boolean\",\n \"description\": \"condition_output__1\",\n \"input\": false,\n \"name\": \"condition_output__1\",\n \"output\": true,\n \"type\": \"Variable\",\n \"value\": \"False\"\n },\n {\n \"collection\": false,\n \"dataType\": \"Boolean\",\n \"description\": \"condition_output__2\",\n \"input\": false,\n \"name\": \"condition_output__2\",\n \"output\": false,\n \"type\": \"Variable\",\n \"value\": \"False\"\n }\n ],\n \"versionNumber\": 1\n }\n ]\n}"
},
{
"name": "Status404-RecordNotFound",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"business-rules",
"expression-set",
":expressionSetId"
],
"variable": [
{
"key": "expressionSetId",
"value": "9QLHo000000LBjEOA",
"description": "Expression Set Id: For Example 9QLHo000000LBjEOAW"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 06 Sep 2023 09:56:59 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "[\n {\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist\"\n }\n]"
},
{
"name": "Status400-PreviouslyDeletedRecord",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"business-rules",
"expression-set",
":expressionSetId"
],
"variable": [
{
"key": "expressionSetId",
"value": "9QLHo000000LBjEOAW",
"description": "Expression Set Id: For Example 9QLHo000000LBjEOAW"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 06 Sep 2023 10:29:39 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "[\n {\n \"errorCode\": \"INVALID_INPUT\",\n \"message\": \"The expression set id is not available.\"\n }\n]"
},
{
"name": "Status400-InvalidIdentifierOfVersion",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"business-rules",
"expression-set",
":expressionSetId"
],
"variable": [
{
"key": "expressionSetId",
"value": "9QMHo000000LBjOOAW",
"description": "Expression Set Id: For Example 9QLHo000000LBjEOAW"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 06 Sep 2023 10:37:51 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "[\n {\n \"errorCode\": \"INVALID_ID_FIELD\",\n \"message\": \"Invalid identifier: 9QMHo000000LBjOOAW\"\n }\n]"
}
]
}
