autoit / Support API / Incremental Organization Export
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"
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("start_time","<integer>")
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequestParams("GET","https://example.zendesk.com/api/v2/incremental/organizations",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sCreated_at
Local $sDetails
Local $sExternal_id
Local $sGroup_id
Local $sId
Local $sName
Local $sNotes
Local $sEt_37f
Local $sEa_0
Local $sEsse_c9
Local $shared_comments
Local $shared_tickets
Local $sUpdated_at
Local $sUrl
Local $sMagna_6d_
Local $sNostrud_b
Local $iJ
Local $iCount_j
Local $strVal
Local $sCount = $oJResp.StringOf("count")
Local $sEnd_of_stream = $oJResp.StringOf("end_of_stream")
Local $sEnd_time = $oJResp.StringOf("end_time")
Local $sNext_page = $oJResp.StringOf("next_page")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("organizations")
While $i < $iCount_i
$oJResp.I = $i
$sCreated_at = $oJResp.StringOf("organizations[i].created_at")
$sDetails = $oJResp.StringOf("organizations[i].details")
$sExternal_id = $oJResp.StringOf("organizations[i].external_id")
$sGroup_id = $oJResp.StringOf("organizations[i].group_id")
$sId = $oJResp.StringOf("organizations[i].id")
$sName = $oJResp.StringOf("organizations[i].name")
$sNotes = $oJResp.StringOf("organizations[i].notes")
$sEt_37f = $oJResp.StringOf("organizations[i].organization_fields.et_37f")
$sEa_0 = $oJResp.StringOf("organizations[i].organization_fields.ea_0")
$sEsse_c9 = $oJResp.StringOf("organizations[i].organization_fields.esse_c9")
$shared_comments = $oJResp.StringOf("organizations[i].shared_comments")
$shared_tickets = $oJResp.StringOf("organizations[i].shared_tickets")
$sUpdated_at = $oJResp.StringOf("organizations[i].updated_at")
$sUrl = $oJResp.StringOf("organizations[i].url")
$sMagna_6d_ = $oJResp.StringOf("organizations[i].organization_fields.magna_6d_")
$sNostrud_b = $oJResp.StringOf("organizations[i].organization_fields.nostrud_b")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("organizations[i].domain_names")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("organizations[i].domain_names[j]")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("organizations[i].tags")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("organizations[i].tags[j]")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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}"
}
]
}
