Chilkat Online Tools

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

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$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"
// }

$json = new CkJsonObject();
$json->UpdateString('dataType','enum');
$json->UpdateString('acceptedValues[0]','OAS');
$json->UpdateString('acceptedValues[1]','RAML');
$json->UpdateString('displayName','SubType');
$json->UpdateString('tagKey','subType');

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

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

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