Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://domain.com/services/data/v{{version}}/ui-api/actions/list-view-chart/:SOBJECT_API_NAME', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
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
DECLARE @actionListContext nvarchar(4000)
DECLARE @actionTarget nvarchar(4000)
DECLARE @actionTargetType nvarchar(4000)
DECLARE @apiName nvarchar(4000)
DECLARE @externalId nvarchar(4000)
DECLARE @iconUrl nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @isMassAction nvarchar(4000)
DECLARE @label nvarchar(4000)
DECLARE @lwcComponent nvarchar(4000)
DECLARE @primaryColor nvarchar(4000)
DECLARE @relatedListRecordId nvarchar(4000)
DECLARE @relatedSourceObject nvarchar(4000)
DECLARE @section nvarchar(4000)
DECLARE @sourceObject nvarchar(4000)
DECLARE @subtype nvarchar(4000)
DECLARE @targetObject nvarchar(4000)
DECLARE @targetUrl nvarchar(4000)
DECLARE @v_type nvarchar(4000)
DECLARE @v_Url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'actions.ListViewChartInstance.url'
DECLARE @eTag nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @eTag OUT, 'eTag'
DECLARE @url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'url'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'actions.ListViewChartInstance.actions'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @actionListContext OUT, 'actions.ListViewChartInstance.actions[i].actionListContext'
EXEC sp_OAMethod @jResp, 'StringOf', @actionTarget OUT, 'actions.ListViewChartInstance.actions[i].actionTarget'
EXEC sp_OAMethod @jResp, 'StringOf', @actionTargetType OUT, 'actions.ListViewChartInstance.actions[i].actionTargetType'
EXEC sp_OAMethod @jResp, 'StringOf', @apiName OUT, 'actions.ListViewChartInstance.actions[i].apiName'
EXEC sp_OAMethod @jResp, 'StringOf', @externalId OUT, 'actions.ListViewChartInstance.actions[i].externalId'
EXEC sp_OAMethod @jResp, 'StringOf', @iconUrl OUT, 'actions.ListViewChartInstance.actions[i].iconUrl'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'actions.ListViewChartInstance.actions[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @isMassAction OUT, 'actions.ListViewChartInstance.actions[i].isMassAction'
EXEC sp_OAMethod @jResp, 'StringOf', @label OUT, 'actions.ListViewChartInstance.actions[i].label'
EXEC sp_OAMethod @jResp, 'StringOf', @lwcComponent OUT, 'actions.ListViewChartInstance.actions[i].lwcComponent'
EXEC sp_OAMethod @jResp, 'StringOf', @primaryColor OUT, 'actions.ListViewChartInstance.actions[i].primaryColor'
EXEC sp_OAMethod @jResp, 'StringOf', @relatedListRecordId OUT, 'actions.ListViewChartInstance.actions[i].relatedListRecordId'
EXEC sp_OAMethod @jResp, 'StringOf', @relatedSourceObject OUT, 'actions.ListViewChartInstance.actions[i].relatedSourceObject'
EXEC sp_OAMethod @jResp, 'StringOf', @section OUT, 'actions.ListViewChartInstance.actions[i].section'
EXEC sp_OAMethod @jResp, 'StringOf', @sourceObject OUT, 'actions.ListViewChartInstance.actions[i].sourceObject'
EXEC sp_OAMethod @jResp, 'StringOf', @subtype OUT, 'actions.ListViewChartInstance.actions[i].subtype'
EXEC sp_OAMethod @jResp, 'StringOf', @targetObject OUT, 'actions.ListViewChartInstance.actions[i].targetObject'
EXEC sp_OAMethod @jResp, 'StringOf', @targetUrl OUT, 'actions.ListViewChartInstance.actions[i].targetUrl'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'actions.ListViewChartInstance.actions[i].type'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'actions.ListViewChartInstance.links'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
