Chilkat Online Tools

Swift / DocuSign eSignature REST API / Retrieves a list of all the items in a specified folder from the specified cloud storage provider.

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

    let queryParams = CkoJsonObject()
    queryParams.UpdateString("cloud_storage_folder_path", value: "{{cloud_storage_folder_path}}")
    queryParams.UpdateString("count", value: "{{count}}")
    queryParams.UpdateString("order", value: "{{order}}")
    queryParams.UpdateString("order_by", value: "{{order_by}}")
    queryParams.UpdateString("search_text", value: "{{search_text}}")
    queryParams.UpdateString("start_position", value: "{{start_position}}")

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

    var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://domain.com/v2.1/accounts/{{accountId}}/users/{{userId}}/cloud_storage/{{serviceId}}/folders", json: queryParams)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    print("\(resp!.StatusCode.intValue)")
    print("\(resp!.BodyStr)")
    resp = nil

}

Curl Command

curl -G -d "cloud_storage_folder_path=%7B%7Bcloud_storage_folder_path%7D%7D"
	-d "count=%7B%7Bcount%7D%7D"
	-d "order=%7B%7Border%7D%7D"
	-d "order_by=%7B%7Border_by%7D%7D"
	-d "search_text=%7B%7Bsearch_text%7D%7D"
	-d "start_position=%7B%7Bstart_position%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/users/{{userId}}/cloud_storage/{{serviceId}}/folders

Postman Collection Item JSON

{
  "name": "Retrieves a list of all the items in a specified folder from the specified cloud storage provider.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/users/{{userId}}/cloud_storage/{{serviceId}}/folders?cloud_storage_folder_path={{cloud_storage_folder_path}}&count={{count}}&order={{order}}&order_by={{order_by}}&search_text={{search_text}}&start_position={{start_position}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "users",
        "{{userId}}",
        "cloud_storage",
        "{{serviceId}}",
        "folders"
      ],
      "query": [
        {
          "key": "cloud_storage_folder_path",
          "value": "{{cloud_storage_folder_path}}"
        },
        {
          "key": "count",
          "value": "{{count}}"
        },
        {
          "key": "order",
          "value": "{{order}}"
        },
        {
          "key": "order_by",
          "value": "{{order_by}}"
        },
        {
          "key": "search_text",
          "value": "{{search_text}}"
        },
        {
          "key": "start_position",
          "value": "{{start_position}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "serviceId",
          "value": "{{serviceId}}",
          "type": "string"
        },
        {
          "key": "userId",
          "value": "{{userId}}",
          "type": "string"
        }
      ]
    },
    "description": "Retrieves a list of all the items in a specified folder from the specified cloud storage provider. "
  },
  "response": [
  ]
}