Back to Collection Items
IncludeFile "CkJsonArray.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkJsonObject.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
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://domain.com/services/data/v{{version}}/tabs",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jarrResp.i = CkJsonArray::ckCreate()
If jarrResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonArray::ckLoadSb(jarrResp,sbResponseBody)
CkJsonArray::setCkEmitCompact(jarrResp, 0)
Debug "Response Body:"
Debug CkJsonArray::ckEmit(jarrResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonArray::ckDispose(jarrResp)
ProcedureReturn
EndIf
; 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
json.i
custom.i
iconUrl.s
label.s
miniIconUrl.s
name.s
sobjectName.s
url.s
j.i
count_j.i
color.s
context.s
theme.s
contentType.s
height.i
width.i
i.i = 0
count_i.i = CkJsonArray::ckSize(jarrResp)
While i < count_i
json = CkJsonArray::ckObjectAt(jarrResp,i)
custom = CkJsonObject::ckBoolOf(json,"custom")
iconUrl = CkJsonObject::ckStringOf(json,"iconUrl")
label = CkJsonObject::ckStringOf(json,"label")
miniIconUrl = CkJsonObject::ckStringOf(json,"miniIconUrl")
name = CkJsonObject::ckStringOf(json,"name")
sobjectName = CkJsonObject::ckStringOf(json,"sobjectName")
url = CkJsonObject::ckStringOf(json,"url")
j = 0
count_j = CkJsonObject::ckSizeOfArray(json,"colors")
While j < count_j
CkJsonObject::setCkJ(json, j)
color = CkJsonObject::ckStringOf(json,"colors[j].color")
context = CkJsonObject::ckStringOf(json,"colors[j].context")
theme = CkJsonObject::ckStringOf(json,"colors[j].theme")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(json,"icons")
While j < count_j
CkJsonObject::setCkJ(json, j)
contentType = CkJsonObject::ckStringOf(json,"icons[j].contentType")
height = CkJsonObject::ckIntOf(json,"icons[j].height")
theme = CkJsonObject::ckStringOf(json,"icons[j].theme")
url = CkJsonObject::ckStringOf(json,"icons[j].url")
width = CkJsonObject::ckIntOf(json,"icons[j].width")
j = j + 1
Wend
CkJsonObject::ckDispose(json)
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonArray::ckDispose(jarrResp)
ProcedureReturn
EndProcedure
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]"
}
]
}
