Chilkat Online Tools

Ruby / Anypoint Platform APIs / Create a custom field [number]

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "dataType": "number",
#   "displayName": "UX Factor",
#   "tagKey": "uxFactor"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("dataType","number")
json.UpdateString("displayName","UX Factor")
json.UpdateString("tagKey","uxFactor")

# Adds the "Authorization: Bearer {{token}}" header.
http.put_AuthToken("{{token}}")

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/exchange/api/v2/organizations/{{organization_id}}/fields","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X POST
	-H "Authorization: Bearer {{token}}"
	-d '{
	"dataType": "number",
	"displayName": "UX Factor",
	"tagKey": "uxFactor"
  }'
https://domain.com/exchange/api/v2/organizations/{{organization_id}}/fields

Postman Collection Item JSON

{
  "name": "Create a custom field [number]",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{token}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n\t\"dataType\": \"number\",\r\n\t\"displayName\": \"UX Factor\",\r\n\t\"tagKey\": \"uxFactor\"\r\n  }",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{url}}/exchange/api/v2/organizations/{{organization_id}}/fields",
      "host": [
        "{{url}}"
      ],
      "path": [
        "exchange",
        "api",
        "v2",
        "organizations",
        "{{organization_id}}",
        "fields"
      ]
    }
  },
  "response": [
  ]
}