Chilkat Online Tools

Powershell / Support API / Show Ticket Form

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = New-Object Chilkat.Http

$http.BasicAuth = $true
$http.Login = "login"
$http.Password = "password"

$http.SetRequestHeader("Accept","application/json")

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://example.zendesk.com/api/v2/ticket_forms/:ticket_form_id",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "ticket_form": {
#     "name": "<string>",
#     "active": "<boolean>",
#     "agent_conditions": [
#       {
#         "aliqua6": "proident deserunt",
#         "Lorem_d": "cillum dolor Excepteur ut",
#         "mollit_cf": -33059877,
#         "ullamco_f7": "dolore occaeca"
#       },
#       {
#         "consequate_": 29214347.18513973,
#         "consectetur_00": 83697330,
#         "laborum50": "cillum Ut"
#       }
#     ],
#     "created_at": "<dateTime>",
#     "default": "<boolean>",
#     "display_name": "<string>",
#     "end_user_conditions": [
#       {
#         "irure__c": false,
#         "Excepteur_38": -15203265.607602075,
#         "sunt_8": "culpa laboris Ut"
#       },
#       {
#         "nulla_48": "quis esse",
#         "ullamco_f6": -25516091.19614251
#       }
#     ],
#     "end_user_visible": "<boolean>",
#     "id": "<integer>",
#     "in_all_brands": "<boolean>",
#     "position": "<integer>",
#     "raw_display_name": "<string>",
#     "raw_name": "<string>",
#     "restricted_brand_ids": [
#       "<integer>",
#       "<integer>"
#     ],
#     "ticket_field_ids": [
#       "<integer>",
#       "<integer>"
#     ],
#     "updated_at": "<dateTime>",
#     "url": "<string>"
#   }
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$Name = $jResp.StringOf("ticket_form.name")
$Active = $jResp.StringOf("ticket_form.active")
$Created_at = $jResp.StringOf("ticket_form.created_at")
$Default = $jResp.StringOf("ticket_form.default")
$Display_name = $jResp.StringOf("ticket_form.display_name")
$End_user_visible = $jResp.StringOf("ticket_form.end_user_visible")
$Id = $jResp.StringOf("ticket_form.id")
$In_all_brands = $jResp.StringOf("ticket_form.in_all_brands")
$Position = $jResp.StringOf("ticket_form.position")
$Raw_display_name = $jResp.StringOf("ticket_form.raw_display_name")
$Raw_name = $jResp.StringOf("ticket_form.raw_name")
$Updated_at = $jResp.StringOf("ticket_form.updated_at")
$v_Url = $jResp.StringOf("ticket_form.url")
$i = 0
$count_i = $jResp.SizeOfArray("ticket_form.agent_conditions")
while ($i -lt $count_i) {
    $jResp.I = $i
    $aliqua6 = $jResp.StringOf("ticket_form.agent_conditions[i].aliqua6")
    $Lorem_d = $jResp.StringOf("ticket_form.agent_conditions[i].Lorem_d")
    $mollit_cf = $jResp.IntOf("ticket_form.agent_conditions[i].mollit_cf")
    $ullamco_f7 = $jResp.StringOf("ticket_form.agent_conditions[i].ullamco_f7")
    $consequate_ = $jResp.StringOf("ticket_form.agent_conditions[i].consequate_")
    $consectetur_00 = $jResp.IntOf("ticket_form.agent_conditions[i].consectetur_00")
    $laborum50 = $jResp.StringOf("ticket_form.agent_conditions[i].laborum50")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("ticket_form.end_user_conditions")
while ($i -lt $count_i) {
    $jResp.I = $i
    $irure__c = $jResp.BoolOf("ticket_form.end_user_conditions[i].irure__c")
    $Excepteur_38 = $jResp.StringOf("ticket_form.end_user_conditions[i].Excepteur_38")
    $sunt_8 = $jResp.StringOf("ticket_form.end_user_conditions[i].sunt_8")
    $nulla_48 = $jResp.StringOf("ticket_form.end_user_conditions[i].nulla_48")
    $ullamco_f6 = $jResp.StringOf("ticket_form.end_user_conditions[i].ullamco_f6")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("ticket_form.restricted_brand_ids")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("ticket_form.restricted_brand_ids[i]")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("ticket_form.ticket_field_ids")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("ticket_form.ticket_field_ids[i]")
    $i = $i + 1
}

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/ticket_forms/:ticket_form_id

Postman Collection Item JSON

{
  "name": "Show Ticket Form",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/ticket_forms/:ticket_form_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "ticket_forms",
        ":ticket_form_id"
      ],
      "variable": [
        {
          "key": "ticket_form_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed For\n\n* Admins, Agents, and End Users\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/ticket_forms/:ticket_form_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ticket_forms",
            ":ticket_form_id"
          ],
          "variable": [
            {
              "key": "ticket_form_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"ticket_form\": {\n    \"name\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"agent_conditions\": [\n      {\n        \"aliqua6\": \"proident deserunt\",\n        \"Lorem_d\": \"cillum dolor Excepteur ut\",\n        \"mollit_cf\": -33059877,\n        \"ullamco_f7\": \"dolore occaeca\"\n      },\n      {\n        \"consequate_\": 29214347.18513973,\n        \"consectetur_00\": 83697330,\n        \"laborum50\": \"cillum Ut\"\n      }\n    ],\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"display_name\": \"<string>\",\n    \"end_user_conditions\": [\n      {\n        \"irure__c\": false,\n        \"Excepteur_38\": -15203265.607602075,\n        \"sunt_8\": \"culpa laboris Ut\"\n      },\n      {\n        \"nulla_48\": \"quis esse\",\n        \"ullamco_f6\": -25516091.19614251\n      }\n    ],\n    \"end_user_visible\": \"<boolean>\",\n    \"id\": \"<integer>\",\n    \"in_all_brands\": \"<boolean>\",\n    \"position\": \"<integer>\",\n    \"raw_display_name\": \"<string>\",\n    \"raw_name\": \"<string>\",\n    \"restricted_brand_ids\": [\n      \"<integer>\",\n      \"<integer>\"\n    ],\n    \"ticket_field_ids\": [\n      \"<integer>\",\n      \"<integer>\"\n    ],\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}