PowerBuilder

Yousign: Download Information about Previously Uploaded File

See more Yousign Examples

Demonstrates how to download the information (in JSON format) about a file previously uploaded. PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Http
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_Name
string ls_V_type
string ls_ContentType
string ls_Description
string ls_CreatedAt
string ls_UpdatedAt
string ls_Sha256
string ls_Workspace
string ls_Creator
integer li_V_protected
integer li_Position
string ls_Parent
integer i
integer li_Count_i

li_Success = 0

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Implements the following CURL command:

// curl --location --request GET 'https://staging-api.yousign.com/files/{{id}}' \
// --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.
loo_Http.AuthToken = "YOUR_API_KEY"
loo_Http.SetRequestHeader("Content-Type","application/json")

loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://staging-api.yousign.com/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastHeader
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

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

// {
//   "id": "/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//   "name": "The best name for my file.pdf",
//   "type": "signable",
//   "contentType": "application/pdf",
//   "description": null,
//   "createdAt": "2018-12-07T08:10:21+01:00",
//   "updatedAt": "2018-12-07T08:10:21+01:00",
//   "sha256": "bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2",
//   "metadata": [
//   ],
//   "workspace": "/workspaces/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//   "creator": null,
//   "protected": false,
//   "position": 0,
//   "parent": null
// }

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

ls_Id = loo_JResp.StringOf("id")
ls_Name = loo_JResp.StringOf("name")
ls_V_type = loo_JResp.StringOf("type")
ls_ContentType = loo_JResp.StringOf("contentType")
ls_Description = loo_JResp.StringOf("description")
ls_CreatedAt = loo_JResp.StringOf("createdAt")
ls_UpdatedAt = loo_JResp.StringOf("updatedAt")
ls_Sha256 = loo_JResp.StringOf("sha256")
ls_Workspace = loo_JResp.StringOf("workspace")
ls_Creator = loo_JResp.StringOf("creator")
li_V_protected = loo_JResp.BoolOf("protected")
li_Position = loo_JResp.IntOf("position")
ls_Parent = loo_JResp.StringOf("parent")
i = 0
li_Count_i = loo_JResp.SizeOfArray("metadata")
do while i < li_Count_i
    loo_JResp.I = i
    i = i + 1
loop


destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp