PureBasic / DocuSign REST API / List Workspace Folder Contents
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"count","{{count}}")
CkJsonObject::ckUpdateString(queryParams,"include_files","{{include_files}}")
CkJsonObject::ckUpdateString(queryParams,"include_sub_folders","{{include_sub_folders}}")
CkJsonObject::ckUpdateString(queryParams,"include_thumbnails","{{include_thumbnails}}")
CkJsonObject::ckUpdateString(queryParams,"include_user_detail","{{include_user_detail}}")
CkJsonObject::ckUpdateString(queryParams,"start_position","{{start_position}}")
CkJsonObject::ckUpdateString(queryParams,"workspace_user_id","{{workspace_user_id}}")
; Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp::setCkAuthToken(http, "{{accessToken}}")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://domain.com/v2.1/accounts/{{accountId}}/workspaces/{{workspaceId}}/folders/{{folderId}}",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndProcedure
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": [
]
}