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.
# {
# "inputs": [
# {
# "myColumnInput": "One"
# }
# ]
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("inputs[0].myColumnInput","One")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")
# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/services/data/v{{version}}/actions/custom/runDecisionMatrix/:UniqueName","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jarrResp = Chilkat::CkJsonArray.new()
jarrResp.LoadSb(sbResponseBody)
jarrResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jarrResp.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)
# [
# {
# "actionName": "myDecisionMatrix",
# "errors": null,
# "isSuccess": true,
# "outputValues": {
# "myColumnOutput": "1"
# },
# "version": 1
# }
# ]
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i = 0
count_i = jarrResp.get_Size()
while i < count_i
# json is a CkJsonObject
json = jarrResp.ObjectAt(i)
actionName = json.stringOf("actionName")
errors = json.stringOf("errors")
isSuccess = json.BoolOf("isSuccess")
MyColumnOutput = json.stringOf("outputValues.myColumnOutput")
version = json.IntOf("version")
i = i + 1
end
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"inputs":[
{
"myColumnInput":"One"
}
]
}'
https://domain.com/services/data/v{{version}}/actions/custom/runDecisionMatrix/:UniqueName
Postman Collection Item JSON
{
"name": "runDecisionMatrix",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"inputs\":[\n {\n \"myColumnInput\":\"One\"\n }\n ]\n}\n"
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/actions/custom/runDecisionMatrix/:UniqueName",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"actions",
"custom",
"runDecisionMatrix",
":UniqueName"
],
"variable": [
{
"key": "UniqueName",
"value": "myDecisionMatrix",
"description": "The value of UniqueName is the unique identifier of the record, which is sourced from the name of a decision matrix."
}
]
},
"description": "# Decision Matrix Actions\n\nInvoke a decision matrix in a flow with the Decision Matrix Actions. A decision matrix is a user-defined table where you can look up an output based on the inputs you provide.\n\nFor example, you can look up a candidate’s eligibility to avail medical insurance in a decision matrix based on the candidate’s age and gender.\n\nThese actions are available in API version 55.0 and later.\n\n## Supported REST HTTP Methods\n\nURI/services/data/v55.0/actions/custom/runDecisionMatrix/{UniqueName}\n\nNote\n\nThe value of UniqueName is the unique identifier of the record, which is sourced from the name of a decision matrix.\n\nFormatsJSONHTTP MethodsPOSTAuthenticationAuthorization: Bearer token\n\n## Inputs\n\nVary depending on the selected decision matrix.\n\n## Outputs\n\nVary depending on the inputs of the selected decision matrix.\n\n## Usage\n\nSample Request\n\nHere’s an example POST request that has the inputs, such as, age and state:\n\n```\n{\n \"inputs\":[\n {\n \"age\":\"25\",\n \"state\":\"NY\"\n },\n {\n \"age\":\"25\",\n \"state\":\"CA\"\n },\n {\n \"age\":\"\",\n \"state\":\"WA\"\n }\n ]\n}\n\n ```\n\nSample Response\n\nHere’s an example response that has the premium and tax values based on the inputs provided in the example request.\n\n```\n[\n {\n \"actionName\":\"premiumTaxLookup\",\n \"errors\":null,\n \"isSuccess\":true,\n \"outputValues\":{\n \"premium\":2400.0,\n \"tax\":200.0\n }\n },\n {\n \"actionName\":\"premiumTaxLookup\",\n \"errors\":null,\n \"isSuccess\":true,\n \"outputValues\":{\n \"premium\":2400.0,\n \"tax\":200.0\n }\n },\n {\n \"actionName\":\"premiumTaxLookup\",\n \"errors\":[\n {\n \"statusCode\":\"REQUIRED_FIELD_MISSING\",\n \"message\":\"Missing required input parameter: age\",\n \"fields\":[\n ]\n }\n ],\n \"isSuccess\":false,\n \"outputValues\":null\n }\n]\n\n ```"
},
"response": [
{
"name": "runDecisionMatrix",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"inputs\":[\n {\n \"myColumnInput\":\"One\"\n }\n ]\n}\n"
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/actions/custom/runDecisionMatrix/:UniqueName",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"actions",
"custom",
"runDecisionMatrix",
":UniqueName"
],
"variable": [
{
"key": "UniqueName",
"value": "myDecisionMatrix",
"description": "The value of UniqueName is the unique identifier of the record, which is sourced from the name of a decision matrix."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 07 Sep 2023 13:00:30 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": "Sforce-Limit-Info",
"value": "api-usage=15/15000"
},
{
"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 {\n \"actionName\": \"myDecisionMatrix\",\n \"errors\": null,\n \"isSuccess\": true,\n \"outputValues\": {\n \"myColumnOutput\": \"1\"\n },\n \"version\": 1\n }\n]"
}
]
}
