Powershell / Support API / Show Activity
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$http.BasicAuth = $true
$http.Login = "login"
$http.Password = "password"
$http.SetRequestHeader("Accept","application/json")
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://example.zendesk.com/api/v2/activities/:activity_id",$sbResponseBody)
if ($success -eq $false) {
$($http.LastErrorText)
exit
}
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($http.LastHeader)
$("Failed.")
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
$Name = $jResp.StringOf("activity.actor.name")
$Active = $jResp.StringOf("activity.actor.active")
$Alias = $jResp.StringOf("activity.actor.alias")
$Chat_only = $jResp.StringOf("activity.actor.chat_only")
$Created_at = $jResp.StringOf("activity.actor.created_at")
$Custom_role_id = $jResp.StringOf("activity.actor.custom_role_id")
$Default_group_id = $jResp.StringOf("activity.actor.default_group_id")
$Details = $jResp.StringOf("activity.actor.details")
$v_Email = $jResp.StringOf("activity.actor.email")
$External_id = $jResp.StringOf("activity.actor.external_id")
$Iana_time_zone = $jResp.StringOf("activity.actor.iana_time_zone")
$Id = $jResp.StringOf("activity.actor.id")
$Last_login_at = $jResp.StringOf("activity.actor.last_login_at")
$Locale = $jResp.StringOf("activity.actor.locale")
$Locale_id = $jResp.StringOf("activity.actor.locale_id")
$Moderator = $jResp.StringOf("activity.actor.moderator")
$Notes = $jResp.StringOf("activity.actor.notes")
$Only_private_comments = $jResp.StringOf("activity.actor.only_private_comments")
$Organization_id = $jResp.StringOf("activity.actor.organization_id")
$Phone = $jResp.StringOf("activity.actor.phone")
$Laborum485 = $jResp.StringOf("activity.actor.photo.laborum485")
$Incididuntfe4 = $jResp.StringOf("activity.actor.photo.incididuntfe4")
$Ipsum_d = $jResp.BoolOf("activity.actor.photo.ipsum_d")
$Non_4a = $jResp.IntOf("activity.actor.photo.non_4a")
$Remote_photo_url = $jResp.StringOf("activity.actor.remote_photo_url")
$Report_csv = $jResp.StringOf("activity.actor.report_csv")
$Restricted_agent = $jResp.StringOf("activity.actor.restricted_agent")
$Role = $jResp.StringOf("activity.actor.role")
$Role_type = $jResp.StringOf("activity.actor.role_type")
$v_Shared = $jResp.StringOf("activity.actor.shared")
$Shared_agent = $jResp.StringOf("activity.actor.shared_agent")
$Shared_phone_number = $jResp.StringOf("activity.actor.shared_phone_number")
$Signature = $jResp.StringOf("activity.actor.signature")
$Suspended = $jResp.StringOf("activity.actor.suspended")
$Tags = $jResp.StringOf("activity.actor.tags")
$Ticket_restriction = $jResp.StringOf("activity.actor.ticket_restriction")
$Time_zone = $jResp.StringOf("activity.actor.time_zone")
$Two_factor_auth_enabled = $jResp.StringOf("activity.actor.two_factor_auth_enabled")
$Updated_at = $jResp.StringOf("activity.actor.updated_at")
$v_Url = $jResp.StringOf("activity.actor.url")
$Aute_e0 = $jResp.BoolOf("activity.actor.user_fields.aute_e0")
$Quis02 = $jResp.IntOf("activity.actor.user_fields.quis02")
$Verified = $jResp.StringOf("activity.actor.verified")
$Actor_id = $jResp.StringOf("activity.actor_id")
$activityCreated_at = $jResp.StringOf("activity.created_at")
$activityId = $jResp.StringOf("activity.id")
$Consequatf61 = $jResp.IntOf("activity.object.consequatf61")
$Labore__6 = $jResp.BoolOf("activity.object.labore__6")
$Anim_f0 = $jResp.IntOf("activity.target.anim_f0")
$Deserunt_fb = $jResp.StringOf("activity.target.deserunt_fb")
$Title = $jResp.StringOf("activity.title")
$activityUpdated_at = $jResp.StringOf("activity.updated_at")
$activityUrl = $jResp.StringOf("activity.url")
$UserName = $jResp.StringOf("activity.user.name")
$UserActive = $jResp.StringOf("activity.user.active")
$UserAlias = $jResp.StringOf("activity.user.alias")
$UserChat_only = $jResp.StringOf("activity.user.chat_only")
$UserCreated_at = $jResp.StringOf("activity.user.created_at")
$UserCustom_role_id = $jResp.StringOf("activity.user.custom_role_id")
$UserDefault_group_id = $jResp.StringOf("activity.user.default_group_id")
$UserDetails = $jResp.StringOf("activity.user.details")
$UserEmail = $jResp.StringOf("activity.user.email")
$UserExternal_id = $jResp.StringOf("activity.user.external_id")
$UserIana_time_zone = $jResp.StringOf("activity.user.iana_time_zone")
$UserId = $jResp.StringOf("activity.user.id")
$UserLast_login_at = $jResp.StringOf("activity.user.last_login_at")
$UserLocale = $jResp.StringOf("activity.user.locale")
$UserLocale_id = $jResp.StringOf("activity.user.locale_id")
$UserModerator = $jResp.StringOf("activity.user.moderator")
$UserNotes = $jResp.StringOf("activity.user.notes")
$UserOnly_private_comments = $jResp.StringOf("activity.user.only_private_comments")
$UserOrganization_id = $jResp.StringOf("activity.user.organization_id")
$UserPhone = $jResp.StringOf("activity.user.phone")
$Velit_d = $jResp.BoolOf("activity.user.photo.velit_d")
$Nulla68_ = $jResp.IntOf("activity.user.photo.nulla68_")
$Elit1 = $jResp.StringOf("activity.user.photo.elit1")
$UserRemote_photo_url = $jResp.StringOf("activity.user.remote_photo_url")
$UserReport_csv = $jResp.StringOf("activity.user.report_csv")
$UserRestricted_agent = $jResp.StringOf("activity.user.restricted_agent")
$UserRole = $jResp.StringOf("activity.user.role")
$UserRole_type = $jResp.StringOf("activity.user.role_type")
$UserShared = $jResp.StringOf("activity.user.shared")
$UserShared_agent = $jResp.StringOf("activity.user.shared_agent")
$UserShared_phone_number = $jResp.StringOf("activity.user.shared_phone_number")
$UserSignature = $jResp.StringOf("activity.user.signature")
$UserSuspended = $jResp.StringOf("activity.user.suspended")
$UserTags = $jResp.StringOf("activity.user.tags")
$UserTicket_restriction = $jResp.StringOf("activity.user.ticket_restriction")
$UserTime_zone = $jResp.StringOf("activity.user.time_zone")
$UserTwo_factor_auth_enabled = $jResp.StringOf("activity.user.two_factor_auth_enabled")
$UserUpdated_at = $jResp.StringOf("activity.user.updated_at")
$UserUrl = $jResp.StringOf("activity.user.url")
$Dolor_c26 = $jResp.IntOf("activity.user.user_fields.dolor_c26")
$Elit891 = $jResp.StringOf("activity.user.user_fields.elit891")
$Amet8 = $jResp.StringOf("activity.user.user_fields.amet8")
$UserVerified = $jResp.StringOf("activity.user.verified")
$User_id = $jResp.StringOf("activity.user_id")
$Verb = $jResp.StringOf("activity.verb")
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}"
}
]
}
