Chilkat Online Tools

DescribeComments TCL Example

Amazon WorkDocs

load ./chilkat.dll

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

set rest [new_CkRest]

set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $authAws "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.)
CkAuthAws_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "workdocs"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws

# URL: https://workdocs.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "workdocs.us-west-2.amazonaws.com" 443 1 1]
if {$success != 1} then {
    puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    exit
}

CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "DescribeComments"

set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestNoBodySb $rest "GET" "/api/v1/documents/{DocumentId}/versions/{VersionId}/comments" $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkStringBuilder $sbResponseBody
    exit
}

set respStatusCode [CkRest_get_ResponseStatusCode $rest]
puts "response status code = $respStatusCode"
if {$respStatusCode != 200} then {
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts [CkStringBuilder_getAsString $sbResponseBody]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $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

set Marker [CkJsonObject_stringOf $jResp "Marker"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "Comments"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set CommentId [CkJsonObject_stringOf $jResp "Comments[i].CommentId"]
    set CreatedTimestamp [CkJsonObject_IntOf $jResp "Comments[i].Contributor.CreatedTimestamp"]
    set EmailAddress [CkJsonObject_stringOf $jResp "Comments[i].Contributor.EmailAddress"]
    set GivenName [CkJsonObject_stringOf $jResp "Comments[i].Contributor.GivenName"]
    set Id [CkJsonObject_stringOf $jResp "Comments[i].Contributor.Id"]
    set Locale [CkJsonObject_stringOf $jResp "Comments[i].Contributor.Locale"]
    set ModifiedTimestamp [CkJsonObject_IntOf $jResp "Comments[i].Contributor.ModifiedTimestamp"]
    set OrganizationId [CkJsonObject_stringOf $jResp "Comments[i].Contributor.OrganizationId"]
    set RecycleBinFolderId [CkJsonObject_stringOf $jResp "Comments[i].Contributor.RecycleBinFolderId"]
    set RootFolderId [CkJsonObject_stringOf $jResp "Comments[i].Contributor.RootFolderId"]
    set Status [CkJsonObject_stringOf $jResp "Comments[i].Contributor.Status"]
    set StorageAllocatedInBytes [CkJsonObject_IntOf $jResp "Comments[i].Contributor.Storage.StorageRule.StorageAllocatedInBytes"]
    set StorageType [CkJsonObject_stringOf $jResp "Comments[i].Contributor.Storage.StorageRule.StorageType"]
    set StorageUtilizedInBytes [CkJsonObject_IntOf $jResp "Comments[i].Contributor.Storage.StorageUtilizedInBytes"]
    set Surname [CkJsonObject_stringOf $jResp "Comments[i].Contributor.Surname"]
    set TimeZoneId [CkJsonObject_stringOf $jResp "Comments[i].Contributor.TimeZoneId"]
    set v_Type [CkJsonObject_stringOf $jResp "Comments[i].Contributor.Type"]
    set Username [CkJsonObject_stringOf $jResp "Comments[i].Contributor.Username"]
    set CreatedTimestamp [CkJsonObject_IntOf $jResp "Comments[i].CreatedTimestamp"]
    set ParentId [CkJsonObject_stringOf $jResp "Comments[i].ParentId"]
    set RecipientId [CkJsonObject_stringOf $jResp "Comments[i].RecipientId"]
    set Status [CkJsonObject_stringOf $jResp "Comments[i].Status"]
    set Text [CkJsonObject_stringOf $jResp "Comments[i].Text"]
    set ThreadId [CkJsonObject_stringOf $jResp "Comments[i].ThreadId"]
    set Visibility [CkJsonObject_stringOf $jResp "Comments[i].Visibility"]
    set i [expr $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"
# }

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp