Chilkat Online Tools

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

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* 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"
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("dataType","enum")
loJson.UpdateString("acceptedValues[0]","OAS")
loJson.UpdateString("acceptedValues[1]","RAML")
loJson.UpdateString("displayName","SubType")
loJson.UpdateString("tagKey","subType")

* Adds the "Authorization: Bearer {{token}}" header.
loHttp.AuthToken = "{{token}}"

loResp = loHttp.PostJson3("https://domain.com/exchange/api/v2/organizations/{{organization_id}}/fields","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson

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": [
  ]
}