Chilkat Online Tools

autoit / Support API / List Routing Attribute Definitions

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/routing/attributes/definitions",$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)

; {
;   "definitions": {
;     "type": "object",
;     "properties": {
;       "conditions_all": {
;         "type": "array",
;         "items": {
;           "type": "object",
;           "properties": {
;             "subject": {
;               "type": "string",
;               "default": "<string>"
;             },
;             "title": {
;               "type": "string",
;               "default": "<string>"
;             }
;           }
;         },
;         "maxItems": 2
;       },
;       "conditions_any": {
;         "type": "array",
;         "items": {
;           "type": "object",
;           "properties": {
;             "subject": {
;               "type": "string",
;               "default": "<string>"
;             },
;             "title": {
;               "type": "string",
;               "default": "<string>"
;             }
;           }
;         },
;         "maxItems": 2
;       }
;     }
;   }
; }

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

Local $sV_Type = $oJResp.StringOf("definitions.type")
Local $sConditions_allType = $oJResp.StringOf("definitions.properties.conditions_all.type")
Local $sItemsType = $oJResp.StringOf("definitions.properties.conditions_all.items.type")
Local $sSubjectType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.subject.type")
Local $sDefault = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.subject.default")
Local $sTitleType = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.title.type")
Local $sTitleDefault = $oJResp.StringOf("definitions.properties.conditions_all.items.properties.title.default")
Local $iMaxItems = $oJResp.IntOf("definitions.properties.conditions_all.maxItems")
Local $sConditions_anyType = $oJResp.StringOf("definitions.properties.conditions_any.type")
$sItemsType = $oJResp.StringOf("definitions.properties.conditions_any.items.type")
$sSubjectType = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.subject.type")
Local $sSubjectDefault = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.subject.default")
$sTitleType = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.title.type")
$sTitleDefault = $oJResp.StringOf("definitions.properties.conditions_any.items.properties.title.default")
Local $iConditions_anyMaxItems = $oJResp.IntOf("definitions.properties.conditions_any.maxItems")

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Routing Attribute Definitions",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/routing/attributes/definitions",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "routing",
        "attributes",
        "definitions"
      ]
    },
    "description": "Returns the condition definitions that can be configured to apply attributes to a ticket.\n\n#### Allowed For\n\n* Admins\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/routing/attributes/definitions",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "routing",
            "attributes",
            "definitions"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"definitions\": {\n    \"type\": \"object\",\n    \"properties\": {\n      \"conditions_all\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"subject\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"title\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            }\n          }\n        },\n        \"maxItems\": 2\n      },\n      \"conditions_any\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"subject\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"title\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            }\n          }\n        },\n        \"maxItems\": 2\n      }\n    }\n  }\n}"
    }
  ]
}