Chilkat Online Tools

autoit / Support API / Create Organization Field

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

Local $oResp = $oHttp.QuickRequest("POST","https://example.zendesk.com/api/v2/organization_fields")
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $sName
Local $sValue
Local $sId
Local $sPosition
Local $sRaw_name
Local $sUrl

Local $sKey = $oJResp.StringOf("organization_field.key")
Local $sV_Type = $oJResp.StringOf("organization_field.type")
Local $sTitle = $oJResp.StringOf("organization_field.title")
Local $sActive = $oJResp.StringOf("organization_field.active")
Local $sCreated_at = $oJResp.StringOf("organization_field.created_at")
Local $sDescription = $oJResp.StringOf("organization_field.description")
Local $sId = $oJResp.StringOf("organization_field.id")
Local $sPosition = $oJResp.StringOf("organization_field.position")
Local $sRaw_description = $oJResp.StringOf("organization_field.raw_description")
Local $sRaw_title = $oJResp.StringOf("organization_field.raw_title")
Local $sRegexp_for_validation = $oJResp.StringOf("organization_field.regexp_for_validation")
Local $sRelationship_target_type = $oJResp.StringOf("organization_field.relationship_target_type")
Local $sSystem = $oJResp.StringOf("organization_field.system")
Local $sTag = $oJResp.StringOf("organization_field.tag")
Local $sUpdated_at = $oJResp.StringOf("organization_field.updated_at")
Local $sV_Url = $oJResp.StringOf("organization_field.url")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("organization_field.custom_field_options")
While $i < $iCount_i
    $oJResp.I = $i
    $sName = $oJResp.StringOf("organization_field.custom_field_options[i].name")
    $sValue = $oJResp.StringOf("organization_field.custom_field_options[i].value")
    $sId = $oJResp.StringOf("organization_field.custom_field_options[i].id")
    $sPosition = $oJResp.StringOf("organization_field.custom_field_options[i].position")
    $sRaw_name = $oJResp.StringOf("organization_field.custom_field_options[i].raw_name")
    $sUrl = $oJResp.StringOf("organization_field.custom_field_options[i].url")
    $i = $i + 1
Wend

Curl Command

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

Postman Collection Item JSON

{
  "name": "Create Organization Field",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/organization_fields",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organization_fields"
      ]
    },
    "description": "Creates any of the following custom field types:\n\n* text (default when no \"type\" is specified)\n* textarea\n* checkbox\n* date\n* integer\n* decimal\n* regexp\n* dropdown\n* lookup\n\nSee [About custom field types](https://support.zendesk.com/hc/en-us/articles/203661866) in Zendesk help.\n\n#### Allowed For\n\n* Admins\n"
  },
  "response": [
    {
      "name": "Created response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/organization_fields",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organization_fields"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_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}"
    }
  ]
}