Chilkat Online Tools

SQL Server / Anypoint Platform APIs / Create an api group

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

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

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'name', 'myAPIseg'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'versions[0].name', 'v1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'versions[0].instances[0].environmentId', '{{environment_id}}'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'versions[0].instances[0].groupInstanceLabel', 'technet'

    -- Adds the "Authorization: Bearer {{token}}" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '{{token}}'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/apimanager/api/v1/organizations/{{organization_id}}/groups', 'application/json', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json


END
GO

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