Chilkat Online Tools

Powershell / Support API / Show Organization Field

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/organization_fields/:organization_field_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)

# {
#   "organization_field": {
#     "key": "<string>",
#     "type": "<string>",
#     "title": "<string>",
#     "active": "<boolean>",
#     "created_at": "<dateTime>",
#     "custom_field_options": [
#       {
#         "name": "<string>",
#         "value": "<string>",
#         "id": "<integer>",
#         "position": "<integer>",
#         "raw_name": "<string>",
#         "url": "<string>"
#       },
#       {
#         "name": "<string>",
#         "value": "<string>",
#         "id": "<integer>",
#         "position": "<integer>",
#         "raw_name": "<string>",
#         "url": "<string>"
#       }
#     ],
#     "description": "<string>",
#     "id": "<integer>",
#     "position": "<integer>",
#     "raw_description": "<string>",
#     "raw_title": "<string>",
#     "regexp_for_validation": "<string>",
#     "relationship_filter": {},
#     "relationship_target_type": "<string>",
#     "system": "<boolean>",
#     "tag": "<string>",
#     "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

$Key = $jResp.StringOf("organization_field.key")
$v_Type = $jResp.StringOf("organization_field.type")
$Title = $jResp.StringOf("organization_field.title")
$Active = $jResp.StringOf("organization_field.active")
$Created_at = $jResp.StringOf("organization_field.created_at")
$Description = $jResp.StringOf("organization_field.description")
$Id = $jResp.StringOf("organization_field.id")
$Position = $jResp.StringOf("organization_field.position")
$Raw_description = $jResp.StringOf("organization_field.raw_description")
$Raw_title = $jResp.StringOf("organization_field.raw_title")
$Regexp_for_validation = $jResp.StringOf("organization_field.regexp_for_validation")
$Relationship_target_type = $jResp.StringOf("organization_field.relationship_target_type")
$System = $jResp.StringOf("organization_field.system")
$Tag = $jResp.StringOf("organization_field.tag")
$Updated_at = $jResp.StringOf("organization_field.updated_at")
$v_Url = $jResp.StringOf("organization_field.url")
$i = 0
$count_i = $jResp.SizeOfArray("organization_field.custom_field_options")
while ($i -lt $count_i) {
    $jResp.I = $i
    $name = $jResp.StringOf("organization_field.custom_field_options[i].name")
    $value = $jResp.StringOf("organization_field.custom_field_options[i].value")
    $id = $jResp.StringOf("organization_field.custom_field_options[i].id")
    $position = $jResp.StringOf("organization_field.custom_field_options[i].position")
    $raw_name = $jResp.StringOf("organization_field.custom_field_options[i].raw_name")
    $url = $jResp.StringOf("organization_field.custom_field_options[i].url")
    $i = $i + 1
}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show Organization Field",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/organization_fields/:organization_field_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organization_fields",
        ":organization_field_id"
      ],
      "variable": [
        {
          "key": "organization_field_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/organization_fields/:organization_field_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organization_fields",
            ":organization_field_id"
          ],
          "variable": [
            {
              "key": "organization_field_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"organization_field\": {\n    \"key\": \"<string>\",\n    \"type\": \"<string>\",\n    \"title\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"custom_field_options\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"position\": \"<integer>\",\n        \"raw_name\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"position\": \"<integer>\",\n        \"raw_name\": \"<string>\",\n        \"url\": \"<string>\"\n      }\n    ],\n    \"description\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"position\": \"<integer>\",\n    \"raw_description\": \"<string>\",\n    \"raw_title\": \"<string>\",\n    \"regexp_for_validation\": \"<string>\",\n    \"relationship_filter\": {},\n    \"relationship_target_type\": \"<string>\",\n    \"system\": \"<boolean>\",\n    \"tag\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}