Chilkat Online Tools

PureBasic / Salesforce Platform APIs / Invoke

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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"
    ;         }
    ;       ]
    ;     }
    ;   ]
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"datasetLinkName","transactionMapping")
    CkJsonObject::ckUpdateString(json,"conditions[0].conditionsList[0].fieldName","Product__c")
    CkJsonObject::ckUpdateString(json,"conditions[0].conditionsList[0].value","Nike")
    CkJsonObject::ckUpdateString(json,"conditions[0].conditionsList[0].operator","Matches")
    CkJsonObject::ckUpdateString(json,"conditions[0].conditionsList[1].fieldName","Price__c")
    CkJsonObject::ckUpdateInt(json,"conditions[0].conditionsList[1].value",1000)
    CkJsonObject::ckUpdateString(json,"conditions[0].conditionsList[1].operator","GreaterThan")
    CkJsonObject::ckUpdateString(json,"conditions[1].conditionsList[0].fieldName","Product__c")
    CkJsonObject::ckUpdateString(json,"conditions[1].conditionsList[0].value","Adidas")
    CkJsonObject::ckUpdateString(json,"conditions[1].conditionsList[0].operator","Matches")
    CkJsonObject::ckUpdateString(json,"conditions[1].conditionsList[1].fieldName","Price__c")
    CkJsonObject::ckUpdateInt(json,"conditions[1].conditionsList[1].value",1500)
    CkJsonObject::ckUpdateString(json,"conditions[1].conditionsList[1].operator","GreaterThan")

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/services/data/v{{version}}/connect/business-rules/decision-table/lookup/:decisionTableId","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(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

    errorCode.i
    errorMessage.s
    outcomeType.s
    successStatus.i
    j.i
    count_j.i

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"outputs")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        errorCode = CkJsonObject::ckIntOf(jResp,"outputs[i].errorCode")
        errorMessage = CkJsonObject::ckStringOf(jResp,"outputs[i].errorMessage")
        outcomeType = CkJsonObject::ckStringOf(jResp,"outputs[i].outcomeType")
        successStatus = CkJsonObject::ckBoolOf(jResp,"outputs[i].successStatus")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"outputs[i].outcomeList")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            j = j + 1
        Wend
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

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}"
    }
  ]
}