Chilkat Online Tools

TCL / Support API / Show Activity

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"

CkHttp_SetRequestHeader $http "Accept" "application/json"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://example.zendesk.com/api/v2/activities/:activity_id" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "activity": {
#     "actor": {
#       "name": "<string>",
#       "active": "<boolean>",
#       "alias": "<string>",
#       "chat_only": "<boolean>",
#       "created_at": "<string>",
#       "custom_role_id": "<integer>",
#       "default_group_id": "<integer>",
#       "details": "<string>",
#       "email": "<string>",
#       "external_id": "<string>",
#       "iana_time_zone": "<string>",
#       "id": "<integer>",
#       "last_login_at": "<string>",
#       "locale": "<string>",
#       "locale_id": "<integer>",
#       "moderator": "<boolean>",
#       "notes": "<string>",
#       "only_private_comments": "<boolean>",
#       "organization_id": "<integer>",
#       "phone": "<string>",
#       "photo": {
#         "laborum485": "cupidatat occaecat sed esse deserunt",
#         "incididuntfe4": "ut esse dolor dolore adipisicing",
#         "ipsum_d": false,
#         "non_4a": 96148739
#       },
#       "remote_photo_url": "<string>",
#       "report_csv": "<boolean>",
#       "restricted_agent": "<boolean>",
#       "role": "<string>",
#       "role_type": "<integer>",
#       "shared": "<boolean>",
#       "shared_agent": "<boolean>",
#       "shared_phone_number": "<boolean>",
#       "signature": "<string>",
#       "suspended": "<boolean>",
#       "tags": "<array>",
#       "ticket_restriction": "<string>",
#       "time_zone": "<string>",
#       "two_factor_auth_enabled": "<boolean>",
#       "updated_at": "<string>",
#       "url": "<string>",
#       "user_fields": {
#         "aute_e0": false,
#         "quis02": 59243202
#       },
#       "verified": "<boolean>"
#     },
#     "actor_id": "<integer>",
#     "created_at": "<string>",
#     "id": "<integer>",
#     "object": {
#       "consequatf61": 91186207,
#       "labore__6": true
#     },
#     "target": {
#       "anim_f0": 93298900,
#       "deserunt_fb": -19031432.480811536
#     },
#     "title": "<string>",
#     "updated_at": "<string>",
#     "url": "<string>",
#     "user": {
#       "name": "<string>",
#       "active": "<boolean>",
#       "alias": "<string>",
#       "chat_only": "<boolean>",
#       "created_at": "<string>",
#       "custom_role_id": "<integer>",
#       "default_group_id": "<integer>",
#       "details": "<string>",
#       "email": "<string>",
#       "external_id": "<string>",
#       "iana_time_zone": "<string>",
#       "id": "<integer>",
#       "last_login_at": "<string>",
#       "locale": "<string>",
#       "locale_id": "<integer>",
#       "moderator": "<boolean>",
#       "notes": "<string>",
#       "only_private_comments": "<boolean>",
#       "organization_id": "<integer>",
#       "phone": "<string>",
#       "photo": {
#         "velit_d": false,
#         "nulla68_": -89946385,
#         "elit1": "id commodo cu"
#       },
#       "remote_photo_url": "<string>",
#       "report_csv": "<boolean>",
#       "restricted_agent": "<boolean>",
#       "role": "<string>",
#       "role_type": "<integer>",
#       "shared": "<boolean>",
#       "shared_agent": "<boolean>",
#       "shared_phone_number": "<boolean>",
#       "signature": "<string>",
#       "suspended": "<boolean>",
#       "tags": "<array>",
#       "ticket_restriction": "<string>",
#       "time_zone": "<string>",
#       "two_factor_auth_enabled": "<boolean>",
#       "updated_at": "<string>",
#       "url": "<string>",
#       "user_fields": {
#         "dolor_c26": 36781242,
#         "elit891": -33618800.11537988,
#         "amet8": "consectetur"
#       },
#       "verified": "<boolean>"
#     },
#     "user_id": "<integer>",
#     "verb": "<string>"
#   }
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

set Name [CkJsonObject_stringOf $jResp "activity.actor.name"]
set Active [CkJsonObject_stringOf $jResp "activity.actor.active"]
set Alias [CkJsonObject_stringOf $jResp "activity.actor.alias"]
set Chat_only [CkJsonObject_stringOf $jResp "activity.actor.chat_only"]
set Created_at [CkJsonObject_stringOf $jResp "activity.actor.created_at"]
set Custom_role_id [CkJsonObject_stringOf $jResp "activity.actor.custom_role_id"]
set Default_group_id [CkJsonObject_stringOf $jResp "activity.actor.default_group_id"]
set Details [CkJsonObject_stringOf $jResp "activity.actor.details"]
set v_Email [CkJsonObject_stringOf $jResp "activity.actor.email"]
set External_id [CkJsonObject_stringOf $jResp "activity.actor.external_id"]
set Iana_time_zone [CkJsonObject_stringOf $jResp "activity.actor.iana_time_zone"]
set Id [CkJsonObject_stringOf $jResp "activity.actor.id"]
set Last_login_at [CkJsonObject_stringOf $jResp "activity.actor.last_login_at"]
set Locale [CkJsonObject_stringOf $jResp "activity.actor.locale"]
set Locale_id [CkJsonObject_stringOf $jResp "activity.actor.locale_id"]
set Moderator [CkJsonObject_stringOf $jResp "activity.actor.moderator"]
set Notes [CkJsonObject_stringOf $jResp "activity.actor.notes"]
set Only_private_comments [CkJsonObject_stringOf $jResp "activity.actor.only_private_comments"]
set Organization_id [CkJsonObject_stringOf $jResp "activity.actor.organization_id"]
set Phone [CkJsonObject_stringOf $jResp "activity.actor.phone"]
set Laborum485 [CkJsonObject_stringOf $jResp "activity.actor.photo.laborum485"]
set Incididuntfe4 [CkJsonObject_stringOf $jResp "activity.actor.photo.incididuntfe4"]
set Ipsum_d [CkJsonObject_BoolOf $jResp "activity.actor.photo.ipsum_d"]
set Non_4a [CkJsonObject_IntOf $jResp "activity.actor.photo.non_4a"]
set Remote_photo_url [CkJsonObject_stringOf $jResp "activity.actor.remote_photo_url"]
set Report_csv [CkJsonObject_stringOf $jResp "activity.actor.report_csv"]
set Restricted_agent [CkJsonObject_stringOf $jResp "activity.actor.restricted_agent"]
set Role [CkJsonObject_stringOf $jResp "activity.actor.role"]
set Role_type [CkJsonObject_stringOf $jResp "activity.actor.role_type"]
set v_Shared [CkJsonObject_stringOf $jResp "activity.actor.shared"]
set Shared_agent [CkJsonObject_stringOf $jResp "activity.actor.shared_agent"]
set Shared_phone_number [CkJsonObject_stringOf $jResp "activity.actor.shared_phone_number"]
set Signature [CkJsonObject_stringOf $jResp "activity.actor.signature"]
set Suspended [CkJsonObject_stringOf $jResp "activity.actor.suspended"]
set Tags [CkJsonObject_stringOf $jResp "activity.actor.tags"]
set Ticket_restriction [CkJsonObject_stringOf $jResp "activity.actor.ticket_restriction"]
set Time_zone [CkJsonObject_stringOf $jResp "activity.actor.time_zone"]
set Two_factor_auth_enabled [CkJsonObject_stringOf $jResp "activity.actor.two_factor_auth_enabled"]
set Updated_at [CkJsonObject_stringOf $jResp "activity.actor.updated_at"]
set v_Url [CkJsonObject_stringOf $jResp "activity.actor.url"]
set Aute_e0 [CkJsonObject_BoolOf $jResp "activity.actor.user_fields.aute_e0"]
set Quis02 [CkJsonObject_IntOf $jResp "activity.actor.user_fields.quis02"]
set Verified [CkJsonObject_stringOf $jResp "activity.actor.verified"]
set Actor_id [CkJsonObject_stringOf $jResp "activity.actor_id"]
set activityCreated_at [CkJsonObject_stringOf $jResp "activity.created_at"]
set activityId [CkJsonObject_stringOf $jResp "activity.id"]
set Consequatf61 [CkJsonObject_IntOf $jResp "activity.object.consequatf61"]
set Labore__6 [CkJsonObject_BoolOf $jResp "activity.object.labore__6"]
set Anim_f0 [CkJsonObject_IntOf $jResp "activity.target.anim_f0"]
set Deserunt_fb [CkJsonObject_stringOf $jResp "activity.target.deserunt_fb"]
set Title [CkJsonObject_stringOf $jResp "activity.title"]
set activityUpdated_at [CkJsonObject_stringOf $jResp "activity.updated_at"]
set activityUrl [CkJsonObject_stringOf $jResp "activity.url"]
set UserName [CkJsonObject_stringOf $jResp "activity.user.name"]
set UserActive [CkJsonObject_stringOf $jResp "activity.user.active"]
set UserAlias [CkJsonObject_stringOf $jResp "activity.user.alias"]
set UserChat_only [CkJsonObject_stringOf $jResp "activity.user.chat_only"]
set UserCreated_at [CkJsonObject_stringOf $jResp "activity.user.created_at"]
set UserCustom_role_id [CkJsonObject_stringOf $jResp "activity.user.custom_role_id"]
set UserDefault_group_id [CkJsonObject_stringOf $jResp "activity.user.default_group_id"]
set UserDetails [CkJsonObject_stringOf $jResp "activity.user.details"]
set UserEmail [CkJsonObject_stringOf $jResp "activity.user.email"]
set UserExternal_id [CkJsonObject_stringOf $jResp "activity.user.external_id"]
set UserIana_time_zone [CkJsonObject_stringOf $jResp "activity.user.iana_time_zone"]
set UserId [CkJsonObject_stringOf $jResp "activity.user.id"]
set UserLast_login_at [CkJsonObject_stringOf $jResp "activity.user.last_login_at"]
set UserLocale [CkJsonObject_stringOf $jResp "activity.user.locale"]
set UserLocale_id [CkJsonObject_stringOf $jResp "activity.user.locale_id"]
set UserModerator [CkJsonObject_stringOf $jResp "activity.user.moderator"]
set UserNotes [CkJsonObject_stringOf $jResp "activity.user.notes"]
set UserOnly_private_comments [CkJsonObject_stringOf $jResp "activity.user.only_private_comments"]
set UserOrganization_id [CkJsonObject_stringOf $jResp "activity.user.organization_id"]
set UserPhone [CkJsonObject_stringOf $jResp "activity.user.phone"]
set Velit_d [CkJsonObject_BoolOf $jResp "activity.user.photo.velit_d"]
set Nulla68_ [CkJsonObject_IntOf $jResp "activity.user.photo.nulla68_"]
set Elit1 [CkJsonObject_stringOf $jResp "activity.user.photo.elit1"]
set UserRemote_photo_url [CkJsonObject_stringOf $jResp "activity.user.remote_photo_url"]
set UserReport_csv [CkJsonObject_stringOf $jResp "activity.user.report_csv"]
set UserRestricted_agent [CkJsonObject_stringOf $jResp "activity.user.restricted_agent"]
set UserRole [CkJsonObject_stringOf $jResp "activity.user.role"]
set UserRole_type [CkJsonObject_stringOf $jResp "activity.user.role_type"]
set UserShared [CkJsonObject_stringOf $jResp "activity.user.shared"]
set UserShared_agent [CkJsonObject_stringOf $jResp "activity.user.shared_agent"]
set UserShared_phone_number [CkJsonObject_stringOf $jResp "activity.user.shared_phone_number"]
set UserSignature [CkJsonObject_stringOf $jResp "activity.user.signature"]
set UserSuspended [CkJsonObject_stringOf $jResp "activity.user.suspended"]
set UserTags [CkJsonObject_stringOf $jResp "activity.user.tags"]
set UserTicket_restriction [CkJsonObject_stringOf $jResp "activity.user.ticket_restriction"]
set UserTime_zone [CkJsonObject_stringOf $jResp "activity.user.time_zone"]
set UserTwo_factor_auth_enabled [CkJsonObject_stringOf $jResp "activity.user.two_factor_auth_enabled"]
set UserUpdated_at [CkJsonObject_stringOf $jResp "activity.user.updated_at"]
set UserUrl [CkJsonObject_stringOf $jResp "activity.user.url"]
set Dolor_c26 [CkJsonObject_IntOf $jResp "activity.user.user_fields.dolor_c26"]
set Elit891 [CkJsonObject_stringOf $jResp "activity.user.user_fields.elit891"]
set Amet8 [CkJsonObject_stringOf $jResp "activity.user.user_fields.amet8"]
set UserVerified [CkJsonObject_stringOf $jResp "activity.user.verified"]
set User_id [CkJsonObject_stringOf $jResp "activity.user_id"]
set Verb [CkJsonObject_stringOf $jResp "activity.verb"]

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/activities/:activity_id

Postman Collection Item JSON

{
  "name": "Show Activity",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/activities/:activity_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "activities",
        ":activity_id"
      ],
      "variable": [
        {
          "key": "activity_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Lists a specific activity.\n\n#### Allowed For\n\n* Agents\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/activities/:activity_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "activities",
            ":activity_id"
          ],
          "variable": [
            {
              "key": "activity_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"activity\": {\n    \"actor\": {\n      \"name\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"alias\": \"<string>\",\n      \"chat_only\": \"<boolean>\",\n      \"created_at\": \"<string>\",\n      \"custom_role_id\": \"<integer>\",\n      \"default_group_id\": \"<integer>\",\n      \"details\": \"<string>\",\n      \"email\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"iana_time_zone\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"last_login_at\": \"<string>\",\n      \"locale\": \"<string>\",\n      \"locale_id\": \"<integer>\",\n      \"moderator\": \"<boolean>\",\n      \"notes\": \"<string>\",\n      \"only_private_comments\": \"<boolean>\",\n      \"organization_id\": \"<integer>\",\n      \"phone\": \"<string>\",\n      \"photo\": {\n        \"laborum485\": \"cupidatat occaecat sed esse deserunt\",\n        \"incididuntfe4\": \"ut esse dolor dolore adipisicing\",\n        \"ipsum_d\": false,\n        \"non_4a\": 96148739\n      },\n      \"remote_photo_url\": \"<string>\",\n      \"report_csv\": \"<boolean>\",\n      \"restricted_agent\": \"<boolean>\",\n      \"role\": \"<string>\",\n      \"role_type\": \"<integer>\",\n      \"shared\": \"<boolean>\",\n      \"shared_agent\": \"<boolean>\",\n      \"shared_phone_number\": \"<boolean>\",\n      \"signature\": \"<string>\",\n      \"suspended\": \"<boolean>\",\n      \"tags\": \"<array>\",\n      \"ticket_restriction\": \"<string>\",\n      \"time_zone\": \"<string>\",\n      \"two_factor_auth_enabled\": \"<boolean>\",\n      \"updated_at\": \"<string>\",\n      \"url\": \"<string>\",\n      \"user_fields\": {\n        \"aute_e0\": false,\n        \"quis02\": 59243202\n      },\n      \"verified\": \"<boolean>\"\n    },\n    \"actor_id\": \"<integer>\",\n    \"created_at\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"object\": {\n      \"consequatf61\": 91186207,\n      \"labore__6\": true\n    },\n    \"target\": {\n      \"anim_f0\": 93298900,\n      \"deserunt_fb\": -19031432.480811536\n    },\n    \"title\": \"<string>\",\n    \"updated_at\": \"<string>\",\n    \"url\": \"<string>\",\n    \"user\": {\n      \"name\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"alias\": \"<string>\",\n      \"chat_only\": \"<boolean>\",\n      \"created_at\": \"<string>\",\n      \"custom_role_id\": \"<integer>\",\n      \"default_group_id\": \"<integer>\",\n      \"details\": \"<string>\",\n      \"email\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"iana_time_zone\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"last_login_at\": \"<string>\",\n      \"locale\": \"<string>\",\n      \"locale_id\": \"<integer>\",\n      \"moderator\": \"<boolean>\",\n      \"notes\": \"<string>\",\n      \"only_private_comments\": \"<boolean>\",\n      \"organization_id\": \"<integer>\",\n      \"phone\": \"<string>\",\n      \"photo\": {\n        \"velit_d\": false,\n        \"nulla68_\": -89946385,\n        \"elit1\": \"id commodo cu\"\n      },\n      \"remote_photo_url\": \"<string>\",\n      \"report_csv\": \"<boolean>\",\n      \"restricted_agent\": \"<boolean>\",\n      \"role\": \"<string>\",\n      \"role_type\": \"<integer>\",\n      \"shared\": \"<boolean>\",\n      \"shared_agent\": \"<boolean>\",\n      \"shared_phone_number\": \"<boolean>\",\n      \"signature\": \"<string>\",\n      \"suspended\": \"<boolean>\",\n      \"tags\": \"<array>\",\n      \"ticket_restriction\": \"<string>\",\n      \"time_zone\": \"<string>\",\n      \"two_factor_auth_enabled\": \"<boolean>\",\n      \"updated_at\": \"<string>\",\n      \"url\": \"<string>\",\n      \"user_fields\": {\n        \"dolor_c26\": 36781242,\n        \"elit891\": -33618800.11537988,\n        \"amet8\": \"consectetur\"\n      },\n      \"verified\": \"<boolean>\"\n    },\n    \"user_id\": \"<integer>\",\n    \"verb\": \"<string>\"\n  }\n}"
    }
  ]
}