Chilkat Online Tools

PureBasic / Anypoint Platform APIs / Create an api group

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.

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

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

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

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

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/apimanager/api/v1/organizations/{{organization_id}}/groups","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 '{
   "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": [
  ]
}