(Java) DocuSign Add One Document to a Draft Envelope

See more DocuSign Examples

Demonstrates how to add one document to a DocuSign draft envelope.

For more information, see https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/updatelist/

Chilkat Java Downloads Java Libs for Windows, MacOS, Linux, Alpine Linux, Solaris Java Libs for Android

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();

    // Load a previously obtained OAuth2 access token.
    CkJsonObject jsonToken = new CkJsonObject();
    boolean success = jsonToken.LoadFile("qa_data/tokens/docusign.json");
    if (success == false) {
        System.out.println(jsonToken.lastErrorText());
        return;
        }

    // Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
    http.put_AuthToken(jsonToken.stringOf("access_token"));

    // Send the following request.
    // Make sure to use your own account ID (obtained from Get Docusign User Account Information)

    // PUT https://demo.docusign.net/restapi/v2.1/accounts/<account ID>/envelopes/<envelope ID>/documents HTTP/1.1
    // Expect: 100-continue
    // Accept: application/json
    // Cache-Control: no-cache
    // Authorization: Bearer eyJ0eX...
    // Content-Length: ...
    // Content-Type: application/json
    // 
    // {
    // 	"documents": [
    // 		{
    // 		"documentId": "1",
    // 		"name": "project_xyz.pdf",
    // 		"pages": "1",
    // 		"documentBase64": "<insert base64 content here>"
    // 		}
    // 	]
    // }

    CkBinData bd1 = new CkBinData();
    success = bd1.LoadFile("qa_data/pdf/project_xyz.pdf");

    CkJsonObject json = new CkJsonObject();
    json.UpdateString("documents[0].documentId","1");
    json.UpdateString("documents[0].name","project_xyz.pdf");
    json.UpdateString("documents[0].pages","1");
    json.UpdateString("documents[0].documentBase64",bd1.getEncoded("base64"));

    CkStringBuilder sbJson = new CkStringBuilder();
    json.put_EmitCompact(false);
    json.EmitSb(sbJson);

    http.SetRequestHeader("Expect","100-continue");
    http.SetRequestHeader("Cache-Control","no-cache");
    http.SetRequestHeader("Accept","application/json");

    // Use your own account ID here.
    http.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252");
    // Use the envelope ID returned by DocuSign when creating the draft envelope).
    http.SetUrlVar("envelopeId","0b437b95-cc50-475f-8dec-65bae9f27d09");

    String url = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents";
    CkHttpResponse resp = http.PTextSb("PUT",url,sbJson,"utf-8","application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkJsonObject jResp = new CkJsonObject();
    jResp.Load(resp.bodyStr());
    jResp.put_EmitCompact(false);

    System.out.println("Response Body:");
    System.out.println(jResp.emit());

    // If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
    int respStatusCode = resp.get_StatusCode();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(resp.header());
        System.out.println("Failed.");

        return;
        }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "envelopeId": "da9fb811-e6a4-48c0-a9fb-81ed18b989af",
    //   "envelopeDocuments": [
    //     {
    //       "documentId": "1",
    //       "documentIdGuid": "38e919fc-0a77-4b0c-9da0-e3530f4e6fc7",
    //       "name": "project_xyz.pdf",
    //       "type": "content",
    //       "uri": "/envelopes/da9fb811-e6a4-48c0-a9fb-81ed18b989af/documents/1",
    //       "order": "3",
    //       "containsPdfFormFields": "false",
    //       "templateRequired": "false",
    //       "authoritativeCopy": "false"
    //     }
    //   ]
    // }

    // Sample code for parsing the JSON response...
    // Use the following online tool to generate parsing code from sample JSON:
    // Generate Parsing Code from JSON

    String documentId;
    String documentIdGuid;
    String name;
    String v_type;
    String uri;
    String order;
    String containsPdfFormFields;
    String templateRequired;
    String authoritativeCopy;

    String envelopeId = jResp.stringOf("envelopeId");
    int i = 0;
    int count_i = jResp.SizeOfArray("envelopeDocuments");
    while (i < count_i) {
        jResp.put_I(i);
        documentId = jResp.stringOf("envelopeDocuments[i].documentId");
        documentIdGuid = jResp.stringOf("envelopeDocuments[i].documentIdGuid");
        name = jResp.stringOf("envelopeDocuments[i].name");
        v_type = jResp.stringOf("envelopeDocuments[i].type");
        uri = jResp.stringOf("envelopeDocuments[i].uri");
        order = jResp.stringOf("envelopeDocuments[i].order");
        containsPdfFormFields = jResp.stringOf("envelopeDocuments[i].containsPdfFormFields");
        templateRequired = jResp.stringOf("envelopeDocuments[i].templateRequired");
        authoritativeCopy = jResp.stringOf("envelopeDocuments[i].authoritativeCopy");
        i = i+1;
        }
  }
}