Chilkat Online Tools

DescribeComments Powershell Example

Amazon WorkDocs

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

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

$rest = New-Object Chilkat.Rest

$authAws = New-Object Chilkat.AuthAws
$authAws.AccessKey = "AWS_ACCESS_KEY"
$authAws.SecretKey = "AWS_SECRET_KEY"

# Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
$authAws.Region = "us-west-2"
$authAws.ServiceName = "workdocs"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
$rest.SetAuthAws($authAws)

# URL: https://workdocs.us-west-2.amazonaws.com/
# Use the same region as specified above.
$success = $rest.Connect("workdocs.us-west-2.amazonaws.com",443,$true,$true)
if ($success -ne $true) {
    $("ConnectFailReason: " + $rest.ConnectFailReason)
    $($rest.LastErrorText)
    exit
}

$rest.AddHeader("Content-Type","application/x-amz-json-1.1")
$rest.AddHeader("X-Amz-Target","DescribeComments")

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestNoBodySb("GET","/api/v1/documents/{DocumentId}/versions/{VersionId}/comments",$sbResponseBody)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$respStatusCode = $rest.ResponseStatusCode
$("response status code = " + $respStatusCode)
if ($respStatusCode -ne 200) {
    $("Response Header:")
    $($rest.ResponseHeader)
    $("Response Body:")
    $($sbResponseBody.GetAsString())
    exit
}

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

# The following code parses the JSON response.
# A sample JSON response is shown below the sample code.

# Use this online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

$Marker = $jResp.StringOf("Marker")
$i = 0
$count_i = $jResp.SizeOfArray("Comments")
while ($i -lt $count_i) {
    $jResp.I = $i
    $CommentId = $jResp.StringOf("Comments[i].CommentId")
    $CreatedTimestamp = $jResp.IntOf("Comments[i].Contributor.CreatedTimestamp")
    $EmailAddress = $jResp.StringOf("Comments[i].Contributor.EmailAddress")
    $GivenName = $jResp.StringOf("Comments[i].Contributor.GivenName")
    $Id = $jResp.StringOf("Comments[i].Contributor.Id")
    $Locale = $jResp.StringOf("Comments[i].Contributor.Locale")
    $ModifiedTimestamp = $jResp.IntOf("Comments[i].Contributor.ModifiedTimestamp")
    $OrganizationId = $jResp.StringOf("Comments[i].Contributor.OrganizationId")
    $RecycleBinFolderId = $jResp.StringOf("Comments[i].Contributor.RecycleBinFolderId")
    $RootFolderId = $jResp.StringOf("Comments[i].Contributor.RootFolderId")
    $Status = $jResp.StringOf("Comments[i].Contributor.Status")
    $StorageAllocatedInBytes = $jResp.IntOf("Comments[i].Contributor.Storage.StorageRule.StorageAllocatedInBytes")
    $StorageType = $jResp.StringOf("Comments[i].Contributor.Storage.StorageRule.StorageType")
    $StorageUtilizedInBytes = $jResp.IntOf("Comments[i].Contributor.Storage.StorageUtilizedInBytes")
    $Surname = $jResp.StringOf("Comments[i].Contributor.Surname")
    $TimeZoneId = $jResp.StringOf("Comments[i].Contributor.TimeZoneId")
    $v_Type = $jResp.StringOf("Comments[i].Contributor.Type")
    $Username = $jResp.StringOf("Comments[i].Contributor.Username")
    $CreatedTimestamp = $jResp.IntOf("Comments[i].CreatedTimestamp")
    $ParentId = $jResp.StringOf("Comments[i].ParentId")
    $RecipientId = $jResp.StringOf("Comments[i].RecipientId")
    $Status = $jResp.StringOf("Comments[i].Status")
    $Text = $jResp.StringOf("Comments[i].Text")
    $ThreadId = $jResp.StringOf("Comments[i].ThreadId")
    $Visibility = $jResp.StringOf("Comments[i].Visibility")
    $i = $i + 1
}

# A sample JSON response body parsed by the above code:

# {
#   "Comments": [
#     {
#       "CommentId": "string",
#       "Contributor": {
#         "CreatedTimestamp": number,
#         "EmailAddress": "string",
#         "GivenName": "string",
#         "Id": "string",
#         "Locale": "string",
#         "ModifiedTimestamp": number,
#         "OrganizationId": "string",
#         "RecycleBinFolderId": "string",
#         "RootFolderId": "string",
#         "Status": "string",
#         "Storage": {
#           "StorageRule": {
#             "StorageAllocatedInBytes": number,
#             "StorageType": "string"
#           },
#           "StorageUtilizedInBytes": number
#         },
#         "Surname": "string",
#         "TimeZoneId": "string",
#         "Type": "string",
#         "Username": "string"
#       },
#       "CreatedTimestamp": number,
#       "ParentId": "string",
#       "RecipientId": "string",
#       "Status": "string",
#       "Text": "string",
#       "ThreadId": "string",
#       "Visibility": "string"
#     }
#   ],
#   "Marker": "string"
# }