Chilkat Online Tools

CreateComment 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
}

# The following code creates the JSON request body.
# The JSON created by this code is shown below.

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

set json [new_CkJsonObject]

CkJsonObject_UpdateInt $json "NotifyCollaborators" 123
CkJsonObject_UpdateString $json "ParentId" "string"
CkJsonObject_UpdateString $json "Text" "string"
CkJsonObject_UpdateString $json "ThreadId" "string"
CkJsonObject_UpdateString $json "Visibility" "string"

# The JSON request body created by the above code:

# {
#   "NotifyCollaborators": boolean,
#   "ParentId": "string",
#   "Text": "string",
#   "ThreadId": "string",
#   "Visibility": "string"
# }

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

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestSb $rest "POST" "/api/v1/documents/{DocumentId}/versions/{VersionId}/comment" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    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_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    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 CommentId [CkJsonObject_stringOf $jResp "Comment.CommentId"]
set CreatedTimestamp [CkJsonObject_IntOf $jResp "Comment.Contributor.CreatedTimestamp"]
set EmailAddress [CkJsonObject_stringOf $jResp "Comment.Contributor.EmailAddress"]
set GivenName [CkJsonObject_stringOf $jResp "Comment.Contributor.GivenName"]
set Id [CkJsonObject_stringOf $jResp "Comment.Contributor.Id"]
set Locale [CkJsonObject_stringOf $jResp "Comment.Contributor.Locale"]
set ModifiedTimestamp [CkJsonObject_IntOf $jResp "Comment.Contributor.ModifiedTimestamp"]
set OrganizationId [CkJsonObject_stringOf $jResp "Comment.Contributor.OrganizationId"]
set RecycleBinFolderId [CkJsonObject_stringOf $jResp "Comment.Contributor.RecycleBinFolderId"]
set RootFolderId [CkJsonObject_stringOf $jResp "Comment.Contributor.RootFolderId"]
set Status [CkJsonObject_stringOf $jResp "Comment.Contributor.Status"]
set StorageAllocatedInBytes [CkJsonObject_IntOf $jResp "Comment.Contributor.Storage.StorageRule.StorageAllocatedInBytes"]
set StorageType [CkJsonObject_stringOf $jResp "Comment.Contributor.Storage.StorageRule.StorageType"]
set StorageUtilizedInBytes [CkJsonObject_IntOf $jResp "Comment.Contributor.Storage.StorageUtilizedInBytes"]
set Surname [CkJsonObject_stringOf $jResp "Comment.Contributor.Surname"]
set TimeZoneId [CkJsonObject_stringOf $jResp "Comment.Contributor.TimeZoneId"]
set v_Type [CkJsonObject_stringOf $jResp "Comment.Contributor.Type"]
set Username [CkJsonObject_stringOf $jResp "Comment.Contributor.Username"]
set CommentCreatedTimestamp [CkJsonObject_IntOf $jResp "Comment.CreatedTimestamp"]
set ParentId [CkJsonObject_stringOf $jResp "Comment.ParentId"]
set RecipientId [CkJsonObject_stringOf $jResp "Comment.RecipientId"]
set CommentStatus [CkJsonObject_stringOf $jResp "Comment.Status"]
set Text [CkJsonObject_stringOf $jResp "Comment.Text"]
set ThreadId [CkJsonObject_stringOf $jResp "Comment.ThreadId"]
set Visibility [CkJsonObject_stringOf $jResp "Comment.Visibility"]

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

# {
#   "Comment": {
#     "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"
#   }
# }

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