Chilkat Online Tools

Python / Salesforce Platform APIs / Expression Set Invocation

Back to Collection Items

import sys
import chilkat2

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = chilkat2.Http()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "inputs": [
#     {}
#   ],
#   "options": {}
# }

json = chilkat2.JsonObject()
json.UpdateNewObject("options")

# Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/services/data/v{{version}}/connect/business-rules/expressionset/:expressionSetAPIName","application/json",json)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

print("Response Body:")
print(jResp.Emit())

respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(resp.Header)
    print("Failed.")

    sys.exit()

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "aggregationResults": {
#     "results": {}
#   },
#   "executionId": "33045b23-8970-4fbe-a80c-8f4302592566",
#   "outputs": [
#     {
#       "results": {
#         "output": 1
#       }
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

executionId = jResp.StringOf("executionId")
i = 0
count_i = jResp.SizeOfArray("outputs")
while i < count_i :
    jResp.I = i
    Output = jResp.IntOf("outputs[i].results.output")
    i = i + 1

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
  "inputs": [{}],
  "options": {}
}'
https://domain.com/services/data/v{{version}}/connect/business-rules/expressionset/:expressionSetAPIName

Postman Collection Item JSON

{
  "name": "Expression Set Invocation",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"inputs\": [{}],\n  \"options\": {}\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expressionset/:expressionSetAPIName",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "connect",
        "business-rules",
        "expressionset",
        ":expressionSetAPIName"
      ],
      "variable": [
        {
          "key": "expressionSetAPIName",
          "value": "",
          "description": "The API name of an expression set is unique within your Salesforce instance."
        }
      ]
    },
    "description": "[https://developer.salesforce.com/docs/atlas.en-us.246.0.industries_reference.meta/industries_reference/connect_resources_bre_expression_set.htm](https://developer.salesforce.com/docs/atlas.en-us.246.0.industries_reference.meta/industries_reference/connect_resources_bre_expression_set.htm)\n\n**WATCH OUT**: path **expressionSet** has no dash [gjeffcock@salesforce.com](https://gjeffcock@salesforce.com)\n\n# Expression Set Invocation (POST)\n\nInvokes expression sets in Business Rule Engine.Resource\n\n```\n/connect/business-rules/expressionSet/${expressionSetName}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/vXX.X/connect\n/business-rules/expressionSet/${expressionSetName}\n\n ```\n\nAvailable version\n\n55.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nPOST\n\nRequest body for POST\n\nJSON example 1\n\n```\n{\n  \"inputs\": [\n    {\n      \"age\": \"25\",\n      \"state\": \"CA\"\n      \"PatientId\":\"001xx000003GYjnAAG\"\n    }\n   \n  ],\n  \"options\": {\n    \"effectiveDate\": \"2022-12-03T10:15:30Z\",\n    \"useDatesOnly\": \"true\"\n  }\n}\n\n ```\n\nJSON example 2\n\n```\n{\n  \"inputs\": [\n    {\n      \"age\": \"25\",\n      \"state\": \"CA\"\n      \"PatientId\":\"001xx000003GYjnAAG\"\n      \"__actionContextCode\":\"001xx000003GYjnAAG\"    }\n   \n  ],\n  \"options\": {\n    \"effectiveDate\": \"2022-12-03T10:15:30Z\",\n    \"useDatesOnly\": \"true\"\n  }\n}\n\n ```\n\nNote\n\nYou can use more than one actionContextCode for multiple sets of inputs, passed in a single API call.\n\nProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| inputs | Map\\[\\] | List of inputs passed to an expression set. An input may contain multiple variables.<br><br>Note<br><br>If the expression set uses a field alias as a variable, append Id to the object alias to which the field alias belongs, and pass the ID of the source object linked to the object alias. | Required | 55.0 |\n| options | [Expression Set Options Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_options.htm) | The options for executing an expression set. | Optional | 55.0 |\n\nResponse body for POST\n\n[Business Rules Result](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_business_rules_result.htm)"
  },
  "response": [
    {
      "name": "Status500-EmptyBodyButRecordExists",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expressionset/:expressionSetAPIName",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "expressionset",
            ":expressionSetAPIName"
          ],
          "variable": [
            {
              "key": "expressionSetAPIName",
              "value": "myExpressionSet",
              "description": "The API name of an expression set is unique within your Salesforce instance."
            }
          ]
        }
      },
      "status": "Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 07 Sep 2023 07:48:43 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        \"message\": \"An unexpected error occurred. Please include this ErrorId if you contact support: 597330588-4312 (-1669188241)\",\n        \"errorCode\": \"UNKNOWN_EXCEPTION\"\n    }\n]"
    },
    {
      "name": "Status400-InvalidExpressionSetName",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"inputs\": [{}],\n  \"options\": {}\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expressionset/:expressionSetAPIName",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "expressionset",
            ":expressionSetAPIName"
          ],
          "variable": [
            {
              "key": "expressionSetAPIName",
              "value": "blah blah",
              "description": "The API name of an expression set is unique within your Salesforce instance."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 07 Sep 2023 08:03:38 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\": \"Specify a valid expressionSetName and try again.\"\n    }\n]"
    },
    {
      "name": "Status201-Success",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"inputs\": [{}],\n  \"options\": {}\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expressionset/:expressionSetAPIName",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "expressionset",
            ":expressionSetAPIName"
          ],
          "variable": [
            {
              "key": "expressionSetAPIName",
              "value": "myExpressionSet",
              "description": "The API name of an expression set is unique within your Salesforce instance."
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 07 Sep 2023 08:05:45 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    \"aggregationResults\": {\n        \"results\": {}\n    },\n    \"executionId\": \"33045b23-8970-4fbe-a80c-8f4302592566\",\n    \"outputs\": [\n        {\n            \"results\": {\n                \"output\": 1\n            }\n        }\n    ]\n}"
    }
  ]
}