Chilkat Online Tools

Ruby / DocuSign eSignature REST API / List Workspace Folder Contents

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("count","{{count}}")
queryParams.UpdateString("include_files","{{include_files}}")
queryParams.UpdateString("include_sub_folders","{{include_sub_folders}}")
queryParams.UpdateString("include_thumbnails","{{include_thumbnails}}")
queryParams.UpdateString("include_user_detail","{{include_user_detail}}")
queryParams.UpdateString("start_position","{{start_position}}")
queryParams.UpdateString("workspace_user_id","{{workspace_user_id}}")

# Adds the "Authorization: Bearer {{accessToken}}" header.
http.put_AuthToken("{{accessToken}}")
http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/v2.1/accounts/{{accountId}}/workspaces/{{workspaceId}}/folders/{{folderId}}",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -G -d "count=%7B%7Bcount%7D%7D"
	-d "include_files=%7B%7Binclude_files%7D%7D"
	-d "include_sub_folders=%7B%7Binclude_sub_folders%7D%7D"
	-d "include_thumbnails=%7B%7Binclude_thumbnails%7D%7D"
	-d "include_user_detail=%7B%7Binclude_user_detail%7D%7D"
	-d "start_position=%7B%7Bstart_position%7D%7D"
	-d "workspace_user_id=%7B%7Bworkspace_user_id%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/workspaces/{{workspaceId}}/folders/{{folderId}}

Postman Collection Item JSON

{
  "name": "List Workspace Folder Contents",
  "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}}?count={{count}}&include_files={{include_files}}&include_sub_folders={{include_sub_folders}}&include_thumbnails={{include_thumbnails}}&include_user_detail={{include_user_detail}}&start_position={{start_position}}&workspace_user_id={{workspace_user_id}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "workspaces",
        "{{workspaceId}}",
        "folders",
        "{{folderId}}"
      ],
      "query": [
        {
          "key": "count",
          "value": "{{count}}"
        },
        {
          "key": "include_files",
          "value": "{{include_files}}"
        },
        {
          "key": "include_sub_folders",
          "value": "{{include_sub_folders}}"
        },
        {
          "key": "include_thumbnails",
          "value": "{{include_thumbnails}}"
        },
        {
          "key": "include_user_detail",
          "value": "{{include_user_detail}}"
        },
        {
          "key": "start_position",
          "value": "{{start_position}}"
        },
        {
          "key": "workspace_user_id",
          "value": "{{workspace_user_id}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "folderId",
          "value": "{{folderId}}",
          "type": "string"
        },
        {
          "key": "workspaceId",
          "value": "{{workspaceId}}",
          "type": "string"
        }
      ]
    },
    "description": "Retrieves workspace folder contents, which can include sub folders and files."
  },
  "response": [
  ]
}