PureBasic / Support API / List Trigger Revisions
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/triggers/:trigger_id/revisions",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
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 = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "after_cursor": "<string>",
; "after_url": "<string>",
; "before_cursor": "<string>",
; "before_url": "<string>",
; "count": "<integer>",
; "trigger_revisions": [
; {
; "author_id": "<integer>",
; "created_at": "<string>",
; "diff": {
; "actions": [
; {
; "field": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ],
; "value": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ]
; },
; {
; "field": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ],
; "value": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ]
; }
; ],
; "active": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ],
; "conditions": {
; "field": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ],
; "operator": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ],
; "value": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ]
; },
; "description": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ],
; "source_id": "<integer>",
; "target_id": "<integer>",
; "title": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ]
; },
; "id": "<integer>",
; "snapshot": {
; "actions": [
; {
; "field": "<string>",
; "value": "<string>"
; },
; {
; "field": "<string>",
; "value": "<string>"
; }
; ],
; "active": "<boolean>",
; "conditions": {
; "all": [
; {
; "field": "<string>",
; "operator": "<string>",
; "value": "<string>"
; },
; {
; "field": "<string>",
; "operator": "<string>",
; "value": "<string>"
; }
; ],
; "any": [
; {
; "field": "<string>",
; "operator": "<string>",
; "value": "<string>"
; },
; {
; "field": "<string>",
; "operator": "<string>",
; "value": "<string>"
; }
; ]
; },
; "description": "<string>",
; "title": "<string>"
; },
; "url": "<string>"
; },
; {
; "author_id": "<integer>",
; "created_at": "<string>",
; "diff": {
; "actions": [
; {
; "field": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ],
; "value": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ]
; },
; {
; "field": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ],
; "value": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ]
; }
; ],
; "active": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ],
; "conditions": {
; "field": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ],
; "operator": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ],
; "value": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ]
; },
; "description": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ],
; "source_id": "<integer>",
; "target_id": "<integer>",
; "title": [
; {
; "change": "<string>",
; "content": "<boolean>"
; },
; {
; "change": "<string>",
; "content": "<boolean>"
; }
; ]
; },
; "id": "<integer>",
; "snapshot": {
; "actions": [
; {
; "field": "<string>",
; "value": "<string>"
; },
; {
; "field": "<string>",
; "value": "<string>"
; }
; ],
; "active": "<boolean>",
; "conditions": {
; "all": [
; {
; "field": "<string>",
; "operator": "<string>",
; "value": "<string>"
; },
; {
; "field": "<string>",
; "operator": "<string>",
; "value": "<string>"
; }
; ],
; "any": [
; {
; "field": "<string>",
; "operator": "<string>",
; "value": "<string>"
; },
; {
; "field": "<string>",
; "operator": "<string>",
; "value": "<string>"
; }
; ]
; },
; "description": "<string>",
; "title": "<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
author_id.s
created_at.s
Source_id.s
Target_id.s
id.s
Active.s
Description.s
Title.s
url.s
j.i
count_j.i
k.i
count_k.i
change.s
content.s
field.s
value.s
operator.s
after_cursor.s = CkJsonObject::ckStringOf(jResp,"after_cursor")
after_url.s = CkJsonObject::ckStringOf(jResp,"after_url")
before_cursor.s = CkJsonObject::ckStringOf(jResp,"before_cursor")
before_url.s = CkJsonObject::ckStringOf(jResp,"before_url")
count.s = CkJsonObject::ckStringOf(jResp,"count")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"trigger_revisions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
author_id = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].author_id")
created_at = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].created_at")
Source_id = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.source_id")
Target_id = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.target_id")
id = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].id")
Active = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].snapshot.active")
Description = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].snapshot.description")
Title = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].snapshot.title")
url = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].url")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"trigger_revisions[i].diff.actions")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"trigger_revisions[i].diff.actions[j].field")
While k < count_k
CkJsonObject::setCkK(jResp, k)
change = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.actions[j].field[k].change")
content = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.actions[j].field[k].content")
k = k + 1
Wend
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"trigger_revisions[i].diff.actions[j].value")
While k < count_k
CkJsonObject::setCkK(jResp, k)
change = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.actions[j].value[k].change")
content = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.actions[j].value[k].content")
k = k + 1
Wend
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"trigger_revisions[i].diff.active")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
change = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.active[j].change")
content = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.active[j].content")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"trigger_revisions[i].diff.conditions.field")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
change = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.conditions.field[j].change")
content = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.conditions.field[j].content")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"trigger_revisions[i].diff.conditions.operator")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
change = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.conditions.operator[j].change")
content = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.conditions.operator[j].content")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"trigger_revisions[i].diff.conditions.value")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
change = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.conditions.value[j].change")
content = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.conditions.value[j].content")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"trigger_revisions[i].diff.description")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
change = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.description[j].change")
content = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.description[j].content")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"trigger_revisions[i].diff.title")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
change = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.title[j].change")
content = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].diff.title[j].content")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"trigger_revisions[i].snapshot.actions")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
field = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].snapshot.actions[j].field")
value = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].snapshot.actions[j].value")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"trigger_revisions[i].snapshot.conditions.all")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
field = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].snapshot.conditions.all[j].field")
operator = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].snapshot.conditions.all[j].operator")
value = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].snapshot.conditions.all[j].value")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"trigger_revisions[i].snapshot.conditions.any")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
field = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].snapshot.conditions.any[j].field")
operator = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].snapshot.conditions.any[j].operator")
value = CkJsonObject::ckStringOf(jResp,"trigger_revisions[i].snapshot.conditions.any[j].value")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/triggers/:trigger_id/revisions
Postman Collection Item JSON
{
"name": "List Trigger Revisions",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/triggers/:trigger_id/revisions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers",
":trigger_id",
"revisions"
],
"variable": [
{
"key": "trigger_id",
"value": "<integer>"
}
]
},
"description": "List the revisions associated with a trigger. Trigger revision history is only available on Enterprise plans.\n\n#### Allowed For\n\n * Agents\n\n#### Sideloads\n\nThe following sideloads are supported:\n\n| Name | Will sideload\n| ----- | -------------\n| users | The user that authored each revision\n\n#### Pagination\n\nThis endpoint uses cursor-based pagination. The records are ordered in\ndescending order by the `created_at` timestamp, then by `id` on duplicate\n`created_at` values.\n\nThe `cursor` parameter is a non-human-readable argument you can use to move\nforward or backward in time.\n\nEach JSON response will contain the following attributes to help you get\nmore results:\n\n- `after_url` requests more recent results\n- `before_url` requests older results\n- `after_cursor` is the cursor to build the request yourself\n- `before_cursor` is the cursor to build the request yourself\n\nThe properties are null if no more records are available.\n\nYou can request a maximum of 1000 records using the `limit` parameter. If\nno `limit` parameter is supplied, it will default to 1,000.\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/triggers/:trigger_id/revisions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers",
":trigger_id",
"revisions"
],
"variable": [
{
"key": "trigger_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"after_cursor\": \"<string>\",\n \"after_url\": \"<string>\",\n \"before_cursor\": \"<string>\",\n \"before_url\": \"<string>\",\n \"count\": \"<integer>\",\n \"trigger_revisions\": [\n {\n \"author_id\": \"<integer>\",\n \"created_at\": \"<string>\",\n \"diff\": {\n \"actions\": [\n {\n \"field\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ],\n \"value\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ]\n },\n {\n \"field\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ],\n \"value\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ]\n }\n ],\n \"active\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ],\n \"conditions\": {\n \"field\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ],\n \"operator\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ],\n \"value\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ]\n },\n \"description\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ],\n \"source_id\": \"<integer>\",\n \"target_id\": \"<integer>\",\n \"title\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ]\n },\n \"id\": \"<integer>\",\n \"snapshot\": {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"active\": \"<boolean>\",\n \"conditions\": {\n \"all\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"any\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"url\": \"<string>\"\n },\n {\n \"author_id\": \"<integer>\",\n \"created_at\": \"<string>\",\n \"diff\": {\n \"actions\": [\n {\n \"field\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ],\n \"value\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ]\n },\n {\n \"field\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ],\n \"value\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ]\n }\n ],\n \"active\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ],\n \"conditions\": {\n \"field\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ],\n \"operator\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ],\n \"value\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ]\n },\n \"description\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ],\n \"source_id\": \"<integer>\",\n \"target_id\": \"<integer>\",\n \"title\": [\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n },\n {\n \"change\": \"<string>\",\n \"content\": \"<boolean>\"\n }\n ]\n },\n \"id\": \"<integer>\",\n \"snapshot\": {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"active\": \"<boolean>\",\n \"conditions\": {\n \"all\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"any\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}
