Chilkat Online Tools

Ruby / Anypoint Platform APIs / Create an api group

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.

# {
#   "name": "myAPIseg",
#   "versions": [
#     {
#       "name": "v1",
#       "instances": [
#         {
#           "environmentId": "{{environment_id}}",
#           "groupInstanceLabel": "technet",
#           "apiInstances": [
#             {}
#           ]
#         }
#       ]
#     }
#   ]
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("name","myAPIseg")
json.UpdateString("versions[0].name","v1")
json.UpdateString("versions[0].instances[0].environmentId","{{environment_id}}")
json.UpdateString("versions[0].instances[0].groupInstanceLabel","technet")

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

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/apimanager/api/v1/organizations/{{organization_id}}/groups","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 '{
   "name":"myAPIseg",
   "versions":[
      {
         "name":"v1",
         "instances":[
            {
               "environmentId":"{{environment_id}}",
               "groupInstanceLabel":"technet",
               "apiInstances":[
                  {{api_Id}}
               ]
            }
         ]
      }
   ]
}'
https://domain.com/apimanager/api/v1/organizations/{{organization_id}}/groups

Postman Collection Item JSON

{
  "name": "Create an api group",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{token}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n   \"name\":\"myAPIseg\",\r\n   \"versions\":[\r\n      {\r\n         \"name\":\"v1\",\r\n         \"instances\":[\r\n            {\r\n               \"environmentId\":\"{{environment_id}}\",\r\n               \"groupInstanceLabel\":\"technet\",\r\n               \"apiInstances\":[\r\n                  {{api_Id}}\r\n               ]\r\n            }\r\n         ]\r\n      }\r\n   ]\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{url}}/apimanager/api/v1/organizations/{{organization_id}}/groups",
      "host": [
        "{{url}}"
      ],
      "path": [
        "apimanager",
        "api",
        "v1",
        "organizations",
        "{{organization_id}}",
        "groups"
      ]
    }
  },
  "response": [
  ]
}