Chilkat Online Tools

Ruby / Salesforce Platform APIs / Expression Set Update

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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": "myExpressionSet",
#   "contextDefinitions": [
#   ],
#   "name": "myExpressionSet2",
#   "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
#     }
#   ]
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("apiName","myExpressionSet")
json.UpdateNewArray("contextDefinitions")
json.UpdateString("name","myExpressionSet2")
json.UpdateString("usageType","Bre")
json.UpdateString("versions[0].apiName","myExpressionSet_V1")
json.UpdateBool("versions[0].enabled",false)
json.UpdateString("versions[0].id","9QMHo000000LBjOOAW")
json.UpdateString("versions[0].name","myExpressionSet V1")
json.UpdateBool("versions[0].showExplExternally",false)
json.UpdateString("versions[0].startDate","2023-09-06T10:35:11.000Z")
json.UpdateNewArray("versions[0].steps")
json.UpdateNewArray("versions[0].variables")
json.UpdateInt("versions[0].versionNumber",1)

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PATCH","https://domain.com/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

# {
#   "apiName": "myExpressionSet",
#   "contextDefinitions": [
#   ],
#   "id": "9QLHo000000LBjJOAW",
#   "name": "myExpressionSet2",
#   "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

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 < count_i
    jResp.put_I(i)
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("versions")
while i < count_i
    jResp.put_I(i)
    apiName = jResp.stringOf("versions[i].apiName")
    enabled = jResp.BoolOf("versions[i].enabled")
    id = jResp.stringOf("versions[i].id")
    name = jResp.stringOf("versions[i].name")
    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 < count_j
        jResp.put_J(j)
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("versions[i].variables")
    while j < count_j
        jResp.put_J(j)
        j = j + 1
    end
    i = i + 1
end

Curl Command

curl -X PATCH
	-H "Authorization: Bearer <access_token>"
	-d '{
    "apiName": "myExpressionSet",
    "contextDefinitions": [],
    "name": "myExpressionSet2",
    "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/:expressionSetId

Postman Collection Item JSON

{
  "name": "Expression Set Update",
  "request": {
    "method": "PATCH",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"apiName\": \"myExpressionSet\",\n    \"contextDefinitions\": [],\n    \"name\": \"myExpressionSet2\",\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/:expressionSetId",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "connect",
        "business-rules",
        "expression-set",
        ":expressionSetId"
      ],
      "variable": [
        {
          "key": "expressionSetId",
          "value": "9QLHo000000LBjJOAW",
          "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW"
        }
      ]
    },
    "description": "# Expression Set Update (PATCH)\n\nEndpoints to read, and update 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, PATCH\n\nResponse body for GET\n\n[Expression Set Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_expression_set_output.htm)\n\nRequest body for PATCH\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 PATCH\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": "PATCH",
        "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": "9QLHo000000LBjJOAW",
              "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW"
            }
          ]
        }
      },
      "status": "Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 06 Sep 2023 10:43:16 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: 1895340064-166877 (-1526419893)\",\n        \"errorCode\": \"UNKNOWN_EXCEPTION\"\n    }\n]"
    },
    {
      "name": "Status400-UnrecognizedBodyField",
      "originalRequest": {
        "method": "PATCH",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\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}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "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": "9QLHo000000LBjJOAW",
              "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 06 Sep 2023 10:44:53 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\": \"JSON_PARSER_ERROR\",\n        \"message\": \"Unrecognized field \\\"id\\\" at [line:4, column:12]\"\n    }\n]"
    },
    {
      "name": "Status404-RecordNotFound",
      "originalRequest": {
        "method": "PATCH",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\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}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "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": "9QLHo000000LBjJOA",
              "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 06 Sep 2023 10:46:00 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-ErrorInvalidInput",
      "originalRequest": {
        "method": "PATCH",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"apiName\": \"myExpressionSet2\",\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/:expressionSetId",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "expression-set",
            ":expressionSetId"
          ],
          "variable": [
            {
              "key": "expressionSetId",
              "value": "9QLHo000000LBjJOAW",
              "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 06 Sep 2023 10:47:31 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\": \"You can’t modify the apiName of an expression set.\"\n    }\n]"
    },
    {
      "name": "Status200-SuccessfullyUpdated",
      "originalRequest": {
        "method": "PATCH",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"apiName\": \"myExpressionSet\",\n    \"contextDefinitions\": [],\n    \"name\": \"myExpressionSet2\",\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/:expressionSetId",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "expression-set",
            ":expressionSetId"
          ],
          "variable": [
            {
              "key": "expressionSetId",
              "value": "9QLHo000000LBjJOAW",
              "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 06 Sep 2023 10:48:19 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    \"apiName\": \"myExpressionSet\",\n    \"contextDefinitions\": [],\n    \"id\": \"9QLHo000000LBjJOAW\",\n    \"name\": \"myExpressionSet2\",\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}"
    }
  ]
}