Chilkat Online Tools

SQL Server / Salesforce Platform APIs / Invoke

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
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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.

    -- {
    --   "datasetLinkName": "transactionMapping",
    --   "conditions": [
    --     {
    --       "conditionsList": [
    --         {
    --           "fieldName": "Product__c",
    --           "value": "Nike",
    --           "operator": "Matches"
    --         },
    --         {
    --           "fieldName": "Price__c",
    --           "value": 1000,
    --           "operator": "GreaterThan"
    --         }
    --       ]
    --     },
    --     {
    --       "conditionsList": [
    --         {
    --           "fieldName": "Product__c",
    --           "value": "Adidas",
    --           "operator": "Matches"
    --         },
    --         {
    --           "fieldName": "Price__c",
    --           "value": 1500,
    --           "operator": "GreaterThan"
    --         }
    --       ]
    --     }
    --   ]
    -- }

    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'datasetLinkName', 'transactionMapping'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'conditions[0].conditionsList[0].fieldName', 'Product__c'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'conditions[0].conditionsList[0].value', 'Nike'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'conditions[0].conditionsList[0].operator', 'Matches'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'conditions[0].conditionsList[1].fieldName', 'Price__c'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'conditions[0].conditionsList[1].value', 1000
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'conditions[0].conditionsList[1].operator', 'GreaterThan'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'conditions[1].conditionsList[0].fieldName', 'Product__c'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'conditions[1].conditionsList[0].value', 'Adidas'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'conditions[1].conditionsList[0].operator', 'Matches'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'conditions[1].conditionsList[1].fieldName', 'Price__c'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'conditions[1].conditionsList[1].value', 1500
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'conditions[1].conditionsList[1].operator', 'GreaterThan'

    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/services/data/v{{version}}/connect/business-rules/decision-table/lookup/:decisionTableId', '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
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody

    DECLARE @jResp int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT

    EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
    EXEC sp_OASetProperty @jResp, 'EmitCompact', 0


    PRINT 'Response Body:'
    EXEC sp_OAMethod @jResp, '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 @jResp
        RETURN
      END
    EXEC @hr = sp_OADestroy @resp

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

    -- {
    --   "outputs": [
    --     {
    --       "errorCode": 400,
    --       "errorMessage": "Specify valid name for Data set Link",
    --       "outcomeList": [
    --       ],
    --       "outcomeType": null,
    --       "successStatus": false
    --     },
    --     {
    --       "errorCode": 400,
    --       "errorMessage": "Specify valid name for Data set Link",
    --       "outcomeList": [
    --       ],
    --       "outcomeType": null,
    --       "successStatus": false
    --     }
    --   ]
    -- }

    -- Sample code for parsing the JSON response...
    -- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    DECLARE @errorCode int

    DECLARE @errorMessage nvarchar(4000)

    DECLARE @outcomeType nvarchar(4000)

    DECLARE @successStatus int

    DECLARE @j int

    DECLARE @count_j int

    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'outputs'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'IntOf', @errorCode OUT, 'outputs[i].errorCode'
        EXEC sp_OAMethod @jResp, 'StringOf', @errorMessage OUT, 'outputs[i].errorMessage'
        EXEC sp_OAMethod @jResp, 'StringOf', @outcomeType OUT, 'outputs[i].outcomeType'
        EXEC sp_OAMethod @jResp, 'BoolOf', @successStatus OUT, 'outputs[i].successStatus'
        SELECT @j = 0
        EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'outputs[i].outcomeList'
        WHILE @j < @count_j
          BEGIN
            EXEC sp_OASetProperty @jResp, 'J', @j
            SELECT @j = @j + 1
          END
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jResp


END
GO

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "datasetLinkName": "transactionMapping",
    "conditions": [
        {
            "conditionsList": [
                {
                    "fieldName": "Product__c",
                    "value": "Nike",
                    "operator": "Matches" //Operator is optional
                },
                {
                    "fieldName": "Price__c",
                    "value": 1000,
                    "operator": "GreaterThan"
                }
            ]
        },
        {
            "conditionsList": [
                {
                    "fieldName": "Product__c",
                    "value": "Adidas",
                    "operator": "Matches" //Operator is optional
                },
                {
                    "fieldName": "Price__c",
                    "value": 1500,
                    "operator": "GreaterThan"
                }
            ]
        }
    ]
}'
https://domain.com/services/data/v{{version}}/connect/business-rules/decision-table/lookup/:decisionTableId

Postman Collection Item JSON

{
  "name": "Invoke",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"datasetLinkName\": \"transactionMapping\",\n    \"conditions\": [\n        {\n            \"conditionsList\": [\n                {\n                    \"fieldName\": \"Product__c\",\n                    \"value\": \"Nike\",\n                    \"operator\": \"Matches\" //Operator is optional\n                },\n                {\n                    \"fieldName\": \"Price__c\",\n                    \"value\": 1000,\n                    \"operator\": \"GreaterThan\"\n                }\n            ]\n        },\n        {\n            \"conditionsList\": [\n                {\n                    \"fieldName\": \"Product__c\",\n                    \"value\": \"Adidas\",\n                    \"operator\": \"Matches\" //Operator is optional\n                },\n                {\n                    \"fieldName\": \"Price__c\",\n                    \"value\": 1500,\n                    \"operator\": \"GreaterThan\"\n                }\n            ]\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/lookup/:decisionTableId",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "connect",
        "business-rules",
        "decision-table",
        "lookup",
        ":decisionTableId"
      ],
      "variable": [
        {
          "key": "decisionTableId",
          "value": "0lDHo0000008Po3",
          "description": "Decision Table Id"
        }
      ]
    },
    "description": "# Invoke Decision Tables\n\nInvoke a decision table by passing multiple input conditions within the same request.Resource\n\n```\n/connect/business-rules/decision-table/lookup/${decisionTableId}\n\n ```\n\nResource example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect\n/business-rules/decision-table/lookup/${0lDD2000000004NMAQ}\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nPOST\n\nRequest body for POST\n\nJSON example\n\n```\n{\n   \"datasetLinkName\" : \"transactionMapping\",\n   “conditions” :[\n      {\n        “conditionsList”: [\n          {\n              \"fieldName\": \"Product__c\",\n              \"value\": \"Nike\",\n              \"operator\": \"Matches\" //Operator is optional\n          },\n          {\n              \"fieldName\": \"Price__c\",\n              \"value\": 1000,\n              \"operator\": \"GreaterThan\"\n          }\n        ]\n      },\n      {\n        “conditionsList”: [\n          {\n              \"fieldName\": \"Product__c\",\n              \"value\": \"Adidas\",\n              \"operator\": \"Matches\" //Operator is optional\n          },\n          {\n              \"fieldName\": \"Price__c\",\n              \"value\": 1500,\n              \"operator\": \"GreaterThan\"\n          }\n        ]\n\n ```\n\nProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| conditions | [Decision Table Condition List](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_decision_table_condition_list_input.htm) | The list of decision table conditions on which the decision table executes and provides outcomes. | Required | 58.0 |\n| datasetLinkName | String | The API name of the dataset link provided as an input for the decision table execution. | Optional | 58.0 |\n\nResponse body for POST\n\n[Decision Table Bulk Outcome](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_bulk_outcome.htm)\n\n# Decision Table Bulk Outcome\n\nOutput representation of the decision table bulk look-up.\n\n| Property Name | Type | Description | Filter Group and Version | Available Version |\n| --- | --- | --- | --- | --- |\n| outputs | [Decision Table Outcome](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_outcome.htm) | List of the output of the Decision Table bulk lookup. | Small, 58.0 | 58.0 |"
  },
  "response": [
    {
      "name": "Status404-NotFound",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"datasetLinkName\": \"transactionMapping\",\n    \"conditions\": [\n        {\n            \"conditionsList\": [\n                {\n                    \"fieldName\": \"Product__c\",\n                    \"value\": \"Nike\",\n                    \"operator\": \"Matches\" //Operator is optional\n                },\n                {\n                    \"fieldName\": \"Price__c\",\n                    \"value\": 1000,\n                    \"operator\": \"GreaterThan\"\n                }\n            ]\n        },\n        {\n            \"conditionsList\": [\n                {\n                    \"fieldName\": \"Product__c\",\n                    \"value\": \"Adidas\",\n                    \"operator\": \"Matches\" //Operator is optional\n                },\n                {\n                    \"fieldName\": \"Price__c\",\n                    \"value\": 1500,\n                    \"operator\": \"GreaterThan\"\n                }\n            ]\n        }\n    ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/lookup/:decisionTableId",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "decision-table",
            "lookup",
            ":decisionTableId"
          ],
          "variable": [
            {
              "key": "decisionTableId",
              "value": "0lDHo0000008Pnt",
              "description": "Decision Table Id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Tue, 19 Sep 2023 14:11:45 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-InvalidOperation",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"datasetLinkName\": \"transactionMapping\",\n    \"conditions\": [\n        {\n            \"conditionsList\": [\n                {\n                    \"fieldName\": \"Product__c\",\n                    \"value\": \"Nike\",\n                    \"operator\": \"Matches\" //Operator is optional\n                },\n                {\n                    \"fieldName\": \"Price__c\",\n                    \"value\": 1000,\n                    \"operator\": \"GreaterThan\"\n                }\n            ]\n        },\n        {\n            \"conditionsList\": [\n                {\n                    \"fieldName\": \"Product__c\",\n                    \"value\": \"Adidas\",\n                    \"operator\": \"Matches\" //Operator is optional\n                },\n                {\n                    \"fieldName\": \"Price__c\",\n                    \"value\": 1500,\n                    \"operator\": \"GreaterThan\"\n                }\n            ]\n        }\n    ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/lookup/:decisionTableId",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "decision-table",
            "lookup",
            ":decisionTableId"
          ],
          "variable": [
            {
              "key": "decisionTableId",
              "value": "0lDHo0000008Po3",
              "description": "Decision Table Id"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Tue, 19 Sep 2023 14:16:11 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_OPERATION\",\n        \"message\": \"Can't execute decision table which is not in Active state.\"\n    }\n]"
    },
    {
      "name": "Status201-Error",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"datasetLinkName\": \"transactionMapping\",\n    \"conditions\": [\n        {\n            \"conditionsList\": [\n                {\n                    \"fieldName\": \"Product__c\",\n                    \"value\": \"Nike\",\n                    \"operator\": \"Matches\" //Operator is optional\n                },\n                {\n                    \"fieldName\": \"Price__c\",\n                    \"value\": 1000,\n                    \"operator\": \"GreaterThan\"\n                }\n            ]\n        },\n        {\n            \"conditionsList\": [\n                {\n                    \"fieldName\": \"Product__c\",\n                    \"value\": \"Adidas\",\n                    \"operator\": \"Matches\" //Operator is optional\n                },\n                {\n                    \"fieldName\": \"Price__c\",\n                    \"value\": 1500,\n                    \"operator\": \"GreaterThan\"\n                }\n            ]\n        }\n    ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/lookup/:decisionTableId",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "decision-table",
            "lookup",
            ":decisionTableId"
          ],
          "variable": [
            {
              "key": "decisionTableId",
              "value": "0lDHo0000008Po3",
              "description": "Decision Table Id"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Tue, 19 Sep 2023 14:17:24 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            \"errorCode\": 400,\n            \"errorMessage\": \"Specify valid name for Data set Link\",\n            \"outcomeList\": [],\n            \"outcomeType\": null,\n            \"successStatus\": false\n        },\n        {\n            \"errorCode\": 400,\n            \"errorMessage\": \"Specify valid name for Data set Link\",\n            \"outcomeList\": [],\n            \"outcomeType\": null,\n            \"successStatus\": false\n        }\n    ]\n}"
    }
  ]
}