Chilkat Online Tools

Java / Support API / List Routing Attribute Definitions

Back to Collection Items

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

    http.put_BasicAuth(true);
    http.put_Login("login");
    http.put_Password("password");

    http.SetRequestHeader("Accept","application/json");

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/routing/attributes/definitions",sbResponseBody);
    if (success == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    System.out.println("Response Body:");
    System.out.println(jResp.emit());

    int respStatusCode = http.get_LastStatus();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(http.lastHeader());
        System.out.println("Failed.");
        return;
        }

    // 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

    String v_Type = jResp.stringOf("definitions.type");
    String Conditions_allType = jResp.stringOf("definitions.properties.conditions_all.type");
    String ItemsType = jResp.stringOf("definitions.properties.conditions_all.items.type");
    String SubjectType = jResp.stringOf("definitions.properties.conditions_all.items.properties.subject.type");
    String Default = jResp.stringOf("definitions.properties.conditions_all.items.properties.subject.default");
    String TitleType = jResp.stringOf("definitions.properties.conditions_all.items.properties.title.type");
    String TitleDefault = jResp.stringOf("definitions.properties.conditions_all.items.properties.title.default");
    int MaxItems = jResp.IntOf("definitions.properties.conditions_all.maxItems");
    String Conditions_anyType = jResp.stringOf("definitions.properties.conditions_any.type");
    ItemsType = jResp.stringOf("definitions.properties.conditions_any.items.type");
    SubjectType = jResp.stringOf("definitions.properties.conditions_any.items.properties.subject.type");
    String SubjectDefault = jResp.stringOf("definitions.properties.conditions_any.items.properties.subject.default");
    TitleType = jResp.stringOf("definitions.properties.conditions_any.items.properties.title.type");
    TitleDefault = jResp.stringOf("definitions.properties.conditions_any.items.properties.title.default");
    int Conditions_anyMaxItems = jResp.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}"
    }
  ]
}