(Java) DocuSign List Folder Items

See more DocuSign Examples

Retrieves a list of the envelopes in the specified folder.

For more information, see https://developers.docusign.com/docs/esign-rest-api/reference/folders/folders/listitems/

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();
    boolean success;

    // Implements the following HTTP request:
    // GET /restapi/v2.1/accounts/{accountId}/folders/{folderId}

    // Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
    CkJsonObject jsonToken = new CkJsonObject();
    // Load a previously obtained OAuth2 access token.
    success = jsonToken.LoadFile("qa_data/tokens/docusign.json");
    if (success == false) {
        System.out.println(jsonToken.lastErrorText());
        return;
        }

    http.put_AuthToken(jsonToken.stringOf("access_token"));

    // Use your account ID and a valid folderId here:
    http.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252");
    http.SetUrlVar("folderId","94644782-31b7-4f82-a2c1-26d8a9306f8c");

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    success = http.QuickGetSb("https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/folders/{$folderId}",sbResponseBody);
    if (success == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

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

    int respStatusCode = http.get_LastStatus();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(http.lastHeader());
        System.out.println("Failed.");
        return;
        }

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

    // {
    //   "resultSetSize": "sample string 1",
    //   "startPosition": "sample string 2",
    //   "endPosition": "sample string 3",
    //   "totalSetSize": "sample string 4",
    //   "previousUri": "sample string 5",
    //   "nextUri": "sample string 6",
    //   "folderItems": [
    //     {
    //       "ownerName": "sample string 1",
    //       "envelopeId": "sample string 2",
    //       "envelopeUri": "sample string 3",
    //       "status": "sample string 4",
    //       "senderName": "sample string 5",
    //       "senderEmail": "sample string 6",
    //       "createdDateTime": "sample string 7",
    //       "sentDateTime": "sample string 8",
    //       "completedDateTime": "sample string 9",
    //       "subject": "sample string 10",
    //       "templateId": "sample string 11",
    //       "name": "sample string 12",
    //       "shared": "sample string 13",
    //       "password": "sample string 14",
    //       "description": "sample string 15",
    //       "lastModified": "sample string 16",
    //       "pageCount": 17,
    //       "uri": "sample string 18",
    //       "is21CFRPart11": "sample string 19",
    //       "isSignatureProviderEnvelope": "sample string 20",
    //       "customFields": [
    //         {
    //           "fieldId": "sample string 1",
    //           "name": "sample string 2",
    //           "show": "sample string 3",
    //           "required": "sample string 4",
    //           "value": "sample string 5",
    //           "configurationType": "sample string 6",
    //           "errorDetails": {
    //             "errorCode": "sample string 1",
    //             "message": "sample string 2"
    //           }
    //         }
    //       ]
    //     }
    //   ]
    // }

    // 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 ownerName;
    String envelopeId;
    String envelopeUri;
    String status;
    String senderName;
    String senderEmail;
    String createdDateTime;
    String sentDateTime;
    String completedDateTime;
    String subject;
    String templateId;
    String name;
    String shared;
    String password;
    String description;
    String lastModified;
    int pageCount;
    String uri;
    String is21CFRPart11;
    String isSignatureProviderEnvelope;
    int j;
    int count_j;
    String fieldId;
    String show;
    String required;
    String value;
    String configurationType;
    String errorDetailsErrorCode;
    String errorDetailsMessage;

    String resultSetSize = jResp.stringOf("resultSetSize");
    String startPosition = jResp.stringOf("startPosition");
    String endPosition = jResp.stringOf("endPosition");
    String totalSetSize = jResp.stringOf("totalSetSize");
    String previousUri = jResp.stringOf("previousUri");
    String nextUri = jResp.stringOf("nextUri");
    int i = 0;
    int count_i = jResp.SizeOfArray("folderItems");
    while (i < count_i) {
        jResp.put_I(i);
        ownerName = jResp.stringOf("folderItems[i].ownerName");
        envelopeId = jResp.stringOf("folderItems[i].envelopeId");
        envelopeUri = jResp.stringOf("folderItems[i].envelopeUri");
        status = jResp.stringOf("folderItems[i].status");
        senderName = jResp.stringOf("folderItems[i].senderName");
        senderEmail = jResp.stringOf("folderItems[i].senderEmail");
        createdDateTime = jResp.stringOf("folderItems[i].createdDateTime");
        sentDateTime = jResp.stringOf("folderItems[i].sentDateTime");
        completedDateTime = jResp.stringOf("folderItems[i].completedDateTime");
        subject = jResp.stringOf("folderItems[i].subject");
        templateId = jResp.stringOf("folderItems[i].templateId");
        name = jResp.stringOf("folderItems[i].name");
        shared = jResp.stringOf("folderItems[i].shared");
        password = jResp.stringOf("folderItems[i].password");
        description = jResp.stringOf("folderItems[i].description");
        lastModified = jResp.stringOf("folderItems[i].lastModified");
        pageCount = jResp.IntOf("folderItems[i].pageCount");
        uri = jResp.stringOf("folderItems[i].uri");
        is21CFRPart11 = jResp.stringOf("folderItems[i].is21CFRPart11");
        isSignatureProviderEnvelope = jResp.stringOf("folderItems[i].isSignatureProviderEnvelope");
        j = 0;
        count_j = jResp.SizeOfArray("folderItems[i].customFields");
        while (j < count_j) {
            jResp.put_J(j);
            fieldId = jResp.stringOf("folderItems[i].customFields[j].fieldId");
            name = jResp.stringOf("folderItems[i].customFields[j].name");
            show = jResp.stringOf("folderItems[i].customFields[j].show");
            required = jResp.stringOf("folderItems[i].customFields[j].required");
            value = jResp.stringOf("folderItems[i].customFields[j].value");
            configurationType = jResp.stringOf("folderItems[i].customFields[j].configurationType");
            errorDetailsErrorCode = jResp.stringOf("folderItems[i].customFields[j].errorDetails.errorCode");
            errorDetailsMessage = jResp.stringOf("folderItems[i].customFields[j].errorDetails.message");
            j = j+1;
            }

        i = i+1;
        }
  }
}