Chilkat Online Tools

Ruby / Support API / Incremental Organization Export

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

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

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("start_time","<integer>")

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

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/incremental/organizations",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

# {
#   "count": "<integer>",
#   "end_of_stream": "<boolean>",
#   "end_time": "<integer>",
#   "next_page": "<string>",
#   "organizations": [
#     {
#       "created_at": "<string>",
#       "details": "<string>",
#       "domain_names": [
#         "<string>",
#         "<string>"
#       ],
#       "external_id": "<string>",
#       "group_id": "<integer>",
#       "id": "<integer>",
#       "name": "<string>",
#       "notes": "<string>",
#       "organization_fields": {
#         "et_37f": "<string>",
#         "ea_0": "<string>",
#         "esse_c9": "<string>"
#       },
#       "shared_comments": "<boolean>",
#       "shared_tickets": "<boolean>",
#       "tags": [
#         "<string>",
#         "<string>"
#       ],
#       "updated_at": "<string>",
#       "url": "<string>"
#     },
#     {
#       "created_at": "<string>",
#       "details": "<string>",
#       "domain_names": [
#         "<string>",
#         "<string>"
#       ],
#       "external_id": "<string>",
#       "group_id": "<integer>",
#       "id": "<integer>",
#       "name": "<string>",
#       "notes": "<string>",
#       "organization_fields": {
#         "magna_6d_": "<string>",
#         "nostrud_b": "<string>"
#       },
#       "shared_comments": "<boolean>",
#       "shared_tickets": "<boolean>",
#       "tags": [
#         "<string>",
#         "<string>"
#       ],
#       "updated_at": "<string>",
#       "url": "<string>"
#     }
#   ]
# }

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

count = jResp.stringOf("count")
end_of_stream = jResp.stringOf("end_of_stream")
end_time = jResp.stringOf("end_time")
next_page = jResp.stringOf("next_page")
i = 0
count_i = jResp.SizeOfArray("organizations")
while i < count_i
    jResp.put_I(i)
    created_at = jResp.stringOf("organizations[i].created_at")
    details = jResp.stringOf("organizations[i].details")
    external_id = jResp.stringOf("organizations[i].external_id")
    group_id = jResp.stringOf("organizations[i].group_id")
    id = jResp.stringOf("organizations[i].id")
    name = jResp.stringOf("organizations[i].name")
    notes = jResp.stringOf("organizations[i].notes")
    Et_37f = jResp.stringOf("organizations[i].organization_fields.et_37f")
    Ea_0 = jResp.stringOf("organizations[i].organization_fields.ea_0")
    Esse_c9 = jResp.stringOf("organizations[i].organization_fields.esse_c9")
    shared_comments = jResp.stringOf("organizations[i].shared_comments")
    shared_tickets = jResp.stringOf("organizations[i].shared_tickets")
    updated_at = jResp.stringOf("organizations[i].updated_at")
    url = jResp.stringOf("organizations[i].url")
    Magna_6d_ = jResp.stringOf("organizations[i].organization_fields.magna_6d_")
    Nostrud_b = jResp.stringOf("organizations[i].organization_fields.nostrud_b")
    j = 0
    count_j = jResp.SizeOfArray("organizations[i].domain_names")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("organizations[i].domain_names[j]")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("organizations[i].tags")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("organizations[i].tags[j]")
        j = j + 1
    end
    i = i + 1
end

Curl Command

curl  -u login:password -G -d "start_time=%3Cinteger%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/incremental/organizations

Postman Collection Item JSON

{
  "name": "Incremental Organization Export",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/incremental/organizations?start_time=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "incremental",
        "organizations"
      ],
      "query": [
        {
          "key": "start_time",
          "value": "<integer>",
          "description": "(Required) The time to start the incremental export from"
        }
      ]
    },
    "description": "#### Allowed For\n\n * Admins\n\n#### Sideloading\n\nSee [Organizations sideloads](/documentation/ticketing/using-the-zendesk-api/side_loading/#supported-endpoints).\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/incremental/organizations?start_time=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "incremental",
            "organizations"
          ],
          "query": [
            {
              "key": "start_time",
              "value": "<integer>",
              "description": "(Required) The time to start the incremental export from"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"count\": \"<integer>\",\n  \"end_of_stream\": \"<boolean>\",\n  \"end_time\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"organizations\": [\n    {\n      \"created_at\": \"<string>\",\n      \"details\": \"<string>\",\n      \"domain_names\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"external_id\": \"<string>\",\n      \"group_id\": \"<integer>\",\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"notes\": \"<string>\",\n      \"organization_fields\": {\n        \"et_37f\": \"<string>\",\n        \"ea_0\": \"<string>\",\n        \"esse_c9\": \"<string>\"\n      },\n      \"shared_comments\": \"<boolean>\",\n      \"shared_tickets\": \"<boolean>\",\n      \"tags\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"updated_at\": \"<string>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"created_at\": \"<string>\",\n      \"details\": \"<string>\",\n      \"domain_names\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"external_id\": \"<string>\",\n      \"group_id\": \"<integer>\",\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"notes\": \"<string>\",\n      \"organization_fields\": {\n        \"magna_6d_\": \"<string>\",\n        \"nostrud_b\": \"<string>\"\n      },\n      \"shared_comments\": \"<boolean>\",\n      \"shared_tickets\": \"<boolean>\",\n      \"tags\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"updated_at\": \"<string>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}