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}}/connect/files/:FILE_ID/file-shares', @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)
-- {
-- "currentPageUrl": "/services/data/v58.0/connect/files/069.../file-shares",
-- "linkShare": null,
-- "nextPageUrl": null,
-- "previousPageUrl": null,
-- "shares": [
-- {
-- "entity": {
-- "additionalLabel": null,
-- "communityNickname": "User1696423780773910041",
-- "companyName": "Salesforce",
-- "displayName": "Name",
-- "firstName": "firstName",
-- "id": "005...",
-- "isActive": true,
-- "isInThisCommunity": true,
-- "lastName": "Name",
-- "motif": {
-- "color": "1B96FF",
-- "largeIconUrl": "/img/icon/profile64.png",
-- "mediumIconUrl": "/img/icon/profile32.png",
-- "smallIconUrl": "/img/icon/profile16.png",
-- "svgIconUrl": null
-- },
-- "mySubscription": null,
-- "name": "Name",
-- "outOfOffice": {
-- "message": ""
-- },
-- "photo": {
-- "fullEmailPhotoUrl": "https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1",
-- "largePhotoUrl": "https://<my_domain>/profilephoto/7292o000000oAgZ/F",
-- "mediumPhotoUrl": "https://<my_domain>/profilephoto/7292o000000oAgZ/M",
-- "photoVersionId": "729...",
-- "smallPhotoUrl": "https://<my_domain>/profilephoto/7292o000000oAgZ/T",
-- "standardEmailPhotoUrl": "https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1",
-- "url": "/services/data/v58.0/connect/user-profiles/005.../photo"
-- },
-- "reputation": null,
-- "title": null,
-- "type": "User",
-- "url": "/services/data/v58.0/chatter/users/005...",
-- "userType": "Internal"
-- },
-- "sharingType": "I"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @AdditionalLabel nvarchar(4000)
DECLARE @CommunityNickname nvarchar(4000)
DECLARE @CompanyName nvarchar(4000)
DECLARE @DisplayName nvarchar(4000)
DECLARE @FirstName nvarchar(4000)
DECLARE @Id nvarchar(4000)
DECLARE @IsActive int
DECLARE @IsInThisCommunity int
DECLARE @LastName nvarchar(4000)
DECLARE @Color nvarchar(4000)
DECLARE @LargeIconUrl nvarchar(4000)
DECLARE @MediumIconUrl nvarchar(4000)
DECLARE @SmallIconUrl nvarchar(4000)
DECLARE @SvgIconUrl nvarchar(4000)
DECLARE @MySubscription nvarchar(4000)
DECLARE @Name nvarchar(4000)
DECLARE @Message nvarchar(4000)
DECLARE @FullEmailPhotoUrl nvarchar(4000)
DECLARE @LargePhotoUrl nvarchar(4000)
DECLARE @MediumPhotoUrl nvarchar(4000)
DECLARE @PhotoVersionId nvarchar(4000)
DECLARE @SmallPhotoUrl nvarchar(4000)
DECLARE @StandardEmailPhotoUrl nvarchar(4000)
DECLARE @v_Url nvarchar(4000)
DECLARE @Reputation nvarchar(4000)
DECLARE @Title nvarchar(4000)
DECLARE @v_Type nvarchar(4000)
DECLARE @entityUrl nvarchar(4000)
DECLARE @UserType nvarchar(4000)
DECLARE @sharingType nvarchar(4000)
DECLARE @currentPageUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @currentPageUrl OUT, 'currentPageUrl'
DECLARE @linkShare nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @linkShare OUT, 'linkShare'
DECLARE @nextPageUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @nextPageUrl OUT, 'nextPageUrl'
DECLARE @previousPageUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @previousPageUrl OUT, 'previousPageUrl'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'shares'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @AdditionalLabel OUT, 'shares[i].entity.additionalLabel'
EXEC sp_OAMethod @jResp, 'StringOf', @CommunityNickname OUT, 'shares[i].entity.communityNickname'
EXEC sp_OAMethod @jResp, 'StringOf', @CompanyName OUT, 'shares[i].entity.companyName'
EXEC sp_OAMethod @jResp, 'StringOf', @DisplayName OUT, 'shares[i].entity.displayName'
EXEC sp_OAMethod @jResp, 'StringOf', @FirstName OUT, 'shares[i].entity.firstName'
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'shares[i].entity.id'
EXEC sp_OAMethod @jResp, 'BoolOf', @IsActive OUT, 'shares[i].entity.isActive'
EXEC sp_OAMethod @jResp, 'BoolOf', @IsInThisCommunity OUT, 'shares[i].entity.isInThisCommunity'
EXEC sp_OAMethod @jResp, 'StringOf', @LastName OUT, 'shares[i].entity.lastName'
EXEC sp_OAMethod @jResp, 'StringOf', @Color OUT, 'shares[i].entity.motif.color'
EXEC sp_OAMethod @jResp, 'StringOf', @LargeIconUrl OUT, 'shares[i].entity.motif.largeIconUrl'
EXEC sp_OAMethod @jResp, 'StringOf', @MediumIconUrl OUT, 'shares[i].entity.motif.mediumIconUrl'
EXEC sp_OAMethod @jResp, 'StringOf', @SmallIconUrl OUT, 'shares[i].entity.motif.smallIconUrl'
EXEC sp_OAMethod @jResp, 'StringOf', @SvgIconUrl OUT, 'shares[i].entity.motif.svgIconUrl'
EXEC sp_OAMethod @jResp, 'StringOf', @MySubscription OUT, 'shares[i].entity.mySubscription'
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'shares[i].entity.name'
EXEC sp_OAMethod @jResp, 'StringOf', @Message OUT, 'shares[i].entity.outOfOffice.message'
EXEC sp_OAMethod @jResp, 'StringOf', @FullEmailPhotoUrl OUT, 'shares[i].entity.photo.fullEmailPhotoUrl'
EXEC sp_OAMethod @jResp, 'StringOf', @LargePhotoUrl OUT, 'shares[i].entity.photo.largePhotoUrl'
EXEC sp_OAMethod @jResp, 'StringOf', @MediumPhotoUrl OUT, 'shares[i].entity.photo.mediumPhotoUrl'
EXEC sp_OAMethod @jResp, 'StringOf', @PhotoVersionId OUT, 'shares[i].entity.photo.photoVersionId'
EXEC sp_OAMethod @jResp, 'StringOf', @SmallPhotoUrl OUT, 'shares[i].entity.photo.smallPhotoUrl'
EXEC sp_OAMethod @jResp, 'StringOf', @StandardEmailPhotoUrl OUT, 'shares[i].entity.photo.standardEmailPhotoUrl'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'shares[i].entity.photo.url'
EXEC sp_OAMethod @jResp, 'StringOf', @Reputation OUT, 'shares[i].entity.reputation'
EXEC sp_OAMethod @jResp, 'StringOf', @Title OUT, 'shares[i].entity.title'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'shares[i].entity.type'
EXEC sp_OAMethod @jResp, 'StringOf', @entityUrl OUT, 'shares[i].entity.url'
EXEC sp_OAMethod @jResp, 'StringOf', @UserType OUT, 'shares[i].entity.userType'
EXEC sp_OAMethod @jResp, 'StringOf', @sharingType OUT, 'shares[i].sharingType'
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}}/connect/files/:FILE_ID/file-shares
Postman Collection Item JSON
{
"name": "File Shares",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
},
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/:FILE_ID/file-shares",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"files",
":FILE_ID",
"file-shares"
],
"variable": [
{
"key": "FILE_ID",
"value": ""
}
]
},
"description": "Returns information about the objects with which the specified file has been shared. Objects can be users, groups, or records.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_files_shares.htm"
},
"response": [
{
"name": "Successful File Shares",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/:FILE_ID/file-shares",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"files",
":FILE_ID",
"file-shares"
],
"variable": [
{
"key": "FILE_ID",
"value": "0692o00000woaRkAAI"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 16:37:07 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": "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 \"currentPageUrl\": \"/services/data/v58.0/connect/files/069.../file-shares\",\n \"linkShare\": null,\n \"nextPageUrl\": null,\n \"previousPageUrl\": null,\n \"shares\": [\n {\n \"entity\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"firstName\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https://<my_domain>/profilephoto/7292o000000oAgZ/F\",\n \"mediumPhotoUrl\": \"https://<my_domain>/profilephoto/7292o000000oAgZ/M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https://<my_domain>/profilephoto/7292o000000oAgZ/T\",\n \"standardEmailPhotoUrl\": \"https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"sharingType\": \"I\"\n }\n ]\n}"
}
]
}
