Chilkat Online Tools

Foxpro / Salesforce Platform APIs / Expression Set Creation

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnEnabled
LOCAL lnShowExplExternally
LOCAL lcStartDate
LOCAL lnVersionNumber
LOCAL j
LOCAL lnCount_j
LOCAL lcApiName
LOCAL lcId
LOCAL lcName
LOCAL lcUsageType
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.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.

* {
*   "apiName": "myExpressionSet2",
*   "contextDefinitions": [
*   ],
*   "name": "myExpressionSet3",
*   "usageType": "Bre",
*   "versions": [
*     {
*       "apiName": "myExpressionSet_V1",
*       "enabled": false,
*       "id": "9QMHo000000LBjOOAW",
*       "name": "myExpressionSet V1",
*       "showExplExternally": false,
*       "startDate": "2023-09-06T10:35:11.000Z",
*       "steps": [
*       ],
*       "variables": [
*       ],
*       "versionNumber": 1
*     }
*   ]
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("apiName","myExpressionSet2")
loJson.UpdateNewArray("contextDefinitions")
loJson.UpdateString("name","myExpressionSet3")
loJson.UpdateString("usageType","Bre")
loJson.UpdateString("versions[0].apiName","myExpressionSet_V1")
loJson.UpdateBool("versions[0].enabled",0)
loJson.UpdateString("versions[0].id","9QMHo000000LBjOOAW")
loJson.UpdateString("versions[0].name","myExpressionSet V1")
loJson.UpdateBool("versions[0].showExplExternally",0)
loJson.UpdateString("versions[0].startDate","2023-09-06T10:35:11.000Z")
loJson.UpdateNewArray("versions[0].steps")
loJson.UpdateNewArray("versions[0].variables")
loJson.UpdateInt("versions[0].versionNumber",1)

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

loResp = loHttp.PostJson3("https://domain.com/services/data/v{{version}}/connect/business-rules/expression-set","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

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

* {
*   "apiName": "myExpressionSet",
*   "contextDefinitions": [
*   ],
*   "id": "9QLHo000000LBjJOAW",
*   "name": "myExpressionSet",
*   "usageType": "Bre",
*   "versions": [
*     {
*       "apiName": "myExpressionSet_V1",
*       "enabled": false,
*       "id": "9QMHo000000LBjOOAW",
*       "name": "myExpressionSet V1",
*       "showExplExternally": false,
*       "startDate": "2023-09-06T10:35:11.000Z",
*       "steps": [
*       ],
*       "variables": [
*       ],
*       "versionNumber": 1
*     }
*   ]
* }

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

lcApiName = loJResp.StringOf("apiName")
lcId = loJResp.StringOf("id")
lcName = loJResp.StringOf("name")
lcUsageType = loJResp.StringOf("usageType")
i = 0
lnCount_i = loJResp.SizeOfArray("contextDefinitions")
DO WHILE i < lnCount_i
    loJResp.I = i
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("versions")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcApiName = loJResp.StringOf("versions[i].apiName")
    lnEnabled = loJResp.BoolOf("versions[i].enabled")
    lcId = loJResp.StringOf("versions[i].id")
    lcName = loJResp.StringOf("versions[i].name")
    lnShowExplExternally = loJResp.BoolOf("versions[i].showExplExternally")
    lcStartDate = loJResp.StringOf("versions[i].startDate")
    lnVersionNumber = loJResp.IntOf("versions[i].versionNumber")
    j = 0
    lnCount_j = loJResp.SizeOfArray("versions[i].steps")
    DO WHILE j < lnCount_j
        loJResp.J = j
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJResp.SizeOfArray("versions[i].variables")
    DO WHILE j < lnCount_j
        loJResp.J = j
        j = j + 1
    ENDDO
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "apiName": "myExpressionSet2",
    "contextDefinitions": [],
    "name": "myExpressionSet3",
    "usageType": "Bre",
    "versions": [
        {
            "apiName": "myExpressionSet_V1",
            "enabled": false,
            "id": "9QMHo000000LBjOOAW",
            "name": "myExpressionSet V1",
            "showExplExternally": false,
            "startDate": "2023-09-06T10:35:11.000Z",
            "steps": [],
            "variables": [],
            "versionNumber": 1
        }
    ]
}'
https://domain.com/services/data/v{{version}}/connect/business-rules/expression-set

Postman Collection Item JSON

{
  "name": "Expression Set Creation",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"apiName\": \"myExpressionSet2\",\n    \"contextDefinitions\": [],\n    \"name\": \"myExpressionSet3\",\n    \"usageType\": \"Bre\",\n    \"versions\": [\n        {\n            \"apiName\": \"myExpressionSet_V1\",\n            \"enabled\": false,\n            \"id\": \"9QMHo000000LBjOOAW\",\n            \"name\": \"myExpressionSet V1\",\n            \"showExplExternally\": false,\n            \"startDate\": \"2023-09-06T10:35:11.000Z\",\n            \"steps\": [],\n            \"variables\": [],\n            \"versionNumber\": 1\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "connect",
        "business-rules",
        "expression-set"
      ]
    },
    "description": "[https://developer.salesforce.com/docs/atlas.en-us.246.0.industries_reference.meta/industries_reference/connect_resources_bre_create_expression_set.htm](https://developer.salesforce.com/docs/atlas.en-us.246.0.industries_reference.meta/industries_reference/connect_resources_bre_create_expression_set.htm)\n\n# Expression Set Creation (POST)\n\nCreates an expression set in Business Rules Engine. An expression set performs a series of calculations by using lookup tables and user-defined variables and constants.Resource\n\n```\n/connect/business-rules/expression-set\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect\n/business-rules/expression-set\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nPOST\n\nRequest body for POST\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| context​Definitions | [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| usage​Type | String | Usage type of the expression set.<br><br>Valid values are:<br><br>- AiAccelerator​SubscriberChurn​Prediction—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 POST\n\n[Expression Set Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_expression_set_output.htm)"
  },
  "response": [
    {
      "name": "Status500-ErrorNoBody",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "expression-set"
          ]
        }
      },
      "status": "Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 06 Sep 2023 10:21: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": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "[\n    {\n        \"message\": \"An unexpected error occurred. Please include this ErrorId if you contact support: 675649159-184801 (-177293139)\",\n        \"errorCode\": \"UNKNOWN_EXCEPTION\"\n    }\n]"
    },
    {
      "name": "Status400-MissingMandatoryBodyFields",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "expression-set"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 06 Sep 2023 10:31:10 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 value for name parameter and try again.\"\n    }\n]"
    },
    {
      "name": "Status400-InvalidEnum",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"apiName\": \"myExpressionSet\",\n    \"name\": \"myExpressionSet\",\n    \"usageType\": \"myExpressionSet\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "expression-set"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 06 Sep 2023 10:34:18 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\": \"POST_BODY_PARSE_ERROR\",\n        \"message\": \"Invalid value for Expression Set Usage Type enum values: myExpressionSet\"\n    }\n]"
    },
    {
      "name": "Status201-SuccessCreatedOnlyMandatoryFields",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"apiName\": \"myExpressionSet\",\n    \"name\": \"myExpressionSet\",\n    \"usageType\": \"Bre\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "expression-set"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 06 Sep 2023 10:35:10 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\": \"9QLHo000000LBjJOAW\",\n    \"name\": \"myExpressionSet\",\n    \"usageType\": \"Bre\",\n    \"versions\": [\n        {\n            \"apiName\": \"myExpressionSet_V1\",\n            \"enabled\": false,\n            \"id\": \"9QMHo000000LBjOOAW\",\n            \"name\": \"myExpressionSet V1\",\n            \"showExplExternally\": false,\n            \"startDate\": \"2023-09-06T10:35:11.000Z\",\n            \"steps\": [],\n            \"variables\": [],\n            \"versionNumber\": 1\n        }\n    ]\n}"
    },
    {
      "name": "Status400-Duplicate",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"apiName\": \"myExpressionSet\",\n    \"contextDefinitions\": [],\n    \"name\": \"myExpressionSet\",\n    \"usageType\": \"Bre\",\n    \"versions\": [\n        {\n            \"apiName\": \"myExpressionSet_V1\",\n            \"enabled\": false,\n            \"id\": \"9QMHo000000LBjOOAW\",\n            \"name\": \"myExpressionSet V1\",\n            \"showExplExternally\": false,\n            \"startDate\": \"2023-09-06T10:35:11.000Z\",\n            \"steps\": [],\n            \"variables\": [],\n            \"versionNumber\": 1\n        }\n    ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "expression-set"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 06 Sep 2023 11:02: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_INPUT\",\n        \"message\": \"An expression set with the API name myExpressionSet exists. Specify a unique apiName for the expression set and try again.\"\n    }\n]"
    }
  ]
}