Chilkat Online Tools

Swift / Support API / Create User Field

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

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

    http.SetRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.QuickRequest("POST", url: "https://example.zendesk.com/api/v2/user_fields")
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    // {
    //   "user_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

    var name: String?
    var value: String?
    var id: String?
    var position: String?
    var raw_name: String?
    var url: String?

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


}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Create User Field",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/user_fields",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "user_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/user_fields",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "user_fields"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"user_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}"
    }
  ]
}