Chilkat Online Tools

autoit / Support API / Show Macro

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/macros/:macro_id",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

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

; {
;   "macro": {
;     "actions": [
;       {
;         "field": "<string>",
;         "value": "<string>"
;       },
;       {
;         "field": "<string>",
;         "value": "<string>"
;       }
;     ],
;     "title": "<string>",
;     "active": "<boolean>",
;     "created_at": "<dateTime>",
;     "default": "<boolean>",
;     "description": "<string>",
;     "id": "<integer>",
;     "position": "<integer>",
;     "restriction": {
;       "utc": -57663786.73485631,
;       "sint_c": 56026975.00248328
;     },
;     "updated_at": "<dateTime>",
;     "url": "<string>",
;     "app_installation": "<string>",
;     "categories": "<string>",
;     "permissions": "<string>",
;     "usage_1h": "<integer>",
;     "usage_7d": "<integer>",
;     "usage_24h": "<integer>",
;     "usage_30d": "<integer>"
;   }
; }

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

Local $sField
Local $sValue

Local $sTitle = $oJResp.StringOf("macro.title")
Local $sActive = $oJResp.StringOf("macro.active")
Local $sCreated_at = $oJResp.StringOf("macro.created_at")
Local $sDefault = $oJResp.StringOf("macro.default")
Local $sDescription = $oJResp.StringOf("macro.description")
Local $sId = $oJResp.StringOf("macro.id")
Local $sPosition = $oJResp.StringOf("macro.position")
Local $sUtc = $oJResp.StringOf("macro.restriction.utc")
Local $sSint_c = $oJResp.StringOf("macro.restriction.sint_c")
Local $sUpdated_at = $oJResp.StringOf("macro.updated_at")
Local $sV_Url = $oJResp.StringOf("macro.url")
Local $sApp_installation = $oJResp.StringOf("macro.app_installation")
Local $sCategories = $oJResp.StringOf("macro.categories")
Local $sPermissions = $oJResp.StringOf("macro.permissions")
Local $sUsage_1h = $oJResp.StringOf("macro.usage_1h")
Local $sUsage_7d = $oJResp.StringOf("macro.usage_7d")
Local $sUsage_24h = $oJResp.StringOf("macro.usage_24h")
Local $sUsage_30d = $oJResp.StringOf("macro.usage_30d")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("macro.actions")
While $i < $iCount_i
    $oJResp.I = $i
    $sField = $oJResp.StringOf("macro.actions[i].field")
    $sValue = $oJResp.StringOf("macro.actions[i].value")
    $i = $i + 1
Wend

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show Macro",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/macros/:macro_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "macros",
        ":macro_id"
      ],
      "variable": [
        {
          "key": "macro_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed For\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/macros/:macro_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "macros",
            ":macro_id"
          ],
          "variable": [
            {
              "key": "macro_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"macro\": {\n    \"actions\": [\n      {\n        \"field\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"field\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"title\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"description\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"position\": \"<integer>\",\n    \"restriction\": {\n      \"utc\": -57663786.73485631,\n      \"sint_c\": 56026975.00248328\n    },\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\",\n    \"app_installation\": \"<string>\",\n    \"categories\": \"<string>\",\n    \"permissions\": \"<string>\",\n    \"usage_1h\": \"<integer>\",\n    \"usage_7d\": \"<integer>\",\n    \"usage_24h\": \"<integer>\",\n    \"usage_30d\": \"<integer>\"\n  }\n}"
    }
  ]
}