Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- 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"
-- }
-- ]
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'inputs[0].myColumnInput', 'One'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/services/data/v{{version}}/actions/custom/runDecisionMatrix/:UniqueName', 'application/json', @json
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jarrResp int
-- Use "Chilkat_9_5_0.JsonArray" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonArray', @jarrResp OUT
EXEC sp_OAMethod @jarrResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jarrResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jarrResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jarrResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- 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
DECLARE @json int
DECLARE @actionName nvarchar(4000)
DECLARE @errors nvarchar(4000)
DECLARE @isSuccess int
DECLARE @MyColumnOutput nvarchar(4000)
DECLARE @version int
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAGetProperty @jarrResp, 'Size', @count_i OUT
WHILE @i < @count_i
BEGIN
EXEC sp_OAMethod @jarrResp, 'ObjectAt', @json OUT, @i
EXEC sp_OAMethod @json, 'StringOf', @actionName OUT, 'actionName'
EXEC sp_OAMethod @json, 'StringOf', @errors OUT, 'errors'
EXEC sp_OAMethod @json, 'BoolOf', @isSuccess OUT, 'isSuccess'
EXEC sp_OAMethod @json, 'StringOf', @MyColumnOutput OUT, 'outputValues.myColumnOutput'
EXEC sp_OAMethod @json, 'IntOf', @version OUT, 'version'
EXEC @hr = sp_OADestroy @json
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jarrResp
END
GO
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]"
}
]
}
