DataFlex / Support API / Show Audit
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
Boolean iProidentb4
String sIncididunt_dcf
String sAuthor_id
String sCreated_at
String sId
Boolean iAliquip_4
Integer iCillum_3
String sFugiat_6
Integer iVelit_3
String sTicket_id
String sChannel
String sFugiatc
Integer i
Integer iCount_i
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Set ComBasicAuth Of hoHttp To True
Set ComLogin Of hoHttp To "login"
Set ComPassword Of hoHttp To "password"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://example.zendesk.com/api/v2/tickets/:ticket_id/audits/:ticket_audit_id" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "audit": {
// "author_id": "<integer>",
// "created_at": "<dateTime>",
// "events": [
// {
// "proidentb4": true
// },
// {
// "incididunt_dcf": "commodo est mollit laborum"
// }
// ],
// "id": "<integer>",
// "metadata": {
// "aliquip_4": true,
// "cillum_3": 38133397,
// "fugiat_6": "magna",
// "velit_3": -35308847
// },
// "ticket_id": "<integer>",
// "via": {
// "channel": "<string>",
// "source": {
// "fugiatc": 39106364.288705826
// }
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "audit.author_id" To sAuthor_id
Get ComStringOf Of hoJResp "audit.created_at" To sCreated_at
Get ComStringOf Of hoJResp "audit.id" To sId
Get ComBoolOf Of hoJResp "audit.metadata.aliquip_4" To iAliquip_4
Get ComIntOf Of hoJResp "audit.metadata.cillum_3" To iCillum_3
Get ComStringOf Of hoJResp "audit.metadata.fugiat_6" To sFugiat_6
Get ComIntOf Of hoJResp "audit.metadata.velit_3" To iVelit_3
Get ComStringOf Of hoJResp "audit.ticket_id" To sTicket_id
Get ComStringOf Of hoJResp "audit.via.channel" To sChannel
Get ComStringOf Of hoJResp "audit.via.source.fugiatc" To sFugiatc
Move 0 To i
Get ComSizeOfArray Of hoJResp "audit.events" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComBoolOf Of hoJResp "audit.events[i].proidentb4" To iProidentb4
Get ComStringOf Of hoJResp "audit.events[i].incididunt_dcf" To sIncididunt_dcf
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/tickets/:ticket_id/audits/:ticket_audit_id
Postman Collection Item JSON
{
"name": "Show Audit",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/audits/:ticket_audit_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"audits",
":ticket_audit_id"
],
"variable": [
{
"key": "ticket_id",
"value": "<integer>"
},
{
"key": "ticket_audit_id",
"value": "<integer>"
}
]
},
"description": "#### Allowed for\n\n* Agents\n"
},
"response": [
{
"name": "OK response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/audits/:ticket_audit_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"audits",
":ticket_audit_id"
],
"variable": [
{
"key": "ticket_id"
},
{
"key": "ticket_audit_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"audit\": {\n \"author_id\": \"<integer>\",\n \"created_at\": \"<dateTime>\",\n \"events\": [\n {\n \"proidentb4\": true\n },\n {\n \"incididunt_dcf\": \"commodo est mollit laborum\"\n }\n ],\n \"id\": \"<integer>\",\n \"metadata\": {\n \"aliquip_4\": true,\n \"cillum_3\": 38133397,\n \"fugiat_6\": \"magna\",\n \"velit_3\": -35308847\n },\n \"ticket_id\": \"<integer>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"fugiatc\": 39106364.288705826\n }\n }\n }\n}"
}
]
}
