Chilkat Online Tools

delphiAx / DocuSign REST API / Gets a document from an envelope.

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := TChilkatHttp.Create(Self);

queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('certificate','{{certificate}}');
queryParams.UpdateString('documents_by_userid','{{documents_by_userid}}');
queryParams.UpdateString('encoding','{{encoding}}');
queryParams.UpdateString('encrypt','{{encrypt}}');
queryParams.UpdateString('language','{{language}}');
queryParams.UpdateString('recipient_id','{{recipient_id}}');
queryParams.UpdateString('shared_user_id','{{shared_user_id}}');
queryParams.UpdateString('show_changes','{{show_changes}}');
queryParams.UpdateString('watermark','{{watermark}}');

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

resp := http.QuickRequestParams('GET','https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents/{{documentId}}',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

Memo1.Lines.Add(IntToStr(resp.StatusCode));
Memo1.Lines.Add(resp.BodyStr);

Curl Command

curl -G -d "certificate=%7B%7Bcertificate%7D%7D"
	-d "documents_by_userid=%7B%7Bdocuments_by_userid%7D%7D"
	-d "encoding=%7B%7Bencoding%7D%7D"
	-d "encrypt=%7B%7Bencrypt%7D%7D"
	-d "language=%7B%7Blanguage%7D%7D"
	-d "recipient_id=%7B%7Brecipient_id%7D%7D"
	-d "shared_user_id=%7B%7Bshared_user_id%7D%7D"
	-d "show_changes=%7B%7Bshow_changes%7D%7D"
	-d "watermark=%7B%7Bwatermark%7D%7D"
	-H "Accept: application/pdf"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents/{{documentId}}

Postman Collection Item JSON

{
  "name": "Gets a document from an envelope.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/pdf"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents/{{documentId}}?certificate={{certificate}}&documents_by_userid={{documents_by_userid}}&encoding={{encoding}}&encrypt={{encrypt}}&language={{language}}&recipient_id={{recipient_id}}&shared_user_id={{shared_user_id}}&show_changes={{show_changes}}&watermark={{watermark}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "documents",
        "{{documentId}}"
      ],
      "query": [
        {
          "key": "certificate",
          "value": "{{certificate}}"
        },
        {
          "key": "documents_by_userid",
          "value": "{{documents_by_userid}}"
        },
        {
          "key": "encoding",
          "value": "{{encoding}}"
        },
        {
          "key": "encrypt",
          "value": "{{encrypt}}"
        },
        {
          "key": "language",
          "value": "{{language}}"
        },
        {
          "key": "recipient_id",
          "value": "{{recipient_id}}"
        },
        {
          "key": "shared_user_id",
          "value": "{{shared_user_id}}"
        },
        {
          "key": "show_changes",
          "value": "{{show_changes}}"
        },
        {
          "key": "watermark",
          "value": "{{watermark}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "documentId",
          "value": "{{documentId}}"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}"
        }
      ]
    },
    "description": "Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted.\n\nYou can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. \n\nTo retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`.\n/accounts/{accountId}/envelopes/{envelopeId}/documents/combined"
  },
  "response": [
  ]
}