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
DECLARE @iTmp0 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
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "name": "Favorite Name",
-- "sortOrder": 1,
-- "target": "API Name or ID",
-- "targetType": "ListView | ObjectHome | Record | Tab"
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'name', 'Favorite Name'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'sortOrder', 1
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'target', 'API Name or ID'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'targetType', 'ListView | ObjectHome | Record | Tab'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/services/data/v{{version}}/ui-api/favorites', 'application/json', @json
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
RETURN
END
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 @resp, 'GetBodySb', @success OUT, @sbResponseBody
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 @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "accessCount": 1,
-- "iconColor": "5867E8",
-- "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png",
-- "id": "0MV4H0000004qIeWAI",
-- "lastAccessDate": "2023-10-06T10:03:32.000Z",
-- "name": "AllAccountsListView",
-- "objectType": "Account",
-- "sortOrder": 1,
-- "subtitle": "Accounts",
-- "target": "00B58000002ssinEAA",
-- "targetType": "ListView"
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @accessCount int
EXEC sp_OAMethod @jResp, 'IntOf', @accessCount OUT, 'accessCount'
DECLARE @iconColor nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @iconColor OUT, 'iconColor'
DECLARE @iconUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @iconUrl OUT, 'iconUrl'
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @lastAccessDate nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @lastAccessDate OUT, 'lastAccessDate'
DECLARE @name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'name'
DECLARE @objectType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @objectType OUT, 'objectType'
DECLARE @sortOrder int
EXEC sp_OAMethod @jResp, 'IntOf', @sortOrder OUT, 'sortOrder'
DECLARE @subtitle nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @subtitle OUT, 'subtitle'
DECLARE @target nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @target OUT, 'target'
DECLARE @targetType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @targetType OUT, 'targetType'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"name": "Favorite Name",
"sortOrder": 1,
"target": "API Name or ID",
"targetType": "ListView | ObjectHome | Record | Tab"
}'
https://domain.com/services/data/v{{version}}/ui-api/favorites
Postman Collection Item JSON
{
"name": "Create a Favorite",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Favorite Name\",\n \"sortOrder\": 1,\n \"target\": \"API Name or ID\",\n \"targetType\": \"ListView | ObjectHome | Record | Tab\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/favorites",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"favorites"
]
},
"description": "Create a Favorite"
},
"response": [
{
"name": "Create a Favorite list view",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"AllAccountsListView\",\n \"sortOrder\": 1,\n \"target\": \"00B58000002ssinEAA\",\n \"targetType\": \"ListView\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/favorites",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"favorites"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Fri, 06 Oct 2023 10:03:31 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": "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 \"accessCount\": 1,\n \"iconColor\": \"5867E8\",\n \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png\",\n \"id\": \"0MV4H0000004qIeWAI\",\n \"lastAccessDate\": \"2023-10-06T10:03:32.000Z\",\n \"name\": \"AllAccountsListView\",\n \"objectType\": \"Account\",\n \"sortOrder\": 1,\n \"subtitle\": \"Accounts\",\n \"target\": \"00B58000002ssinEAA\",\n \"targetType\": \"ListView\"\n}"
}
]
}
