Chilkat Online Tools

PureBasic / Support API / List Macros

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "login")
    CkHttp::setCkPassword(http, "password")

    queryParams.i = CkJsonObject::ckCreate()
    If queryParams.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(queryParams,"include","<string>")
    CkJsonObject::ckUpdateString(queryParams,"access","<string>")
    CkJsonObject::ckUpdateString(queryParams,"active","<boolean>")
    CkJsonObject::ckUpdateString(queryParams,"category","<integer>")
    CkJsonObject::ckUpdateString(queryParams,"group_id","<integer>")
    CkJsonObject::ckUpdateString(queryParams,"only_viewable","<boolean>")
    CkJsonObject::ckUpdateString(queryParams,"sort_by","<string>")
    CkJsonObject::ckUpdateString(queryParams,"sort_order","<string>")

    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://example.zendesk.com/api/v2/macros",queryParams)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

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

    ; {
    ;   "macros": [
    ;     {
    ;       "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": {
    ;         "proidentf9": true
    ;       },
    ;       "updated_at": "<dateTime>",
    ;       "url": "<string>",
    ;       "app_installation": "<string>",
    ;       "categories": "<string>",
    ;       "permissions": "<string>",
    ;       "usage_1h": "<integer>",
    ;       "usage_7d": "<integer>",
    ;       "usage_24h": "<integer>",
    ;       "usage_30d": "<integer>"
    ;     },
    ;     {
    ;       "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": {
    ;         "deserunt_": false,
    ;         "exercitation2": -75718943,
    ;         "eiusmodeaf": 24563232.4790345,
    ;         "estf5": "aute",
    ;         "minim24": -78305859
    ;       },
    ;       "updated_at": "<dateTime>",
    ;       "url": "<string>",
    ;       "app_installation": "<string>",
    ;       "categories": "<string>",
    ;       "permissions": "<string>",
    ;       "usage_1h": "<integer>",
    ;       "usage_7d": "<integer>",
    ;       "usage_24h": "<integer>",
    ;       "usage_30d": "<integer>"
    ;     }
    ;   ],
    ;   "count": "<integer>",
    ;   "next_page": "<string>",
    ;   "previous_page": "<string>"
    ; }

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

    title.s
    active.s
    created_at.s
    default.s
    description.s
    id.s
    position.s
    Proidentf9.i
    updated_at.s
    url.s
    app_installation.s
    categories.s
    permissions.s
    usage_1h.s
    usage_7d.s
    usage_24h.s
    usage_30d.s
    Deserunt_.i
    Exercitation2.i
    Eiusmodeaf.s
    Estf5.s
    Minim24.i
    j.i
    count_j.i
    field.s
    value.s

    count.s = CkJsonObject::ckStringOf(jResp,"count")
    next_page.s = CkJsonObject::ckStringOf(jResp,"next_page")
    previous_page.s = CkJsonObject::ckStringOf(jResp,"previous_page")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"macros")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        title = CkJsonObject::ckStringOf(jResp,"macros[i].title")
        active = CkJsonObject::ckStringOf(jResp,"macros[i].active")
        created_at = CkJsonObject::ckStringOf(jResp,"macros[i].created_at")
        default = CkJsonObject::ckStringOf(jResp,"macros[i].default")
        description = CkJsonObject::ckStringOf(jResp,"macros[i].description")
        id = CkJsonObject::ckStringOf(jResp,"macros[i].id")
        position = CkJsonObject::ckStringOf(jResp,"macros[i].position")
        Proidentf9 = CkJsonObject::ckBoolOf(jResp,"macros[i].restriction.proidentf9")
        updated_at = CkJsonObject::ckStringOf(jResp,"macros[i].updated_at")
        url = CkJsonObject::ckStringOf(jResp,"macros[i].url")
        app_installation = CkJsonObject::ckStringOf(jResp,"macros[i].app_installation")
        categories = CkJsonObject::ckStringOf(jResp,"macros[i].categories")
        permissions = CkJsonObject::ckStringOf(jResp,"macros[i].permissions")
        usage_1h = CkJsonObject::ckStringOf(jResp,"macros[i].usage_1h")
        usage_7d = CkJsonObject::ckStringOf(jResp,"macros[i].usage_7d")
        usage_24h = CkJsonObject::ckStringOf(jResp,"macros[i].usage_24h")
        usage_30d = CkJsonObject::ckStringOf(jResp,"macros[i].usage_30d")
        Deserunt_ = CkJsonObject::ckBoolOf(jResp,"macros[i].restriction.deserunt_")
        Exercitation2 = CkJsonObject::ckIntOf(jResp,"macros[i].restriction.exercitation2")
        Eiusmodeaf = CkJsonObject::ckStringOf(jResp,"macros[i].restriction.eiusmodeaf")
        Estf5 = CkJsonObject::ckStringOf(jResp,"macros[i].restriction.estf5")
        Minim24 = CkJsonObject::ckIntOf(jResp,"macros[i].restriction.minim24")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"macros[i].actions")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            field = CkJsonObject::ckStringOf(jResp,"macros[i].actions[j].field")
            value = CkJsonObject::ckStringOf(jResp,"macros[i].actions[j].value")
            j = j + 1
        Wend
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl  -u login:password -G -d "include=%3Cstring%3E"
	-d "access=%3Cstring%3E"
	-d "active=%3Cboolean%3E"
	-d "category=%3Cinteger%3E"
	-d "group_id=%3Cinteger%3E"
	-d "only_viewable=%3Cboolean%3E"
	-d "sort_by=%3Cstring%3E"
	-d "sort_order=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/macros

Postman Collection Item JSON

{
  "name": "List Macros",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/macros?include=<string>&access=<string>&active=<boolean>&category=<integer>&group_id=<integer>&only_viewable=<boolean>&sort_by=<string>&sort_order=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "macros"
      ],
      "query": [
        {
          "key": "include",
          "value": "<string>",
          "description": "A sideload to include in the response. See [Sideloads](#sideloads-2)"
        },
        {
          "key": "access",
          "value": "<string>",
          "description": "Filter macros by access. Possible values are \"personal\", \"shared\", or \"account\""
        },
        {
          "key": "active",
          "value": "<boolean>",
          "description": "Filter by active macros if true or inactive macros if false"
        },
        {
          "key": "category",
          "value": "<integer>",
          "description": "Filter macros by category"
        },
        {
          "key": "group_id",
          "value": "<integer>",
          "description": "Filter macros by group"
        },
        {
          "key": "only_viewable",
          "value": "<boolean>",
          "description": "If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false"
        },
        {
          "key": "sort_by",
          "value": "<string>",
          "description": "Possible values are alphabetical, \"created_at\", \"updated_at\", \"usage_1h\", \"usage_24h\", \"usage_7d\", or \"usage_30d\". Defaults to alphabetical"
        },
        {
          "key": "sort_order",
          "value": "<string>",
          "description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others"
        }
      ]
    },
    "description": "Lists all shared and personal macros available to the current user.\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### 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?include=<string>&access=<string>&active=<boolean>&category=<integer>&group_id=<integer>&only_viewable=<boolean>&sort_by=<string>&sort_order=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "macros"
          ],
          "query": [
            {
              "key": "include",
              "value": "<string>",
              "description": "A sideload to include in the response. See [Sideloads](#sideloads-2)"
            },
            {
              "key": "access",
              "value": "<string>",
              "description": "Filter macros by access. Possible values are \"personal\", \"shared\", or \"account\""
            },
            {
              "key": "active",
              "value": "<boolean>",
              "description": "Filter by active macros if true or inactive macros if false"
            },
            {
              "key": "category",
              "value": "<integer>",
              "description": "Filter macros by category"
            },
            {
              "key": "group_id",
              "value": "<integer>",
              "description": "Filter macros by group"
            },
            {
              "key": "only_viewable",
              "value": "<boolean>",
              "description": "If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false"
            },
            {
              "key": "sort_by",
              "value": "<string>",
              "description": "Possible values are alphabetical, \"created_at\", \"updated_at\", \"usage_1h\", \"usage_24h\", \"usage_7d\", or \"usage_30d\". Defaults to alphabetical"
            },
            {
              "key": "sort_order",
              "value": "<string>",
              "description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"macros\": [\n    {\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        \"proidentf9\": true\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    {\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        \"deserunt_\": false,\n        \"exercitation2\": -75718943,\n        \"eiusmodeaf\": 24563232.4790345,\n        \"estf5\": \"aute\",\n        \"minim24\": -78305859\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  ],\n  \"count\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"previous_page\": \"<string>\"\n}"
    }
  ]
}