Chilkat Online Tools

Go / Salesforce Platform APIs / File Shares

Back to Collection Items

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

    http := chilkat.NewHttp()
    var success bool

    // Adds the "Authorization: Bearer <access_token>" header.
    http.SetAuthToken("<access_token>")

    sbResponseBody := chilkat.NewStringBuilder()
    success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/connect/files/:FILE_ID/file-shares",sbResponseBody)
    if success == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        return
    }

    jResp := chilkat.NewJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.SetEmitCompact(false)

    fmt.Println("Response Body:")
    fmt.Println(*jResp.Emit())

    respStatusCode := http.LastStatus()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(http.LastHeader())
        fmt.Println("Failed.")
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        jResp.DisposeJsonObject()
        return
    }

    // 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

    var AdditionalLabel *string = new(string)
    var CommunityNickname *string = new(string)
Company    var Name *string = new(string)
    var DisplayName *string = new(string)
First    var Name *string = new(string)
    var Id *string = new(string)
    var IsActive bool
    var IsInThisCommunity bool
    var LastName *string = new(string)
    var Color *string = new(string)
    var LargeIconUrl *string = new(string)
    var MediumIconUrl *string = new(string)
    var SmallIconUrl *string = new(string)
    var SvgIconUrl *string = new(string)
    var MySubscription *string = new(string)
    var Name *string = new(string)
    var Message *string = new(string)
    var FullEmailPhotoUrl *string = new(string)
    var LargePhotoUrl *string = new(string)
    var MediumPhotoUrl *string = new(string)
    var PhotoVersionId *string = new(string)
    var SmallPhotoUrl *string = new(string)
    var StandardEmailPhotoUrl *string = new(string)
    var v_Url *string = new(string)
    var Reputation *string = new(string)
    var Title *string = new(string)
    var v_Type *string = new(string)
    var entityUrl *string = new(string)
    var UserType *string = new(string)
    var sharingType *string = new(string)

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


    http.DisposeHttp()
    sbResponseBody.DisposeStringBuilder()
    jResp.DisposeJsonObject()

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