Chilkat Online Tools

Ruby / DocuSign eSignature REST API / 17. Get Template Definition

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("include","tabs")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/{{apiVersion}}/accounts/{{accountId}}/templates/{{templateId}}",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 "include=tabs"
	-H "Authorization: Bearer <access_token>"
https://domain.com/{{apiVersion}}/accounts/{{accountId}}/templates/{{templateId}}

Postman Collection Item JSON

{
  "name": "17. Get Template Definition",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{accessToken}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/templates/{{templateId}}?include=tabs",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "{{apiVersion}}",
        "accounts",
        "{{accountId}}",
        "templates",
        "{{templateId}}"
      ],
      "query": [
        {
          "key": "include",
          "value": "tabs"
        }
      ]
    },
    "description": "If one is not sure which template is the one they want to use, they can fetch the template after listing it and verify that it's the one they want to use."
  },
  "response": [
  ]
}