(JavaScript) Yousign: List Files

List Yousign files.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

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

var http = new CkHttp();

// Implements the following CURL command:

// curl --location --request GET 'https://staging-api.yousign.com/files' \
// --header 'Authorization: Bearer YOUR_API_KEY' \
// --header 'Content-Type: application/json'

// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code

// Adds the "Authorization: Bearer YOUR_API_KEY" header.
http.AuthToken = "YOUR_API_KEY";
http.SetRequestHeader("Content-Type","application/json");

var sbResponseBody = new CkStringBuilder();
success = http.QuickGetSb("https://staging-api.yousign.com/files",sbResponseBody);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var json = new CkJsonObject();
json.LoadSb(sbResponseBody);
json.EmitCompact = false;

console.log("Response Body:");
console.log(json.Emit());

var respStatusCode = http.LastStatus;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
    console.log("Response Header:");
    console.log(http.LastHeader);
    console.log("Failed.");
    return;
}

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

// {
//   "id": "\/files\/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//   "name": "abc.pdf",
//   "type": "signable",
//   "contentType": "application\/pdf",
//   "description": null,
//   "createdAt": "2020-05-27T09:14:12+02:00",
//   "updatedAt": "2020-05-27T09:14:12+02:00",
//   "sha256": "ea2a92b0eff5bebfa3ccd869fd61e27bb7fe973d0dff63f106d8b0d614469fa0",
//   "metadata": [
//   ],
//   "workspace": "\/workspaces\/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//   "creator": null,
//   "fileObjects": [
//   ],
//   "protected": false,
//   "position": 0,
//   "parent": null,
//   "fieldsCompatible": true,
//   "company": "\/companies\/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
// }

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

var id = json.StringOf("id");
var name = json.StringOf("name");
var v_type = json.StringOf("type");
var contentType = json.StringOf("contentType");
var description = json.StringOf("description");
var createdAt = json.StringOf("createdAt");
var updatedAt = json.StringOf("updatedAt");
var sha256 = json.StringOf("sha256");
var workspace = json.StringOf("workspace");
var creator = json.StringOf("creator");
var v_protected = json.BoolOf("protected");
var position = json.IntOf("position");
var parent = json.StringOf("parent");
var fieldsCompatible = json.BoolOf("fieldsCompatible");
var company = json.StringOf("company");
var i = 0;
var count_i = json.SizeOfArray("metadata");
while (i < count_i) {
    json.I = i;
    i = i+1;
}

i = 0;
count_i = json.SizeOfArray("fileObjects");
while (i < count_i) {
    json.I = i;
    i = i+1;
}