Chilkat Online Tools

Ruby / Salesforce Platform APIs / Tabs

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()

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/tabs",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jarrResp = Chilkat::CkJsonArray.new()
jarrResp.LoadSb(sbResponseBody)
jarrResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jarrResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

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

# [
#   {
#     "colors": [
#       {
#         "color": "5867E8",
#         "context": "primary",
#         "theme": "theme4"
#       },
#       {
#         "color": "236FBD",
#         "context": "primary",
#         "theme": "theme3"
#       }
#     ],
#     "custom": false,
#     "iconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts32.png",
#     "icons": [
#       {
#         "contentType": "image/png",
#         "height": 32,
#         "theme": "theme3",
#         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts32.png",
#         "width": 32
#       },
#       {
#         "contentType": "image/png",
#         "height": 16,
#         "theme": "theme3",
#         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts16.png",
#         "width": 16
#       },
#       {
#         "contentType": "image/svg+xml",
#         "height": 0,
#         "theme": "theme4",
#         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account.svg",
#         "width": 0
#       },
#       {
#         "contentType": "image/png",
#         "height": 60,
#         "theme": "theme4",
#         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_60.png",
#         "width": 60
#       },
#       {
#         "contentType": "image/png",
#         "height": 120,
#         "theme": "theme4",
#         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png",
#         "width": 120
#       }
#     ],
#     "label": "Accounts",
#     "miniIconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts16.png",
#     "name": "standard-Account",
#     "sobjectName": "Account",
#     "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/001/o"
#   },
#   {
#     "colors": [
#       {
#         "color": "056764",
#         "context": "primary",
#         "theme": "theme4"
#       },
#       {
#         "color": "056764",
#         "context": "primary",
#         "theme": "theme3"
#       }
#     ],
#     "custom": false,
#     "iconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench32.png",
#     "icons": [
#       {
#         "contentType": "image/png",
#         "height": 32,
#         "theme": "theme3",
#         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench32.png",
#         "width": 32
#       },
#       {
#         "contentType": "image/png",
#         "height": 16,
#         "theme": "theme3",
#         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench16.png",
#         "width": 16
#       }
#     ],
#     "label": "Active Scratch Orgs",
#     "miniIconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench16.png",
#     "name": "standard-ActiveScratchOrg",
#     "sobjectName": "ActiveScratchOrg",
#     "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/2AS/o"
#   },
#   {
#     "colors": [
#       {
#         "color": "06A59A",
#         "context": "primary",
#         "theme": "theme4"
#       },
#       {
#         "color": "A55647",
#         "context": "primary",
#         "theme": "theme3"
#       }
#     ],
#     "custom": false,
#     "iconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports32.png",
#     "icons": [
#       {
#         "contentType": "image/png",
#         "height": 32,
#         "theme": "theme3",
#         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports32.png",
#         "width": 32
#       },
#       {
#         "contentType": "image/png",
#         "height": 16,
#         "theme": "theme3",
#         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports16.png",
#         "width": 16
#       },
#       {
#         "contentType": "image/svg+xml",
#         "height": 0,
#         "theme": "theme4",
#         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report.svg",
#         "width": 0
#       },
#       {
#         "contentType": "image/png",
#         "height": 60,
#         "theme": "theme4",
#         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report_60.png",
#         "width": 60
#       },
#       {
#         "contentType": "image/png",
#         "height": 120,
#         "theme": "theme4",
#         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report_120.png",
#         "width": 120
#       }
#     ],
#     "label": "Reports",
#     "miniIconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports16.png",
#     "name": "standard-report",
#     "sobjectName": "Report",
#     "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/00O/o"
#   }
# ]

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

i = 0
count_i = jarrResp.get_Size()
while i < count_i
    # json is a CkJsonObject
    json = jarrResp.ObjectAt(i)
    custom = json.BoolOf("custom")
    iconUrl = json.stringOf("iconUrl")
    label = json.stringOf("label")
    miniIconUrl = json.stringOf("miniIconUrl")
    name = json.stringOf("name")
    sobjectName = json.stringOf("sobjectName")
    url = json.stringOf("url")
    j = 0
    count_j = json.SizeOfArray("colors")
    while j < count_j
        json.put_J(j)
        color = json.stringOf("colors[j].color")
        context = json.stringOf("colors[j].context")
        theme = json.stringOf("colors[j].theme")
        j = j + 1
    end
    j = 0
    count_j = json.SizeOfArray("icons")
    while j < count_j
        json.put_J(j)
        contentType = json.stringOf("icons[j].contentType")
        height = json.IntOf("icons[j].height")
        theme = json.stringOf("icons[j].theme")
        url = json.stringOf("icons[j].url")
        width = json.IntOf("icons[j].width")
        j = j + 1
    end

    i = i + 1
end

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/tabs

Postman Collection Item JSON

{
  "name": "Tabs",
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": ""
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/tabs",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "tabs"
      ]
    },
    "description": "f a survey field can be translated or is already translated into a particular language, you can add or change the translated value of the survey field.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/request_survey_translate_add_change.htm"
  },
  "response": [
    {
      "name": "Tabs",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": ""
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/tabs",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "tabs"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 27 Sep 2023 15:29:05 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=6/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        \"colors\": [\n            {\n                \"color\": \"5867E8\",\n                \"context\": \"primary\",\n                \"theme\": \"theme4\"\n            },\n            {\n                \"color\": \"236FBD\",\n                \"context\": \"primary\",\n                \"theme\": \"theme3\"\n            }\n        ],\n        \"custom\": false,\n        \"iconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts32.png\",\n        \"icons\": [\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 32,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts32.png\",\n                \"width\": 32\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 16,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts16.png\",\n                \"width\": 16\n            },\n            {\n                \"contentType\": \"image/svg+xml\",\n                \"height\": 0,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account.svg\",\n                \"width\": 0\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 60,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_60.png\",\n                \"width\": 60\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 120,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png\",\n                \"width\": 120\n            }\n        ],\n        \"label\": \"Accounts\",\n        \"miniIconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts16.png\",\n        \"name\": \"standard-Account\",\n        \"sobjectName\": \"Account\",\n        \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/001/o\"\n    },\n    {\n        \"colors\": [\n            {\n                \"color\": \"056764\",\n                \"context\": \"primary\",\n                \"theme\": \"theme4\"\n            },\n            {\n                \"color\": \"056764\",\n                \"context\": \"primary\",\n                \"theme\": \"theme3\"\n            }\n        ],\n        \"custom\": false,\n        \"iconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench32.png\",\n        \"icons\": [\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 32,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench32.png\",\n                \"width\": 32\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 16,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench16.png\",\n                \"width\": 16\n            }\n        ],\n        \"label\": \"Active Scratch Orgs\",\n        \"miniIconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench16.png\",\n        \"name\": \"standard-ActiveScratchOrg\",\n        \"sobjectName\": \"ActiveScratchOrg\",\n        \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/2AS/o\"\n    },\n    {\n        \"colors\": [\n            {\n                \"color\": \"06A59A\",\n                \"context\": \"primary\",\n                \"theme\": \"theme4\"\n            },\n            {\n                \"color\": \"A55647\",\n                \"context\": \"primary\",\n                \"theme\": \"theme3\"\n            }\n        ],\n        \"custom\": false,\n        \"iconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports32.png\",\n        \"icons\": [\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 32,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports32.png\",\n                \"width\": 32\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 16,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports16.png\",\n                \"width\": 16\n            },\n            {\n                \"contentType\": \"image/svg+xml\",\n                \"height\": 0,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report.svg\",\n                \"width\": 0\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 60,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report_60.png\",\n                \"width\": 60\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 120,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report_120.png\",\n                \"width\": 120\n            }\n        ],\n        \"label\": \"Reports\",\n        \"miniIconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports16.png\",\n        \"name\": \"standard-report\",\n        \"sobjectName\": \"Report\",\n        \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/00O/o\"\n    }\n]"
    }
  ]
}