Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJarrResp
Integer iRespStatusCode
Variant vJson
Handle hoJson
String sActionName
String sErrors
Boolean iIsSuccess
String sMyColumnOutput
Integer iVersion
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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"
// }
// ]
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "inputs[0].myColumnInput" "One" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Get pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://domain.com/services/data/v{{version}}/actions/custom/runDecisionMatrix/:UniqueName" "application/json" vJson To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonArray)) To hoJarrResp
If (Not(IsComObjectCreated(hoJarrResp))) Begin
Send CreateComObject of hoJarrResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJarrResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJarrResp To False
Showln "Response Body:"
Get ComEmit Of hoJarrResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Move 0 To i
Get ComSize Of hoJarrResp To iCount_i
While (i < iCount_i)
Get ComObjectAt Of hoJarrResp i To vJson
If (IsComObject(vJson)) Begin
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
Set pvComObject Of hoJson To vJson
End
Get ComStringOf Of hoJson "actionName" To sActionName
Get ComStringOf Of hoJson "errors" To sErrors
Get ComBoolOf Of hoJson "isSuccess" To iIsSuccess
Get ComStringOf Of hoJson "outputValues.myColumnOutput" To sMyColumnOutput
Get ComIntOf Of hoJson "version" To iVersion
Send Destroy of hoJson
Move (i + 1) To i
Loop
End_Procedure
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]"
}
]
}
