Chilkat Online Tools

Java / Support API / Search Tags

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");

    CkJsonObject queryParams = new CkJsonObject();
    queryParams.UpdateString("tag_name_fragment","<string>");

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

    CkHttpResponse resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/autocomplete/tags",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

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

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

    int respStatusCode = resp.get_StatusCode();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(resp.header());
        System.out.println("Failed.");

        return;
        }

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

    // {
    //   "tags": [
    //     "<string>",
    //     "<string>"
    //   ]
    // }

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

    String strVal;

    int i = 0;
    int count_i = jResp.SizeOfArray("tags");
    while (i < count_i) {
        jResp.put_I(i);
        strVal = jResp.stringOf("tags[i]");
        i = i+1;
        }
  }
}

Curl Command

curl  -u login:password -G -d "tag_name_fragment=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/autocomplete/tags

Postman Collection Item JSON

{
  "name": "Search Tags",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/autocomplete/tags?tag_name_fragment=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "autocomplete",
        "tags"
      ],
      "query": [
        {
          "key": "tag_name_fragment",
          "value": "<string>",
          "description": "A substring of a tag to search for"
        }
      ]
    },
    "description": "Returns an array of registered and recent tag names that start with the characters specified in the `name` query parameter. You must specify at least 2 characters.\n\n#### Pagination\n\n* Offset pagination only\n\nSee [Using Offset Pagination](/api-reference/ticketing/introduction/#using-offset-pagination).\n\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/autocomplete/tags?tag_name_fragment=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "autocomplete",
            "tags"
          ],
          "query": [
            {
              "key": "tag_name_fragment",
              "value": "<string>",
              "description": "A substring of a tag to search for"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"tags\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    }
  ]
}