{"type":"api","title":"Create Group","meta":{"id":"/apps/pubhub/media/edm-api-v2/a2a30bcc9ecab5281b65761ae61df7e0031d5691/22db37d1-bb2c-3814-9940-2f648c7f33ab","swagger":"2.0","info":{"contact":{"email":"devmgmt@cisco.com"},"description":"This is the IoT device management core service. The service is responsible for managing the lifecycle of various IoT gateways and endpoints deployed as part of the Field Area Networks","license":{"name":"Licensing is primarily subscription based. Call Andy now!","url":"https://www.cisco.com"},"termsOfService":"http://swagger.io/terms/","title":"IoT Device Lifecycle Management","version":"4.0.0"},"host":"us.ciscoiot.com","basePath":"/nbapi/edm/v2","schemes":["https"],"securityDefinitions":{"bearerAuth":{"description":"This is the bearer Auth token.","in":"header","name":"Authorization","type":"apiKey"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"apiKeyGenerator":{"$remoteModule":"./config/apikey.js"}}},"spec":{"consumes":["application/json"],"description":"Create a new group for the given device category.\u003cbr /\u003e One of the below permissions is needed to invoke this API\u003cbr /\u003e- Tenant Management\u003cbr /\u003e- Manage Devices\u003cbr /\u003e- Manage Groups\u003cbr /\u003e- Manage Firmware Upgrades.","operationId":"createGroup","parameters":[{"description":"The uuid of the tenant in whose context we are calling the api.","format":"uuid","in":"header","name":"x-tenant-id","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"deviceType":{"description":"Device type of the devices that will be associated with this group","example":"ir800","type":"string"},"groupDescription":{"description":"Description/Purpose of the group","example":"ir800 config group","type":"string"},"groupName":{"description":"Unique name of the group","example":"ir800-cg-one","type":"string"},"groupSubType":{"description":"SubType of group, ex. extended config groups","example":"extended","type":"string"},"groupType":{"description":"Type of group to be created","enum":["CONFIG","FIRMWARE","GENERAL","TUNNEL"],"type":"string"},"templateUuid":{"description":"Uuid of the config template to be associated with the device","type":"string"}},"required":["groupName","deviceType","groupType"],"type":"object","$$ref":"#/definitions/createGroupRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"successful retrieval","schema":{"properties":{"deviceCategory":{"enum":["ENDPOINT","ROUTER","IOTGATEWAY","ACCESSPOINT","HER","SWITCH"],"example":"ROUTER","type":"string"},"deviceType":{"example":"ir800","type":"string"},"deviceTypeText":{"example":"IR800","type":"string"},"groupDescription":{"example":"ir800 config group","type":"string"},"groupName":{"example":"ir800-cg-one","type":"string"},"groupSubType":{"example":"Legacy","type":"string"},"groupType":{"enum":["CONFIG","FIRMWARE","GENERAL","TUNNEL"],"example":"CONFIG","type":"string"},"id":{"example":199,"type":"integer"},"isDefault":{"example":false,"type":"boolean"},"lastUpdated":{"example":"2023-02-13T16:42:32.000Z","type":"string"}},"required":["groupName","deviceCategory","groupType","deviceType","deviceTypeText","id","isDefault"],"type":"object","$$ref":"#/definitions/GroupVo"}},"400":{"description":"Invalid input","schema":{"description":"Specifies the error that occured during the request.","example":{"code":"10000","message":"Short message about the error","meta":"more information about that error"},"properties":{"code":{"description":"The error code that occured in application level.","type":"number"},"message":{"description":"A user readable message that describes the error in details.","type":"string"},"meta":{"description":"Contains more information about the error message. For example when a validation error occurs, this field describes the fields that were invalid and the validation error that occured. The content of this object can vary based on the type of error.\n","type":"object"}},"required":["code","message"],"type":"object","$$ref":"#/definitions/error"}},"401":{"description":"Unauthorized","schema":{"example":"Authentication Token is invalid","type":"string"}},"403":{"description":"Forbidden","schema":{"example":"Permission denied to access the resource","type":"string"}},"404":{"description":"Invalid group id supplied","schema":{"example":"Group not found by given group id","type":"string"}}},"summary":"Create device group","tags":["groupsv2"],"__originalOperationId":"createGroup","security":[{"bearerAuth":[]}],"method":"post","path":"/groups"}}