PowerShell

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. PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

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

$http = New-Object Chilkat.Http

# 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.
$http.AuthToken = "YOUR_API_KEY"
$http.SetRequestHeader("Content-Type","application/json")

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://staging-api.yousign.com/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    exit
}

# 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

$id = $jResp.StringOf("id")
$name = $jResp.StringOf("name")
$v_type = $jResp.StringOf("type")
$contentType = $jResp.StringOf("contentType")
$description = $jResp.StringOf("description")
$createdAt = $jResp.StringOf("createdAt")
$updatedAt = $jResp.StringOf("updatedAt")
$sha256 = $jResp.StringOf("sha256")
$workspace = $jResp.StringOf("workspace")
$creator = $jResp.StringOf("creator")
$v_protected = $jResp.BoolOf("protected")
$position = $jResp.IntOf("position")
$parent = $jResp.StringOf("parent")
$i = 0
$count_i = $jResp.SizeOfArray("metadata")
while ($i -lt $count_i) {
    $jResp.I = $i
    $i = $i + 1
}