Chilkat Online Tools

Ruby / Salesforce Platform APIs / Lookup Table

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": [
#     {
#       "input": [
#         {
#           "name": "myColumnInput",
#           "value": "One"
#         }
#       ]
#     }
#   ],
#   "options": {}
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("inputs[0].input[0].name","myColumnInput")
json.UpdateString("inputs[0].input[0].value","One")
json.UpdateNewObject("options")

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

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/services/data/v{{version}}/connect/business-rules/decision-matrices/:matrixUniqueName","application/json",json)
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)

# {
#   "outputs": [
#     {
#       "error": "Looks like there isn’t any output for the specified input parameters in the lookup table.",
#       "results": [
#       ]
#     }
#   ]
# }

# 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 = jResp.SizeOfArray("outputs")
while i < count_i
    jResp.put_I(i)
    error = jResp.stringOf("outputs[i].error")
    j = 0
    count_j = jResp.SizeOfArray("outputs[i].results")
    while j < count_j
        jResp.put_J(j)
        j = j + 1
    end
    i = i + 1
end

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "inputs": [
        {
            "input": [
                {
                    "name": "myColumnInput",
                    "value": "One"
                }
            ]
        }
    ],
    "options": {}
}'
https://domain.com/services/data/v{{version}}/connect/business-rules/decision-matrices/:matrixUniqueName

Postman Collection Item JSON

{
  "name": "Lookup Table",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"inputs\": [\n        {\n            \"input\": [\n                {\n                    \"name\": \"myColumnInput\",\n                    \"value\": \"One\"\n                }\n            ]\n        }\n    ],\n    \"options\": {}\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-matrices/:matrixUniqueName",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "connect",
        "business-rules",
        "decision-matrices",
        ":matrixUniqueName"
      ],
      "variable": [
        {
          "key": "matrixUniqueName",
          "value": "myDecisionMatrix",
          "description": "The value of Unique Name is the unique identifier of the record, which is sourced from the name of a decision matrix."
        }
      ]
    },
    "description": "# Decision Matrix (Lookup Table)\n\nPerforms a lookup on decision matrix rows based on the input values provided, and returns the row’s output.Resource\n\n```\n/connect/business-rules/decision-matrices/${matrixName}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/vXX.X/connect\n/business-rules/decision-matrices/InsurancePremium\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\n\n```\n{\n  \"inputs\": [\n    {\n      \"input\": [\n        {\n          \"name\": \"premium\",\n          \"value\": \"2400\"\n        }\n      ]\n    }\n  ],\n  \"options\": {\n    \"effectiveDate\": \"2022-12-03T10:15:30Z\"\n  }\n}\n\n ```\n\nHere, premium is a column header in the matrix, and 2400 is a value of a cell in the column.Properties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| inputs | [Decision Matrix Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_decision_matrix_input.htm) | List of inputs passed to a decision matrix. An input may contain multiple variables. | Required | 55.0 |\n| options | [Decision Matrix Options Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_decision_matrix_options.htm) | The lookup options for a decision matrix. | Optional | 55.0 |\n\nResponse body for POST\n\n[Decision Matrix Lookup Result](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_bre_decision_matrix_lookup_result.htm)"
  },
  "response": [
    {
      "name": "Status401-Unauthorized",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-matrices/:matrixUniqueName",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "decision-matrices",
            ":matrixUniqueName"
          ],
          "variable": [
            {
              "key": "matrixUniqueName",
              "value": "blah",
              "description": "Matrix Unique Name"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 07 Sep 2023 11:49:04 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": "WWW-Authenticate",
          "value": "Token"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "[\n    {\n        \"message\": \"Session expired or invalid\",\n        \"errorCode\": \"INVALID_SESSION_ID\"\n    }\n]"
    },
    {
      "name": "Status400-MatrixNotFound",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-matrices/:matrixUniqueName",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "decision-matrices",
            ":matrixUniqueName"
          ],
          "variable": [
            {
              "key": "matrixUniqueName",
              "value": "blah",
              "description": "Matrix Unique Name"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 07 Sep 2023 11:50: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    {\n        \"errorCode\": \"INVALID_INPUT\",\n        \"message\": \"Specify a valid matrixName and try again.\"\n    }\n]"
    },
    {
      "name": "Status400-UnknownException",
      "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/decision-matrices/:matrixAPIName",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "decision-matrices",
            ":matrixAPIName"
          ],
          "variable": [
            {
              "key": "matrixAPIName",
              "value": "myDecisionMatrix",
              "description": "Matrix API Name"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 07 Sep 2023 12:10:47 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\": \"UNKNOWN_EXCEPTION\",\n        \"message\": \"Something went wrong. Try again or ask your Salesforce admin for help.\"\n    }\n]"
    },
    {
      "name": "Status201-AcceptedButWarning",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"inputs\": [\n    {\n      \"input\": [\n        {\n          \"name\": \"myColumnInput\",\n          \"value\": \"One\"\n        }\n      ]\n    }\n  ],\n  \"options\": {\n    \"effectiveDate\": \"2022-12-03T10:15:30Z\"\n  }\n}\n",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-matrices/:matrixAPIName",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "decision-matrices",
            ":matrixAPIName"
          ],
          "variable": [
            {
              "key": "matrixAPIName",
              "value": "myDecisionMatrix",
              "description": "Matrix API Name"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 07 Sep 2023 12:12:26 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    \"outputs\": [\n        {\n            \"error\": \"Looks like there isn’t any output for the specified input parameters in the lookup table.\",\n            \"results\": []\n        }\n    ]\n}"
    },
    {
      "name": "Status201-Success",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"inputs\": [\n        {\n            \"input\": [\n                {\n                    \"name\": \"myColumnInput\",\n                    \"value\": \"One\"\n                }\n            ]\n        }\n    ],\n    \"options\": {}\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-matrices/:matrixAPIName",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "decision-matrices",
            ":matrixAPIName"
          ],
          "variable": [
            {
              "key": "matrixAPIName",
              "value": "myDecisionMatrix",
              "description": "Matrix API Name"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 07 Sep 2023 12:15:06 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    \"outputs\": [\n        {\n            \"results\": [\n                {\n                    \"name\": \"myColumnOutput\",\n                    \"value\": \"1\"\n                }\n            ]\n        }\n    ]\n}"
    },
    {
      "name": "Status201-Success",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-matrices/:matrixUniqueName",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "decision-matrices",
            ":matrixUniqueName"
          ],
          "variable": [
            {
              "key": "matrixUniqueName",
              "value": "myDecisionMatrix",
              "description": "Matrix Unique Name"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 07 Sep 2023 12:02:02 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    \"outputs\": []\n}"
    },
    {
      "name": "Status201-KeyPairNotFound",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"inputs\": [\n        {\n            \"input\": [\n                {\n                    \"name\": \"myColumnInput\",\n                    \"value\": \"Two\"\n                }\n            ]\n        }\n    ],\n    \"options\": {}\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-matrices/:matrixUniqueName",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "decision-matrices",
            ":matrixUniqueName"
          ],
          "variable": [
            {
              "key": "matrixUniqueName",
              "value": "myDecisionMatrix",
              "description": "Matrix Unique Name"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 07 Sep 2023 12:28:57 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    \"outputs\": [\n        {\n            \"error\": \"Looks like there isn’t any output for the specified input parameters in the lookup table.\",\n            \"results\": []\n        }\n    ]\n}"
    }
  ]
}