Chilkat Online Tools

Ruby / DocuSign Rooms API - v2 / Gets a paged list of forms in a forms library.

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.UpdateInt("count",100)
queryParams.UpdateInt("startPosition",0)

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

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/v2/accounts/{{accountId}}/form_libraries/{{formLibraryId}}/forms",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=100"
	-d "startPosition=0"
	-H "Accept: text/plain, application/json, text/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2/accounts/{{accountId}}/form_libraries/{{formLibraryId}}/forms

Postman Collection Item JSON

{
  "name": "Gets a paged list of forms in a forms library.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "text/plain, application/json, text/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2/accounts/{{accountId}}/form_libraries/{{formLibraryId}}/forms?count=100&startPosition=0",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2",
        "accounts",
        "{{accountId}}",
        "form_libraries",
        "{{formLibraryId}}",
        "forms"
      ],
      "query": [
        {
          "key": "count",
          "value": "100"
        },
        {
          "key": "startPosition",
          "value": "0"
        }
      ],
      "variable": [
        {
          "key": "formLibraryId",
          "value": "{{formLibraryId}}"
        },
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    }
  },
  "response": [
  ]
}