Chilkat Online Tools

delphiDll / Salesforce Platform APIs / File Shares

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
AdditionalLabel: PWideChar;
CommunityNickname: PWideChar;
CompanyName: PWideChar;
DisplayName: PWideChar;
FirstName: PWideChar;
Id: PWideChar;
IsActive: Boolean;
IsInThisCommunity: Boolean;
LastName: PWideChar;
Color: PWideChar;
LargeIconUrl: PWideChar;
MediumIconUrl: PWideChar;
SmallIconUrl: PWideChar;
SvgIconUrl: PWideChar;
MySubscription: PWideChar;
Name: PWideChar;
Message: PWideChar;
FullEmailPhotoUrl: PWideChar;
LargePhotoUrl: PWideChar;
MediumPhotoUrl: PWideChar;
PhotoVersionId: PWideChar;
SmallPhotoUrl: PWideChar;
StandardEmailPhotoUrl: PWideChar;
v_Url: PWideChar;
Reputation: PWideChar;
Title: PWideChar;
v_Type: PWideChar;
entityUrl: PWideChar;
UserType: PWideChar;
sharingType: PWideChar;
currentPageUrl: PWideChar;
linkShare: PWideChar;
nextPageUrl: PWideChar;
previousPageUrl: PWideChar;
i: Integer;
count_i: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := CkHttp_Create();

// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://domain.com/services/data/v{{version}}/connect/files/:FILE_ID/file-shares',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  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

currentPageUrl := CkJsonObject__stringOf(jResp,'currentPageUrl');
linkShare := CkJsonObject__stringOf(jResp,'linkShare');
nextPageUrl := CkJsonObject__stringOf(jResp,'nextPageUrl');
previousPageUrl := CkJsonObject__stringOf(jResp,'previousPageUrl');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'shares');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    AdditionalLabel := CkJsonObject__stringOf(jResp,'shares[i].entity.additionalLabel');
    CommunityNickname := CkJsonObject__stringOf(jResp,'shares[i].entity.communityNickname');
    CompanyName := CkJsonObject__stringOf(jResp,'shares[i].entity.companyName');
    DisplayName := CkJsonObject__stringOf(jResp,'shares[i].entity.displayName');
    FirstName := CkJsonObject__stringOf(jResp,'shares[i].entity.firstName');
    Id := CkJsonObject__stringOf(jResp,'shares[i].entity.id');
    IsActive := CkJsonObject_BoolOf(jResp,'shares[i].entity.isActive');
    IsInThisCommunity := CkJsonObject_BoolOf(jResp,'shares[i].entity.isInThisCommunity');
    LastName := CkJsonObject__stringOf(jResp,'shares[i].entity.lastName');
    Color := CkJsonObject__stringOf(jResp,'shares[i].entity.motif.color');
    LargeIconUrl := CkJsonObject__stringOf(jResp,'shares[i].entity.motif.largeIconUrl');
    MediumIconUrl := CkJsonObject__stringOf(jResp,'shares[i].entity.motif.mediumIconUrl');
    SmallIconUrl := CkJsonObject__stringOf(jResp,'shares[i].entity.motif.smallIconUrl');
    SvgIconUrl := CkJsonObject__stringOf(jResp,'shares[i].entity.motif.svgIconUrl');
    MySubscription := CkJsonObject__stringOf(jResp,'shares[i].entity.mySubscription');
    Name := CkJsonObject__stringOf(jResp,'shares[i].entity.name');
    Message := CkJsonObject__stringOf(jResp,'shares[i].entity.outOfOffice.message');
    FullEmailPhotoUrl := CkJsonObject__stringOf(jResp,'shares[i].entity.photo.fullEmailPhotoUrl');
    LargePhotoUrl := CkJsonObject__stringOf(jResp,'shares[i].entity.photo.largePhotoUrl');
    MediumPhotoUrl := CkJsonObject__stringOf(jResp,'shares[i].entity.photo.mediumPhotoUrl');
    PhotoVersionId := CkJsonObject__stringOf(jResp,'shares[i].entity.photo.photoVersionId');
    SmallPhotoUrl := CkJsonObject__stringOf(jResp,'shares[i].entity.photo.smallPhotoUrl');
    StandardEmailPhotoUrl := CkJsonObject__stringOf(jResp,'shares[i].entity.photo.standardEmailPhotoUrl');
    v_Url := CkJsonObject__stringOf(jResp,'shares[i].entity.photo.url');
    Reputation := CkJsonObject__stringOf(jResp,'shares[i].entity.reputation');
    Title := CkJsonObject__stringOf(jResp,'shares[i].entity.title');
    v_Type := CkJsonObject__stringOf(jResp,'shares[i].entity.type');
    entityUrl := CkJsonObject__stringOf(jResp,'shares[i].entity.url');
    UserType := CkJsonObject__stringOf(jResp,'shares[i].entity.userType');
    sharingType := CkJsonObject__stringOf(jResp,'shares[i].sharingType');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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}"
    }
  ]
}