PureBasic / Support API / Show Trigger Revision
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/:trigger_revision_id",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)
; {
; "trigger_revision": {
; "author_id": "<integer>",
; "created_at": "<string>",
; "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
field.s
value.s
operator.s
Author_id.s = CkJsonObject::ckStringOf(jResp,"trigger_revision.author_id")
Created_at.s = CkJsonObject::ckStringOf(jResp,"trigger_revision.created_at")
Id.s = CkJsonObject::ckStringOf(jResp,"trigger_revision.id")
Active.s = CkJsonObject::ckStringOf(jResp,"trigger_revision.snapshot.active")
Description.s = CkJsonObject::ckStringOf(jResp,"trigger_revision.snapshot.description")
Title.s = CkJsonObject::ckStringOf(jResp,"trigger_revision.snapshot.title")
v_Url.s = CkJsonObject::ckStringOf(jResp,"trigger_revision.url")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"trigger_revision.snapshot.actions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
field = CkJsonObject::ckStringOf(jResp,"trigger_revision.snapshot.actions[i].field")
value = CkJsonObject::ckStringOf(jResp,"trigger_revision.snapshot.actions[i].value")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"trigger_revision.snapshot.conditions.all")
While i < count_i
CkJsonObject::setCkI(jResp, i)
field = CkJsonObject::ckStringOf(jResp,"trigger_revision.snapshot.conditions.all[i].field")
operator = CkJsonObject::ckStringOf(jResp,"trigger_revision.snapshot.conditions.all[i].operator")
value = CkJsonObject::ckStringOf(jResp,"trigger_revision.snapshot.conditions.all[i].value")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"trigger_revision.snapshot.conditions.any")
While i < count_i
CkJsonObject::setCkI(jResp, i)
field = CkJsonObject::ckStringOf(jResp,"trigger_revision.snapshot.conditions.any[i].field")
operator = CkJsonObject::ckStringOf(jResp,"trigger_revision.snapshot.conditions.any[i].operator")
value = CkJsonObject::ckStringOf(jResp,"trigger_revision.snapshot.conditions.any[i].value")
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/:trigger_revision_id
Postman Collection Item JSON
{
"name": "Show Trigger Revision",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/triggers/:trigger_id/revisions/:trigger_revision_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers",
":trigger_id",
"revisions",
":trigger_revision_id"
],
"variable": [
{
"key": "trigger_id",
"value": "<integer>"
},
{
"key": "trigger_revision_id",
"value": "<integer>"
}
]
},
"description": "Fetches a revision 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"
},
"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/:trigger_revision_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers",
":trigger_id",
"revisions",
":trigger_revision_id"
],
"variable": [
{
"key": "trigger_id"
},
{
"key": "trigger_revision_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"trigger_revision\": {\n \"author_id\": \"<integer>\",\n \"created_at\": \"<string>\",\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}"
}
]
}
