Chilkat Online Tools

CreateComment Ruby Example

Amazon WorkDocs

require 'chilkat'

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

rest = Chilkat::CkRest.new()

authAws = Chilkat::CkAuthAws.new()
authAws.put_AccessKey("AWS_ACCESS_KEY")
authAws.put_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.put_Region("us-west-2")
authAws.put_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 != true)
    print "ConnectFailReason: " + rest.get_ConnectFailReason().to_s() + "\n";
    print rest.lastErrorText() + "\n";
    exit
end

# 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

json = Chilkat::CkJsonObject.new()
json.UpdateInt("NotifyCollaborators",123)
json.UpdateString("ParentId","string")
json.UpdateString("Text","string")
json.UpdateString("ThreadId","string")
json.UpdateString("Visibility","string")

# The JSON request body created by the above code:

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

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

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("POST","/api/v1/documents/{DocumentId}/versions/{VersionId}/comment",sbRequestBody,sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

respStatusCode = rest.get_ResponseStatusCode()
print "response status code = " + respStatusCode.to_s() + "\n";
if (respStatusCode != 200)
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print "Response Body:" + "\n";
    print sbResponseBody.getAsString() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
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

CommentId = jResp.stringOf("Comment.CommentId")
CreatedTimestamp = jResp.IntOf("Comment.Contributor.CreatedTimestamp")
EmailAddress = jResp.stringOf("Comment.Contributor.EmailAddress")
GivenName = jResp.stringOf("Comment.Contributor.GivenName")
Id = jResp.stringOf("Comment.Contributor.Id")
Locale = jResp.stringOf("Comment.Contributor.Locale")
ModifiedTimestamp = jResp.IntOf("Comment.Contributor.ModifiedTimestamp")
OrganizationId = jResp.stringOf("Comment.Contributor.OrganizationId")
RecycleBinFolderId = jResp.stringOf("Comment.Contributor.RecycleBinFolderId")
RootFolderId = jResp.stringOf("Comment.Contributor.RootFolderId")
Status = jResp.stringOf("Comment.Contributor.Status")
StorageAllocatedInBytes = jResp.IntOf("Comment.Contributor.Storage.StorageRule.StorageAllocatedInBytes")
StorageType = jResp.stringOf("Comment.Contributor.Storage.StorageRule.StorageType")
StorageUtilizedInBytes = jResp.IntOf("Comment.Contributor.Storage.StorageUtilizedInBytes")
Surname = jResp.stringOf("Comment.Contributor.Surname")
TimeZoneId = jResp.stringOf("Comment.Contributor.TimeZoneId")
v_Type = jResp.stringOf("Comment.Contributor.Type")
Username = jResp.stringOf("Comment.Contributor.Username")
CommentCreatedTimestamp = jResp.IntOf("Comment.CreatedTimestamp")
ParentId = jResp.stringOf("Comment.ParentId")
RecipientId = jResp.stringOf("Comment.RecipientId")
CommentStatus = jResp.stringOf("Comment.Status")
Text = jResp.stringOf("Comment.Text")
ThreadId = jResp.stringOf("Comment.ThreadId")
Visibility = jResp.stringOf("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"
#   }
# }