Chilkat Online Tools

Xojo / DocuSign REST API / Get Workspace File

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateString("is_download","{{is_download}}")
success = queryParams.UpdateString("pdf_version","{{pdf_version}}")

// Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = "{{accessToken}}"
http.SetRequestHeader "Accept","application/json"

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/v2.1/accounts/{{accountId}}/workspaces/{{workspaceId}}/folders/{{folderId}}/files/{{fileId}}",queryParams)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

System.DebugLog(Str(resp.StatusCode))
System.DebugLog(resp.BodyStr)

Curl Command

curl -G -d "is_download=%7B%7Bis_download%7D%7D"
	-d "pdf_version=%7B%7Bpdf_version%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/workspaces/{{workspaceId}}/folders/{{folderId}}/files/{{fileId}}

Postman Collection Item JSON

{
  "name": "Get Workspace File",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/workspaces/{{workspaceId}}/folders/{{folderId}}/files/{{fileId}}?is_download={{is_download}}&pdf_version={{pdf_version}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "workspaces",
        "{{workspaceId}}",
        "folders",
        "{{folderId}}",
        "files",
        "{{fileId}}"
      ],
      "query": [
        {
          "key": "is_download",
          "value": "{{is_download}}"
        },
        {
          "key": "pdf_version",
          "value": "{{pdf_version}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "fileId",
          "value": "{{fileId}}"
        },
        {
          "key": "folderId",
          "value": "{{folderId}}"
        },
        {
          "key": "workspaceId",
          "value": "{{workspaceId}}"
        }
      ]
    },
    "description": "Retrieves a workspace file (the binary)."
  },
  "response": [
  ]
}