Chilkat Online Tools

Ruby / Salesforce Platform APIs / Get 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.

# {
#   "setupName": "Product Qualificiation eligibility",
#   "fullName": "ProductQualificationEligibility",
#   "description": "Eligiblity of Products using Qualification Rules",
#   "sourceObject": "AccountFeed",
#   "status": "Draft",
#   "conditionType": "Any",
#   "conditionCriteria": "1 OR 2 OR 3",
#   "parameters": [
#     {
#       "fieldName": "IsDeleted",
#       "usage": "INPUT",
#       "operator": "Equals",
#       "sequence": "1"
#     },
#     {
#       "fieldName": "Id",
#       "usage": "INPUT",
#       "operator": "Equals",
#       "sequence": "2"
#     },
#     {
#       "fieldName": "Title",
#       "usage": "INPUT",
#       "operator": "Equals",
#       "sequence": "3"
#     },
#     {
#       "fieldName": "CreatedById",
#       "usage": "OUTPUT"
#     }
#   ]
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("setupName","Product Qualificiation eligibility")
json.UpdateString("fullName","ProductQualificationEligibility")
json.UpdateString("description","Eligiblity of Products using Qualification Rules")
json.UpdateString("sourceObject","AccountFeed")
json.UpdateString("status","Draft")
json.UpdateString("conditionType","Any")
json.UpdateString("conditionCriteria","1 OR 2 OR 3")
json.UpdateString("parameters[0].fieldName","IsDeleted")
json.UpdateString("parameters[0].usage","INPUT")
json.UpdateString("parameters[0].operator","Equals")
json.UpdateString("parameters[0].sequence","1")
json.UpdateString("parameters[1].fieldName","Id")
json.UpdateString("parameters[1].usage","INPUT")
json.UpdateString("parameters[1].operator","Equals")
json.UpdateString("parameters[1].sequence","2")
json.UpdateString("parameters[2].fieldName","Title")
json.UpdateString("parameters[2].usage","INPUT")
json.UpdateString("parameters[2].operator","Equals")
json.UpdateString("parameters[2].sequence","3")
json.UpdateString("parameters[3].fieldName","CreatedById")
json.UpdateString("parameters[3].usage","OUTPUT")

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

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("GET","https://domain.com/services/data/v{{version}}/connect/business-rules/decision-table/definitions/:decisionTableId",sbRequestBody,"utf-8","application/json",false,false)
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)

# {
#   "code": "200",
#   "decisionTable": {
#     "conditionCriteria": "1 OR 2 OR 3",
#     "conditionType": "Any",
#     "description": "Eligiblity of Products using Qualification Rules",
#     "id": "0lDHo0000008Pnt",
#     "parameters": [
#       {
#         "fieldName": "IsDeleted",
#         "isGroupByField": false,
#         "operator": "Equals",
#         "sequence": 1,
#         "usage": "Input"
#       },
#       {
#         "fieldName": "CreatedById",
#         "isGroupByField": false,
#         "usage": "Output"
#       },
#       {
#         "fieldName": "Title",
#         "isGroupByField": false,
#         "operator": "Equals",
#         "sequence": 3,
#         "usage": "Input"
#       },
#       {
#         "fieldName": "Id",
#         "isGroupByField": false,
#         "operator": "Equals",
#         "sequence": 2,
#         "usage": "Input"
#       }
#     ],
#     "setupName": "Product Qualificiation eligibility",
#     "sourceCriteria": [
#     ],
#     "sourceObject": "AccountFeed",
#     "status": "Active"
#   },
#   "isSuccess": true,
#   "message": ""
# }

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

code = jResp.stringOf("code")
ConditionCriteria = jResp.stringOf("decisionTable.conditionCriteria")
ConditionType = jResp.stringOf("decisionTable.conditionType")
Description = jResp.stringOf("decisionTable.description")
Id = jResp.stringOf("decisionTable.id")
SetupName = jResp.stringOf("decisionTable.setupName")
SourceObject = jResp.stringOf("decisionTable.sourceObject")
Status = jResp.stringOf("decisionTable.status")
isSuccess = jResp.BoolOf("isSuccess")
message = jResp.stringOf("message")
i = 0
count_i = jResp.SizeOfArray("decisionTable.parameters")
while i < count_i
    jResp.put_I(i)
    fieldName = jResp.stringOf("decisionTable.parameters[i].fieldName")
    isGroupByField = jResp.BoolOf("decisionTable.parameters[i].isGroupByField")
    operator = jResp.stringOf("decisionTable.parameters[i].operator")
    sequence = jResp.IntOf("decisionTable.parameters[i].sequence")
    usage = jResp.stringOf("decisionTable.parameters[i].usage")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("decisionTable.sourceCriteria")
while i < count_i
    jResp.put_I(i)
    i = i + 1
end

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-d '{
   "setupName":"Product Qualificiation eligibility",
   "fullName":"ProductQualificationEligibility",
   "description":"Eligiblity of Products using Qualification Rules",
   "sourceObject":"AccountFeed",
   "status":"Draft",
   "conditionType":"Any",
   "conditionCriteria":"1 OR 2 OR 3",
   "parameters":[
      {
         "fieldName":"IsDeleted",
         "usage":"INPUT",
         "operator":"Equals",
         "sequence":"1"
      },
      {
         "fieldName":"Id",
         "usage":"INPUT",
         "operator":"Equals",
         "sequence":"2"
      },
      {
         "fieldName":"Title",
         "usage":"INPUT",
         "operator":"Equals",
         "sequence":"3"
      },
      {
         "fieldName":"CreatedById",
         "usage":"OUTPUT"
      }
   ]
}'
https://domain.com/services/data/v{{version}}/connect/business-rules/decision-table/definitions/:decisionTableId

Postman Collection Item JSON

{
  "name": "Get Table",
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n   \"setupName\":\"Product Qualificiation eligibility\",\n   \"fullName\":\"ProductQualificationEligibility\",\n   \"description\":\"Eligiblity of Products using Qualification Rules\",\n   \"sourceObject\":\"AccountFeed\",\n   \"status\":\"Draft\",\n   \"conditionType\":\"Any\",\n   \"conditionCriteria\":\"1 OR 2 OR 3\",\n   \"parameters\":[\n      {\n         \"fieldName\":\"IsDeleted\",\n         \"usage\":\"INPUT\",\n         \"operator\":\"Equals\",\n         \"sequence\":\"1\"\n      },\n      {\n         \"fieldName\":\"Id\",\n         \"usage\":\"INPUT\",\n         \"operator\":\"Equals\",\n         \"sequence\":\"2\"\n      },\n      {\n         \"fieldName\":\"Title\",\n         \"usage\":\"INPUT\",\n         \"operator\":\"Equals\",\n         \"sequence\":\"3\"\n      },\n      {\n         \"fieldName\":\"CreatedById\",\n         \"usage\":\"OUTPUT\"\n      }\n   ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/definitions/:decisionTableId",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "connect",
        "business-rules",
        "decision-table",
        "definitions",
        ":decisionTableId"
      ],
      "variable": [
        {
          "key": "decisionTableId",
          "value": "0lDHo0000008Po3",
          "description": "Decision Table Id"
        }
      ]
    },
    "description": "# Decision Table Definitions ( GET)\n\nGet details of a decision table definition.\n\nResource\n\n```\n/connect/business-rules/decision-table/definitions/${decisionTableId}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect/business-rules/decision-table/definitions/0lDxx00000002Ur\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nGET\n\nResponse body for GET\n\n[Decision Table Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_output.htm)\n\n# Decision Table Output\n\nOutput representation of the decision table details.JSON example for GET, POST, and PATCH\n\n```\n{\n   \"code\":\"200\",\n   \"decisionTable\":{\n      \"collectOperator\":\"Count\",\n      \"conditionCriteria\":\"1 OR 2 OR 3\",\n      \"conditionType\":\"Any\",\n      \"decisionResultPolicy\":\"UniqueValues\",\n      \"description\":\"Eligiblity of Products using Qualification Rules\",\n      \"id\":\"0lDxx00000000BJ\",\n      \"parameters\":[\n         {\n            \"fieldName\":\"IsDeleted\",\n            \"isGroupByField\":false,\n            \"isPriority\":false,\n            \"operator\":\"Equals\",\n            \"sequence\":1,\n            \"usage\":\"Input\"\n         },\n         {\n            \"fieldName\":\"CreatedById\",\n            \"isGroupByField\":false,\n            \"isPriority\":false,\n            \"usage\":\"Output\"\n         },\n         {\n            \"fieldName\":\"Title\",\n            \"isGroupByField\":false,\n            \"isPriority\":false,\n            \"operator\":\"Equals\",\n            \"sequence\":3,\n            \"usage\":\"Input\"\n         },\n         {\n            \"fieldName\":\"Id\",\n            \"isGroupByField\":false,\n            \"isPriority\":false,\n            \"operator\":\"Equals\",\n            \"sequence\":2,\n            \"usage\":\"Input\"\n         }\n      ],\n      \"setupName\":\"Product Qualificiation eligibility3\",\n      \"sourceCriteria\":[\n         \n      ],\n      \"sourceObject\":\"AccountFeed\",\n      \"sourceType\":\"SingleSobject\",\n      \"sourceconditionLogic\":\"1 AND 2 AND 3\",\n      \"status\":\"Draft\"\n   },\n   \"isSuccess\":true,\n   \"message\":\"\"\n}\n\n ```\n\nJSON example for DELETE\n\n```\n{\n   \"code\":\"200\",\n   \"isSuccess\":true,\n   \"message\":\"\"\n}\n\n ```\n\n| Property Name | Type | Description | Filter Group and Version | Available Version |\n| --- | --- | --- | --- | --- |\n| code | String | Response code from the API request. | Small, 58.0 | 58.0 |\n| decisionTable | [Decision Table Definition Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_definition_output.htm) | Details of the decision table definition associated with the decision table. | Small, 58.0 | 58.0 |\n| isSuccess | Boolean | Indicates whether the API request is successful (true) or not (false). | Small, 58.0 | 58.0 |\n| message | String | Error message when the API request fails. | Small, 58.0 | 58.0 |"
  },
  "response": [
    {
      "name": "Status200-Success",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n   \"setupName\":\"Product Qualificiation eligibility\",\n   \"fullName\":\"ProductQualificationEligibility\",\n   \"description\":\"Eligiblity of Products using Qualification Rules\",\n   \"sourceObject\":\"AccountFeed\",\n   \"status\":\"Draft\",\n   \"conditionType\":\"Any\",\n   \"conditionCriteria\":\"1 OR 2 OR 3\",\n   \"parameters\":[\n      {\n         \"fieldName\":\"IsDeleted\",\n         \"usage\":\"INPUT\",\n         \"operator\":\"Equals\",\n         \"sequence\":\"1\"\n      },\n      {\n         \"fieldName\":\"Id\",\n         \"usage\":\"INPUT\",\n         \"operator\":\"Equals\",\n         \"sequence\":\"2\"\n      },\n      {\n         \"fieldName\":\"Title\",\n         \"usage\":\"INPUT\",\n         \"operator\":\"Equals\",\n         \"sequence\":\"3\"\n      },\n      {\n         \"fieldName\":\"CreatedById\",\n         \"usage\":\"OUTPUT\"\n      }\n   ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/definitions/:decisionTableId",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "decision-table",
            "definitions",
            ":decisionTableId"
          ],
          "variable": [
            {
              "key": "decisionTableId",
              "value": "0lDHo0000008Pnt",
              "description": "Decision Table Id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Tue, 19 Sep 2023 13:05: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    \"code\": \"200\",\n    \"decisionTable\": {\n        \"conditionCriteria\": \"1 OR 2 OR 3\",\n        \"conditionType\": \"Any\",\n        \"description\": \"Eligiblity of Products using Qualification Rules\",\n        \"id\": \"0lDHo0000008Pnt\",\n        \"parameters\": [\n            {\n                \"fieldName\": \"IsDeleted\",\n                \"isGroupByField\": false,\n                \"operator\": \"Equals\",\n                \"sequence\": 1,\n                \"usage\": \"Input\"\n            },\n            {\n                \"fieldName\": \"CreatedById\",\n                \"isGroupByField\": false,\n                \"usage\": \"Output\"\n            },\n            {\n                \"fieldName\": \"Title\",\n                \"isGroupByField\": false,\n                \"operator\": \"Equals\",\n                \"sequence\": 3,\n                \"usage\": \"Input\"\n            },\n            {\n                \"fieldName\": \"Id\",\n                \"isGroupByField\": false,\n                \"operator\": \"Equals\",\n                \"sequence\": 2,\n                \"usage\": \"Input\"\n            }\n        ],\n        \"setupName\": \"Product Qualificiation eligibility\",\n        \"sourceCriteria\": [],\n        \"sourceObject\": \"AccountFeed\",\n        \"status\": \"Active\"\n    },\n    \"isSuccess\": true,\n    \"message\": \"\"\n}"
    },
    {
      "name": "Status400-InstanceNotFound",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n   \"setupName\":\"Product Qualificiation eligibility\",\n   \"fullName\":\"ProductQualificationEligibility\",\n   \"description\":\"Eligiblity of Products using Qualification Rules\",\n   \"sourceObject\":\"AccountFeed\",\n   \"status\":\"Draft\",\n   \"conditionType\":\"Any\",\n   \"conditionCriteria\":\"1 OR 2 OR 3\",\n   \"parameters\":[\n      {\n         \"fieldName\":\"IsDeleted\",\n         \"usage\":\"INPUT\",\n         \"operator\":\"Equals\",\n         \"sequence\":\"1\"\n      },\n      {\n         \"fieldName\":\"Id\",\n         \"usage\":\"INPUT\",\n         \"operator\":\"Equals\",\n         \"sequence\":\"2\"\n      },\n      {\n         \"fieldName\":\"Title\",\n         \"usage\":\"INPUT\",\n         \"operator\":\"Equals\",\n         \"sequence\":\"3\"\n      },\n      {\n         \"fieldName\":\"CreatedById\",\n         \"usage\":\"OUTPUT\"\n      }\n   ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/definitions/:decisionTableId",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "decision-table",
            "definitions",
            ":decisionTableId"
          ],
          "variable": [
            {
              "key": "decisionTableId",
              "value": "0lDHo0000008Pnn",
              "description": "Decision Table Id"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Tue, 19 Sep 2023 13:20:33 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_ID_FIELD\",\n        \"message\": \"We couldn’t find a record with that ID. Specify a valid decisionTableId and try again.\"\n    }\n]"
    },
    {
      "name": "Status200-Success",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n   \"setupName\":\"Product Qualificiation eligibility\",\n   \"fullName\":\"ProductQualificationEligibility\",\n   \"description\":\"Eligiblity of Products using Qualification Rules\",\n   \"sourceObject\":\"AccountFeed\",\n   \"status\":\"Draft\",\n   \"conditionType\":\"Any\",\n   \"conditionCriteria\":\"1 OR 2 OR 3\",\n   \"parameters\":[\n      {\n         \"fieldName\":\"IsDeleted\",\n         \"usage\":\"INPUT\",\n         \"operator\":\"Equals\",\n         \"sequence\":\"1\"\n      },\n      {\n         \"fieldName\":\"Id\",\n         \"usage\":\"INPUT\",\n         \"operator\":\"Equals\",\n         \"sequence\":\"2\"\n      },\n      {\n         \"fieldName\":\"Title\",\n         \"usage\":\"INPUT\",\n         \"operator\":\"Equals\",\n         \"sequence\":\"3\"\n      },\n      {\n         \"fieldName\":\"CreatedById\",\n         \"usage\":\"OUTPUT\"\n      }\n   ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/definitions/:decisionTableId",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "business-rules",
            "decision-table",
            "definitions",
            ":decisionTableId"
          ],
          "variable": [
            {
              "key": "decisionTableId",
              "value": "0lDHo0000008Po3",
              "description": "Decision Table Id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Tue, 19 Sep 2023 14:13:01 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    \"code\": \"200\",\n    \"decisionTable\": {\n        \"conditionCriteria\": \"1 OR 2 OR 3\",\n        \"conditionType\": \"Any\",\n        \"description\": \"Eligiblity of Products using Qualification Rules\",\n        \"id\": \"0lDHo0000008Po3\",\n        \"parameters\": [\n            {\n                \"fieldName\": \"IsDeleted\",\n                \"isGroupByField\": false,\n                \"operator\": \"Equals\",\n                \"sequence\": 1,\n                \"usage\": \"Input\"\n            },\n            {\n                \"fieldName\": \"CreatedById\",\n                \"isGroupByField\": false,\n                \"usage\": \"Output\"\n            },\n            {\n                \"fieldName\": \"Title\",\n                \"isGroupByField\": false,\n                \"operator\": \"Equals\",\n                \"sequence\": 3,\n                \"usage\": \"Input\"\n            },\n            {\n                \"fieldName\": \"Id\",\n                \"isGroupByField\": false,\n                \"operator\": \"Equals\",\n                \"sequence\": 2,\n                \"usage\": \"Input\"\n            }\n        ],\n        \"setupName\": \"Product Qualificiation eligibility\",\n        \"sourceCriteria\": [],\n        \"sourceObject\": \"AccountFeed\",\n        \"status\": \"Draft\"\n    },\n    \"isSuccess\": true,\n    \"message\": \"\"\n}"
    }
  ]
}