Chilkat Online Tools

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

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

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

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"dataType","enum")
    CkJsonObject::ckUpdateString(json,"acceptedValues[0]","OAS")
    CkJsonObject::ckUpdateString(json,"acceptedValues[1]","RAML")
    CkJsonObject::ckUpdateString(json,"displayName","SubType")
    CkJsonObject::ckUpdateString(json,"tagKey","subType")

    ; Adds the "Authorization: Bearer {{token}}" header.
    CkHttp::setCkAuthToken(http, "{{token}}")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/exchange/api/v2/organizations/{{organization_id}}/fields","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

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