Chilkat Online Tools

Objective-C / DocuSign REST API / List Workspace Folder Contents

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"count" value: @"{{count}}"];
[queryParams UpdateString: @"include_files" value: @"{{include_files}}"];
[queryParams UpdateString: @"include_sub_folders" value: @"{{include_sub_folders}}"];
[queryParams UpdateString: @"include_thumbnails" value: @"{{include_thumbnails}}"];
[queryParams UpdateString: @"include_user_detail" value: @"{{include_user_detail}}"];
[queryParams UpdateString: @"start_position" value: @"{{start_position}}"];
[queryParams UpdateString: @"workspace_user_id" value: @"{{workspace_user_id}}"];

// Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = @"{{accessToken}}";
[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://domain.com/v2.1/accounts/{{accountId}}/workspaces/{{workspaceId}}/folders/{{folderId}}" json: queryParams];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

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}}"
        },
        {
          "key": "folderId",
          "value": "{{folderId}}"
        },
        {
          "key": "workspaceId",
          "value": "{{workspaceId}}"
        }
      ]
    },
    "description": "Retrieves workspace folder contents, which can include sub folders and files."
  },
  "response": [
  ]
}