Chilkat Online Tools

Ruby / DocuSign REST API / List File Pages

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("dpi","{{dpi}}")
queryParams.UpdateString("max_height","{{max_height}}")
queryParams.UpdateString("max_width","{{max_width}}")
queryParams.UpdateString("start_position","{{start_position}}")

# 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}}/files/{{fileId}}/pages",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 "dpi=%7B%7Bdpi%7D%7D"
	-d "max_height=%7B%7Bmax_height%7D%7D"
	-d "max_width=%7B%7Bmax_width%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}}/workspaces/{{workspaceId}}/folders/{{folderId}}/files/{{fileId}}/pages

Postman Collection Item JSON

{
  "name": "List File Pages",
  "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}}/pages?count={{count}}&dpi={{dpi}}&max_height={{max_height}}&max_width={{max_width}}&start_position={{start_position}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "workspaces",
        "{{workspaceId}}",
        "folders",
        "{{folderId}}",
        "files",
        "{{fileId}}",
        "pages"
      ],
      "query": [
        {
          "key": "count",
          "value": "{{count}}"
        },
        {
          "key": "dpi",
          "value": "{{dpi}}"
        },
        {
          "key": "max_height",
          "value": "{{max_height}}"
        },
        {
          "key": "max_width",
          "value": "{{max_width}}"
        },
        {
          "key": "start_position",
          "value": "{{start_position}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "fileId",
          "value": "{{fileId}}"
        },
        {
          "key": "folderId",
          "value": "{{folderId}}"
        },
        {
          "key": "workspaceId",
          "value": "{{workspaceId}}"
        }
      ]
    },
    "description": "Retrieves a workspace file as rasterized pages."
  },
  "response": [
  ]
}