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>")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/actions/list-view-chart/:SOBJECT_API_NAME",sbResponseBody)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.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)
# {
# "actions": {
# "ListViewChartInstance": {
# "actions": [
# {
# "actionListContext": "ObjectHomeChart",
# "actionTarget": null,
# "actionTargetType": null,
# "apiName": "NewObjectHomeChartAction",
# "externalId": "00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:NewObjectHomeChartAction",
# "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png",
# "id": "0JV4H0000138090WAA",
# "isMassAction": "false",
# "label": "New Chart",
# "lwcComponent": null,
# "primaryColor": null,
# "relatedListRecordId": null,
# "relatedSourceObject": null,
# "section": "Page",
# "sourceObject": "ListViewChartInstance",
# "subtype": null,
# "targetObject": "ListViewChart",
# "targetUrl": null,
# "type": "StandardButton"
# },
# {
# "actionListContext": "ObjectHomeChart",
# "actionTarget": null,
# "actionTargetType": null,
# "apiName": "EditObjectHomeChartAction",
# "externalId": "00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:EditObjectHomeChartAction",
# "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png",
# "id": "0JV4H0000138091WAA",
# "isMassAction": "false",
# "label": "Edit Chart",
# "lwcComponent": null,
# "primaryColor": null,
# "relatedListRecordId": null,
# "relatedSourceObject": null,
# "section": "Page",
# "sourceObject": "ListViewChartInstance",
# "subtype": null,
# "targetObject": "ListViewChart",
# "targetUrl": null,
# "type": "StandardButton"
# },
# {
# "actionListContext": "ObjectHomeChart",
# "actionTarget": null,
# "actionTargetType": null,
# "apiName": "DeleteObjectHomeChartAction",
# "externalId": "00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:DeleteObjectHomeChartAction",
# "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png",
# "id": "0JV4H0000138092WAA",
# "isMassAction": "false",
# "label": "Delete Chart",
# "lwcComponent": null,
# "primaryColor": null,
# "relatedListRecordId": null,
# "relatedSourceObject": null,
# "section": "Page",
# "sourceObject": "ListViewChartInstance",
# "subtype": null,
# "targetObject": "ListViewChart",
# "targetUrl": null,
# "type": "StandardButton"
# }
# ],
# "links": [
# ],
# "url": "/services/data/v58.0/ui-api/actions/list-view-chart/ListViewChartInstance"
# }
# },
# "eTag": "60c273c4ba34efcc645bd0ce249c8cd4",
# "url": "/services/data/v58.0/ui-api/actions/list-view-chart/ListViewChartInstance"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
v_Url = jResp.stringOf("actions.ListViewChartInstance.url")
eTag = jResp.stringOf("eTag")
url = jResp.stringOf("url")
i = 0
count_i = jResp.SizeOfArray("actions.ListViewChartInstance.actions")
while i < count_i
jResp.put_I(i)
actionListContext = jResp.stringOf("actions.ListViewChartInstance.actions[i].actionListContext")
actionTarget = jResp.stringOf("actions.ListViewChartInstance.actions[i].actionTarget")
actionTargetType = jResp.stringOf("actions.ListViewChartInstance.actions[i].actionTargetType")
apiName = jResp.stringOf("actions.ListViewChartInstance.actions[i].apiName")
externalId = jResp.stringOf("actions.ListViewChartInstance.actions[i].externalId")
iconUrl = jResp.stringOf("actions.ListViewChartInstance.actions[i].iconUrl")
id = jResp.stringOf("actions.ListViewChartInstance.actions[i].id")
isMassAction = jResp.stringOf("actions.ListViewChartInstance.actions[i].isMassAction")
label = jResp.stringOf("actions.ListViewChartInstance.actions[i].label")
lwcComponent = jResp.stringOf("actions.ListViewChartInstance.actions[i].lwcComponent")
primaryColor = jResp.stringOf("actions.ListViewChartInstance.actions[i].primaryColor")
relatedListRecordId = jResp.stringOf("actions.ListViewChartInstance.actions[i].relatedListRecordId")
relatedSourceObject = jResp.stringOf("actions.ListViewChartInstance.actions[i].relatedSourceObject")
section = jResp.stringOf("actions.ListViewChartInstance.actions[i].section")
sourceObject = jResp.stringOf("actions.ListViewChartInstance.actions[i].sourceObject")
subtype = jResp.stringOf("actions.ListViewChartInstance.actions[i].subtype")
targetObject = jResp.stringOf("actions.ListViewChartInstance.actions[i].targetObject")
targetUrl = jResp.stringOf("actions.ListViewChartInstance.actions[i].targetUrl")
v_type = jResp.stringOf("actions.ListViewChartInstance.actions[i].type")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("actions.ListViewChartInstance.links")
while i < count_i
jResp.put_I(i)
i = i + 1
end
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/ui-api/actions/list-view-chart/:SOBJECT_API_NAME
Postman Collection Item JSON
{
"name": "Get List View Chart Actions",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/actions/list-view-chart/:SOBJECT_API_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"actions",
"list-view-chart",
":SOBJECT_API_NAME"
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": "ListViewChartInstance",
"description": "Currently, only `ListViewChartInstance` is valid."
}
]
},
"description": "Get the record actions on list views."
},
"response": [
{
"name": "Get List View Chart Actions",
"originalRequest": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/actions/list-view-chart/:SOBJECT_API_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"actions",
"list-view-chart",
":SOBJECT_API_NAME"
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": "ListViewChartInstance",
"description": "Currently, only `ListViewChartInstance` is valid."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Fri, 06 Oct 2023 11:41:26 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "ETag",
"value": "\"60c273c4ba34efcc645bd0ce249c8cd4--gzip\""
},
{
"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 \"actions\": {\n \"ListViewChartInstance\": {\n \"actions\": [\n {\n \"actionListContext\": \"ObjectHomeChart\",\n \"actionTarget\": null,\n \"actionTargetType\": null,\n \"apiName\": \"NewObjectHomeChartAction\",\n \"externalId\": \"00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:NewObjectHomeChartAction\",\n \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png\",\n \"id\": \"0JV4H0000138090WAA\",\n \"isMassAction\": \"false\",\n \"label\": \"New Chart\",\n \"lwcComponent\": null,\n \"primaryColor\": null,\n \"relatedListRecordId\": null,\n \"relatedSourceObject\": null,\n \"section\": \"Page\",\n \"sourceObject\": \"ListViewChartInstance\",\n \"subtype\": null,\n \"targetObject\": \"ListViewChart\",\n \"targetUrl\": null,\n \"type\": \"StandardButton\"\n },\n {\n \"actionListContext\": \"ObjectHomeChart\",\n \"actionTarget\": null,\n \"actionTargetType\": null,\n \"apiName\": \"EditObjectHomeChartAction\",\n \"externalId\": \"00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:EditObjectHomeChartAction\",\n \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png\",\n \"id\": \"0JV4H0000138091WAA\",\n \"isMassAction\": \"false\",\n \"label\": \"Edit Chart\",\n \"lwcComponent\": null,\n \"primaryColor\": null,\n \"relatedListRecordId\": null,\n \"relatedSourceObject\": null,\n \"section\": \"Page\",\n \"sourceObject\": \"ListViewChartInstance\",\n \"subtype\": null,\n \"targetObject\": \"ListViewChart\",\n \"targetUrl\": null,\n \"type\": \"StandardButton\"\n },\n {\n \"actionListContext\": \"ObjectHomeChart\",\n \"actionTarget\": null,\n \"actionTargetType\": null,\n \"apiName\": \"DeleteObjectHomeChartAction\",\n \"externalId\": \"00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:DeleteObjectHomeChartAction\",\n \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png\",\n \"id\": \"0JV4H0000138092WAA\",\n \"isMassAction\": \"false\",\n \"label\": \"Delete Chart\",\n \"lwcComponent\": null,\n \"primaryColor\": null,\n \"relatedListRecordId\": null,\n \"relatedSourceObject\": null,\n \"section\": \"Page\",\n \"sourceObject\": \"ListViewChartInstance\",\n \"subtype\": null,\n \"targetObject\": \"ListViewChart\",\n \"targetUrl\": null,\n \"type\": \"StandardButton\"\n }\n ],\n \"links\": [],\n \"url\": \"/services/data/v58.0/ui-api/actions/list-view-chart/ListViewChartInstance\"\n }\n },\n \"eTag\": \"60c273c4ba34efcc645bd0ce249c8cd4\",\n \"url\": \"/services/data/v58.0/ui-api/actions/list-view-chart/ListViewChartInstance\"\n}"
}
]
}
