PowerBuilder / Support API / Show Automation
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Field
string ls_Value
string ls_Operator
string ls_Active
string ls_Created_at
string ls_Default
string ls_Id
string ls_Position
string ls_Raw_title
string ls_Title
string ls_Updated_at
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "login"
loo_Http.Password = "password"
loo_Http.SetRequestHeader("Accept","application/json")
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://example.zendesk.com/api/v2/automations/:automation_id",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "automation": {
// "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>"
// }
// ]
// },
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_title": "<string>",
// "title": "<string>",
// "updated_at": "<dateTime>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Active = loo_JResp.StringOf("automation.active")
ls_Created_at = loo_JResp.StringOf("automation.created_at")
ls_Default = loo_JResp.StringOf("automation.default")
ls_Id = loo_JResp.StringOf("automation.id")
ls_Position = loo_JResp.StringOf("automation.position")
ls_Raw_title = loo_JResp.StringOf("automation.raw_title")
ls_Title = loo_JResp.StringOf("automation.title")
ls_Updated_at = loo_JResp.StringOf("automation.updated_at")
i = 0
li_Count_i = loo_JResp.SizeOfArray("automation.actions")
do while i < li_Count_i
loo_JResp.I = i
ls_Field = loo_JResp.StringOf("automation.actions[i].field")
ls_Value = loo_JResp.StringOf("automation.actions[i].value")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("automation.conditions.all")
do while i < li_Count_i
loo_JResp.I = i
ls_Field = loo_JResp.StringOf("automation.conditions.all[i].field")
ls_Operator = loo_JResp.StringOf("automation.conditions.all[i].operator")
ls_Value = loo_JResp.StringOf("automation.conditions.all[i].value")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("automation.conditions.any")
do while i < li_Count_i
loo_JResp.I = i
ls_Field = loo_JResp.StringOf("automation.conditions.any[i].field")
ls_Operator = loo_JResp.StringOf("automation.conditions.any[i].operator")
ls_Value = loo_JResp.StringOf("automation.conditions.any[i].value")
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/automations/:automation_id
Postman Collection Item JSON
{
"name": "Show Automation",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/automations/:automation_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"automations",
":automation_id"
],
"variable": [
{
"key": "automation_id",
"value": "<integer>"
}
]
},
"description": "#### Allowed For\n\n* Agents\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/automations/:automation_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"automations",
":automation_id"
],
"variable": [
{
"key": "automation_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"automation\": {\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 \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_title\": \"<string>\",\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\"\n }\n}"
}
]
}
