DescribeActivities TCL Example
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" "DescribeActivities"
set sbResponseBody [new_CkStringBuilder]
set success [CkRest_FullRequestNoBodySb $rest "GET" "/api/v1/activities" $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 "UserActivities"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set CommentId [CkJsonObject_stringOf $jResp "UserActivities[i].CommentMetadata.CommentId"]
set CommentStatus [CkJsonObject_stringOf $jResp "UserActivities[i].CommentMetadata.CommentStatus"]
set CreatedTimestamp [CkJsonObject_IntOf $jResp "UserActivities[i].CommentMetadata.Contributor.CreatedTimestamp"]
set EmailAddress [CkJsonObject_stringOf $jResp "UserActivities[i].CommentMetadata.Contributor.EmailAddress"]
set GivenName [CkJsonObject_stringOf $jResp "UserActivities[i].CommentMetadata.Contributor.GivenName"]
set Id [CkJsonObject_stringOf $jResp "UserActivities[i].CommentMetadata.Contributor.Id"]
set Locale [CkJsonObject_stringOf $jResp "UserActivities[i].CommentMetadata.Contributor.Locale"]
set ModifiedTimestamp [CkJsonObject_IntOf $jResp "UserActivities[i].CommentMetadata.Contributor.ModifiedTimestamp"]
set OrganizationId [CkJsonObject_stringOf $jResp "UserActivities[i].CommentMetadata.Contributor.OrganizationId"]
set RecycleBinFolderId [CkJsonObject_stringOf $jResp "UserActivities[i].CommentMetadata.Contributor.RecycleBinFolderId"]
set RootFolderId [CkJsonObject_stringOf $jResp "UserActivities[i].CommentMetadata.Contributor.RootFolderId"]
set Status [CkJsonObject_stringOf $jResp "UserActivities[i].CommentMetadata.Contributor.Status"]
set StorageAllocatedInBytes [CkJsonObject_IntOf $jResp "UserActivities[i].CommentMetadata.Contributor.Storage.StorageRule.StorageAllocatedInBytes"]
set StorageType [CkJsonObject_stringOf $jResp "UserActivities[i].CommentMetadata.Contributor.Storage.StorageRule.StorageType"]
set StorageUtilizedInBytes [CkJsonObject_IntOf $jResp "UserActivities[i].CommentMetadata.Contributor.Storage.StorageUtilizedInBytes"]
set Surname [CkJsonObject_stringOf $jResp "UserActivities[i].CommentMetadata.Contributor.Surname"]
set TimeZoneId [CkJsonObject_stringOf $jResp "UserActivities[i].CommentMetadata.Contributor.TimeZoneId"]
set v_Type [CkJsonObject_stringOf $jResp "UserActivities[i].CommentMetadata.Contributor.Type"]
set Username [CkJsonObject_stringOf $jResp "UserActivities[i].CommentMetadata.Contributor.Username"]
set CommentMetadataCreatedTimestamp [CkJsonObject_IntOf $jResp "UserActivities[i].CommentMetadata.CreatedTimestamp"]
set RecipientId [CkJsonObject_stringOf $jResp "UserActivities[i].CommentMetadata.RecipientId"]
set InitiatorEmailAddress [CkJsonObject_stringOf $jResp "UserActivities[i].Initiator.EmailAddress"]
set InitiatorGivenName [CkJsonObject_stringOf $jResp "UserActivities[i].Initiator.GivenName"]
set InitiatorId [CkJsonObject_stringOf $jResp "UserActivities[i].Initiator.Id"]
set InitiatorSurname [CkJsonObject_stringOf $jResp "UserActivities[i].Initiator.Surname"]
set InitiatorUsername [CkJsonObject_stringOf $jResp "UserActivities[i].Initiator.Username"]
set IsIndirectActivity [CkJsonObject_IntOf $jResp "UserActivities[i].IsIndirectActivity"]
set OrganizationId [CkJsonObject_stringOf $jResp "UserActivities[i].OrganizationId"]
set OriginalParentId [CkJsonObject_stringOf $jResp "UserActivities[i].OriginalParent.Id"]
set Name [CkJsonObject_stringOf $jResp "UserActivities[i].OriginalParent.Name"]
set OriginalName [CkJsonObject_stringOf $jResp "UserActivities[i].OriginalParent.OriginalName"]
set OwnerEmailAddress [CkJsonObject_stringOf $jResp "UserActivities[i].OriginalParent.Owner.EmailAddress"]
set OwnerGivenName [CkJsonObject_stringOf $jResp "UserActivities[i].OriginalParent.Owner.GivenName"]
set OwnerId [CkJsonObject_stringOf $jResp "UserActivities[i].OriginalParent.Owner.Id"]
set OwnerSurname [CkJsonObject_stringOf $jResp "UserActivities[i].OriginalParent.Owner.Surname"]
set OwnerUsername [CkJsonObject_stringOf $jResp "UserActivities[i].OriginalParent.Owner.Username"]
set ParentId [CkJsonObject_stringOf $jResp "UserActivities[i].OriginalParent.ParentId"]
set OriginalParentType [CkJsonObject_stringOf $jResp "UserActivities[i].OriginalParent.Type"]
set VersionId [CkJsonObject_stringOf $jResp "UserActivities[i].OriginalParent.VersionId"]
set ResourceMetadataId [CkJsonObject_stringOf $jResp "UserActivities[i].ResourceMetadata.Id"]
set ResourceMetadataName [CkJsonObject_stringOf $jResp "UserActivities[i].ResourceMetadata.Name"]
set ResourceMetadataOriginalName [CkJsonObject_stringOf $jResp "UserActivities[i].ResourceMetadata.OriginalName"]
set OwnerEmailAddress [CkJsonObject_stringOf $jResp "UserActivities[i].ResourceMetadata.Owner.EmailAddress"]
set OwnerGivenName [CkJsonObject_stringOf $jResp "UserActivities[i].ResourceMetadata.Owner.GivenName"]
set OwnerId [CkJsonObject_stringOf $jResp "UserActivities[i].ResourceMetadata.Owner.Id"]
set OwnerSurname [CkJsonObject_stringOf $jResp "UserActivities[i].ResourceMetadata.Owner.Surname"]
set OwnerUsername [CkJsonObject_stringOf $jResp "UserActivities[i].ResourceMetadata.Owner.Username"]
set ResourceMetadataParentId [CkJsonObject_stringOf $jResp "UserActivities[i].ResourceMetadata.ParentId"]
set ResourceMetadataType [CkJsonObject_stringOf $jResp "UserActivities[i].ResourceMetadata.Type"]
set ResourceMetadataVersionId [CkJsonObject_stringOf $jResp "UserActivities[i].ResourceMetadata.VersionId"]
set TimeStamp [CkJsonObject_IntOf $jResp "UserActivities[i].TimeStamp"]
set v_Type [CkJsonObject_stringOf $jResp "UserActivities[i].Type"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "UserActivities[i].Participants.Groups"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set Id [CkJsonObject_stringOf $jResp "UserActivities[i].Participants.Groups[j].Id"]
set Name [CkJsonObject_stringOf $jResp "UserActivities[i].Participants.Groups[j].Name"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "UserActivities[i].Participants.Users"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set EmailAddress [CkJsonObject_stringOf $jResp "UserActivities[i].Participants.Users[j].EmailAddress"]
set GivenName [CkJsonObject_stringOf $jResp "UserActivities[i].Participants.Users[j].GivenName"]
set Id [CkJsonObject_stringOf $jResp "UserActivities[i].Participants.Users[j].Id"]
set Surname [CkJsonObject_stringOf $jResp "UserActivities[i].Participants.Users[j].Surname"]
set Username [CkJsonObject_stringOf $jResp "UserActivities[i].Participants.Users[j].Username"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
# A sample JSON response body parsed by the above code:
# {
# "Marker": "string",
# "UserActivities": [
# {
# "CommentMetadata": {
# "CommentId": "string",
# "CommentStatus": "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,
# "RecipientId": "string"
# },
# "Initiator": {
# "EmailAddress": "string",
# "GivenName": "string",
# "Id": "string",
# "Surname": "string",
# "Username": "string"
# },
# "IsIndirectActivity": boolean,
# "OrganizationId": "string",
# "OriginalParent": {
# "Id": "string",
# "Name": "string",
# "OriginalName": "string",
# "Owner": {
# "EmailAddress": "string",
# "GivenName": "string",
# "Id": "string",
# "Surname": "string",
# "Username": "string"
# },
# "ParentId": "string",
# "Type": "string",
# "VersionId": "string"
# },
# "Participants": {
# "Groups": [
# {
# "Id": "string",
# "Name": "string"
# }
# ],
# "Users": [
# {
# "EmailAddress": "string",
# "GivenName": "string",
# "Id": "string",
# "Surname": "string",
# "Username": "string"
# }
# ]
# },
# "ResourceMetadata": {
# "Id": "string",
# "Name": "string",
# "OriginalName": "string",
# "Owner": {
# "EmailAddress": "string",
# "GivenName": "string",
# "Id": "string",
# "Surname": "string",
# "Username": "string"
# },
# "ParentId": "string",
# "Type": "string",
# "VersionId": "string"
# },
# "TimeStamp": number,
# "Type": "string"
# }
# ]
# }
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp