{"type":"api","title":"Get Groups","meta":{"id":"/apps/pubhub/media/edm-api-v2/a2a30bcc9ecab5281b65761ae61df7e0031d5691/f67a4e01-0023-334a-9a4a-7e606c2ef1a2","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/v1","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":{"description":"Returns a list of group names that matches the query conditions (in a paginated way)\u003cbr /\u003e One of the below permissions is needed to invoke this API\u003cbr /\u003e- Tenant Management\u003cbr /\u003e- Manage Devices\u003cbr /\u003e- Manage Firmware Upgrades\u003cbr /\u003e- Manage Groups\u003cbr /\u003e- Add Devices","operationId":"getGroups","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"},{"description":"group type","enum":["CONFIG","FIRMWARE","GENERAL","TUNNEL"],"in":"query","name":"groupType","required":true,"type":"string"},{"description":"deviceType based on which the group info to be returned","in":"query","name":"deviceType","required":false,"type":"string"},{"description":"filter query for group search. Expected values - \"deviceType:\u003cvalue\u003e groupName:\u003cvalue\u003e\"","in":"query","name":"filter","required":false,"type":"string"},{"description":"Free form string used to perform a key set search query on name, description, deviceType","in":"query","name":"search","required":false,"type":"string"},{"description":"Available options - [name, deviceType]","in":"query","name":"sortBy","required":false,"type":"string"},{"description":"Available options - [ASC, DESC]","in":"query","name":"sortDir","required":false,"type":"string"},{"default":0,"description":"page number requested to be displayed","in":"query","minimum":0,"name":"page","required":false,"type":"integer"},{"default":20,"description":"The numbers of items to return","in":"query","maximum":200,"minimum":1,"name":"size","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"successful retrieval","schema":{"properties":{"objectType":{"description":"PagedGroupVo","example":"PagedGroupVo","type":"string"},"page":{"example":0},"results":{"items":{"properties":{"deviceCategory":{"example":"IOTGATEWAY","type":"string"},"deviceType":{"example":"ig"},"deviceTypeText":{"example":"IG"},"groupDescription":{"example":""},"groupName":{"example":0,"type":"string"},"groupSubType":{"example":"Legacy","type":"string"},"groupType":{"example":"CONFIG","type":"string"},"id":{"example":58006},"isDefault":{"example":false},"lastUpdated":{"example":"2022-11-05T00:35:01.000Z","type":"string"}},"type":"object","$$ref":"#/definitions/createGroupResponse"},"type":"array"},"size":{"example":20},"total":{"example":180}},"type":"object","$$ref":"#/definitions/PagedGroupVo"}},"400":{"description":"Invalid input","schema":{"description":"Specifies the error that occurred during the group api request.","example":{"error":"Bad Request","message":"Required request parameter 'groupType' for method parameter type String is not present","path":null,"status":400,"timestamp":1676529592136},"type":"object","$$ref":"#/definitions/GroupError"}},"401":{"description":"Unauthorized","schema":{"example":"Unauthorized","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":"Get existing groups based on certain criteria","tags":["groups"],"__originalOperationId":"getGroups","security":[{"bearerAuth":[]}],"method":"get","path":"/groups"}}