Chilkat Online Tools

TCL / Anypoint Platform APIs / Create a custom field [enum]

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

# 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": "enum",
#   "acceptedValues": [
#     "OAS",
#     "RAML"
#   ],
#   "displayName": "SubType",
#   "tagKey": "subType"
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "dataType" "enum"
CkJsonObject_UpdateString $json "acceptedValues[0]" "OAS"
CkJsonObject_UpdateString $json "acceptedValues[1]" "RAML"
CkJsonObject_UpdateString $json "displayName" "SubType"
CkJsonObject_UpdateString $json "tagKey" "subType"

# Adds the "Authorization: Bearer {{token}}" header.
CkHttp_put_AuthToken $http "{{token}}"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/exchange/api/v2/organizations/{{organization_id}}/fields" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json

Curl Command

curl -X POST
	-H "Authorization: Bearer {{token}}"
	-d '{
	"dataType": "enum",
	"acceptedValues": ["OAS","RAML"],
	"displayName": "SubType",
	"tagKey": "subType"
  }'
https://domain.com/exchange/api/v2/organizations/{{organization_id}}/fields

Postman Collection Item JSON

{
  "name": "Create a custom field [enum]",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{token}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n\t\"dataType\": \"enum\",\r\n\t\"acceptedValues\": [\"OAS\",\"RAML\"],\r\n\t\"displayName\": \"SubType\",\r\n\t\"tagKey\": \"subType\"\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": [
  ]
}