Implement Device Tagging Feature #492

There is no content yet.

This implementation does not have a way to retrieve a device with all tags it has. It only provide assigned tags along with a device, if filtered by tags.

This implementation does not have a way to retrieve a device with all tags it has. It only provide assigned tags along with a device, if filtered by tags.

I'm assuming what mentioned above is that if we do not provide tags as a query parameter in the search filter, it will not provide the tags.

In the implementation, if you call the getDevices method without any params, it will return the list of all devices with a payload like this.

https://{{server-ip}}:{{port}}/api/device-mgt/v1.0/devices

{
    "devices": [
        {
            "id": 1,
            "name": "device1",
            "type": "power-meter",
            "deviceIdentifier": "meter-1",
            "lastUpdatedTimeStamp": 1723800132280,
            "enrolmentInfo": {
                "id": 7,
                "isTransferred": false,
                "dateOfEnrolment": 1723800317986,
                "dateOfLastUpdate": 1723800317986,
                "ownership": "BYOD",
                "status": "ACTIVE",
                "owner": "admin",
                "tags": [
                    "checkinggggg",
                    "new",
                    "tagss"
                ]
            },
            "cost": 0.0,
            "daysUsed": 0,
            "deviceStatusInfo": []
        },
        {
            "id": 2,
            "name": "device2",
            "type": "power-meter",
            "deviceIdentifier": "meter-2",
            "lastUpdatedTimeStamp": 1723800133281,
            "enrolmentInfo": {
                "id": 8,
                "isTransferred": false,
                "dateOfEnrolment": 1723800317986,
                "dateOfLastUpdate": 1723800317986,
                "ownership": "BYOD",
                "status": "ACTIVE",
                "owner": "admin",
                "tags": []
            },
            "cost": 0.0,
            "daysUsed": 0,
            "deviceStatusInfo": []
        },
        {
            "id": 3,
            "name": "device3",
            "type": "power-meter",
            "deviceIdentifier": "meter-3",
            "lastUpdatedTimeStamp": 1723800134281,
            "enrolmentInfo": {
                "id": 9,
                "isTransferred": false,
                "dateOfEnrolment": 1723800317986,
                "dateOfLastUpdate": 1723800317986,
                "ownership": "BYOD",
                "status": "ACTIVE",
                "owner": "admin",
                "tags": []
            },
            "cost": 0.0,
            "daysUsed": 0,
            "deviceStatusInfo": []
        },
        {
            "id": 4,
            "name": "device4",
            "type": "power-meter",
            "deviceIdentifier": "meter-4",
            "lastUpdatedTimeStamp": 1723800135283,
            "enrolmentInfo": {
                "id": 10,
                "isTransferred": false,
                "dateOfEnrolment": 1723800317986,
                "dateOfLastUpdate": 1723800317986,
                "ownership": "BYOD",
                "status": "ACTIVE",
                "owner": "admin",
                "tags": [
                    "checkinggggg",
                    "sds",
                    "tagss"
                ]
            },
            "cost": 0.0,
            "daysUsed": 0,
            "deviceStatusInfo": []
        },
        {
            "id": 5,
            "name": "device5",
            "type": "power-meter",
            "deviceIdentifier": "meter-5",
            "lastUpdatedTimeStamp": 1723800136283,
            "enrolmentInfo": {
                "id": 11,
                "isTransferred": false,
                "dateOfEnrolment": 1723800317986,
                "dateOfLastUpdate": 1723800317986,
                "ownership": "BYOD",
                "status": "ACTIVE",
                "owner": "admin",
                "tags": []
            },
            "cost": 0.0,
            "daysUsed": 0,
            "deviceStatusInfo": []
        }
    ],
    "totalCost": 0.0,
    "deviceCount": 0.0,
    "count": 5
}

Scenario 2
If we provide a tag like 'tagss' in the query parameter, then it will filter by those.

https://{{server-ip}}:{{port}}/api/device-mgt/v1.0/devices?tags=tagss


{
    "devices": [
        {
            "id": 1,
            "name": "device1",
            "type": "power-meter",
            "deviceIdentifier": "meter-1",
            "lastUpdatedTimeStamp": 1723800132280,
            "enrolmentInfo": {
                "id": 7,
                "isTransferred": false,
                "dateOfEnrolment": 1723800317986,
                "dateOfLastUpdate": 1723800317986,
                "ownership": "BYOD",
                "status": "ACTIVE",
                "owner": "admin",
                "tags": [
                    "checkinggggg",
                    "new",
                    "tagss"
                ]
            },
            "cost": 0.0,
            "daysUsed": 0,
            "deviceStatusInfo": []
        },
        {
            "id": 4,
            "name": "device4",
            "type": "power-meter",
            "deviceIdentifier": "meter-4",
            "lastUpdatedTimeStamp": 1723800135283,
            "enrolmentInfo": {
                "id": 10,
                "isTransferred": false,
                "dateOfEnrolment": 1723800317986,
                "dateOfLastUpdate": 1723800317986,
                "ownership": "BYOD",
                "status": "ACTIVE",
                "owner": "admin",
                "tags": [
                    "checkinggggg",
                    "sds",
                    "tagss"
                ]
            },
            "cost": 0.0,
            "daysUsed": 0,
            "deviceStatusInfo": []
        }
    ],
    "totalCost": 0.0,
    "deviceCount": 0.0,
    "count": 2
}

So according to the requirement mentioned above, as I understand it, even if we provide a filter or not, it returns the attached tags within the payload.

Hoping i got this correct :)

PS: All the other requested changes except above are updated

             produces = MediaType.APPLICATION_JSON,
             httpMethod = "GET",
             value = "Getting the List of Tags",
             notes = "",

     @Override
     public Response updateTag(@QueryParam("tagId") Integer tagId, @QueryParam("tagName") String tagName, TagInfo tagInfo) {
         RequestValidationUtil.validateTagDetails(tagId, tagName, tagInfo);
         try {

                 tag = DeviceMgtAPIUtils.getTagManagementService().getTagByName(tagName);
             }
             if (tag == null) {
                 String msg = "Tag not found.";

     public Response addDeviceTagMapping(TagMappingInfo tagMappingInfo) {
         RequestValidationUtil.validateTagMappingDetails(tagMappingInfo);
         try {
             TagMappingDTO tagMappingDTO = new TagMappingDTO(tagMappingInfo.getDeviceIdentifiers(),

                     new ErrorResponse.ErrorResponseBuilder().setCode(400l).setMessage(msg).build());
         }
         if (tagInfo == null) {
             throw new InputValidationException(

                 return Response.status(Response.Status.OK).entity(devices).build();
             }
             if (tags != null && !tags.isEmpty()) {

         }
     }
     public static void validateTagDetails(Integer tagId, String tagName, TagInfo tagInfo) {

         }
     }
     public static void validateTagMappingDetails(TagMappingInfo tagMappingInfo) {

                     new ErrorResponse.ErrorResponseBuilder().setCode(400L).setMessage("Request body is empty").build());
         } else if (tagMappingInfo.getDeviceIdentifiers() == null || tagMappingInfo.getDeviceType() == null
                 || tagMappingInfo.getTags() == null) {
             throw new InputValidationException(

         try {
             connection = getConnection();
             preparedStatement = connection.prepareStatement(query, Statement.RETURN_GENERATED_KEYS);

             int[] updateCounts = preparedStatement.executeBatch();
             for (int count : updateCounts) {
                 if (count == PreparedStatement.EXECUTE_FAILED) {
                     throw new TagManagementDAOException("Error occurred while adding tags, adding some tags failed.");

 import io.entgra.device.mgt.core.device.mgt.common.exceptions.ConflictException;
 import io.entgra.device.mgt.core.device.mgt.common.metadata.mgt.DeviceStatusManagementService;
 import io.entgra.device.mgt.core.device.mgt.core.dao.TenantDAO;
 import io.entgra.device.mgt.core.device.mgt.core.dao.*;

         }
         try {
             int tenantId = CarbonContext.getThreadLocalCarbonContext().getTenantId();
             DeviceManagementDAOFactory.beginTransaction();

 import io.entgra.device.mgt.core.device.mgt.common.tag.mgt.Tag;
 import io.entgra.device.mgt.core.device.mgt.core.dao.*;
 import java.sql.*;

 import io.entgra.device.mgt.core.device.mgt.common.metadata.mgt.DeviceStatusManagementService;
 import io.entgra.device.mgt.core.device.mgt.core.authorization.GroupAccessAuthorizationServiceImpl;
 import io.entgra.device.mgt.core.device.mgt.core.metadata.mgt.DeviceStatusManagementServiceImpl;
 import io.entgra.device.mgt.core.device.mgt.core.service.*;

 import io.entgra.device.mgt.core.device.mgt.api.jaxrs.service.impl.util.RequestValidationUtil;
 import io.entgra.device.mgt.core.device.mgt.api.jaxrs.util.DeviceMgtAPIUtils;
 import io.entgra.device.mgt.core.device.mgt.common.exceptions.BadRequestException;
 import io.entgra.device.mgt.core.device.mgt.common.tag.mgt.*;

         }  catch (TagManagementException e) {
             String msg = "Error occurred while getting tags.";
             log.error(msg, e);
             return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(msg).build();

     public static TagManagementProviderService getTagManagementService() {
         TagManagementProviderService tagManagementService;
         PrivilegedCarbonContext ctx = PrivilegedCarbonContext.getThreadLocalCarbonContext();
         tagManagementService =

                         "FROM DM_DEVICE_TAG_MAPPING dtm " +
                         "JOIN DM_TAG t ON dtm.TAG_ID = t.ID " +
                         "WHERE t.NAME IN (";
                 for (int i = 0; i < tagList.size(); i++) {

     FOREIGN KEY (ENROLMENT_ID) REFERENCES DM_ENROLMENT(ID),
     FOREIGN KEY (TAG_ID) REFERENCES DM_TAG(ID) ON DELETE CASCADE
     );
 -- END OF DM_DEVICE_TAG_MAPPING TABLE --

         sb.append("]}\n");
         return sb.toString();
     }

 import io.entgra.device.mgt.core.apimgt.annotations.Scopes;
 import io.entgra.device.mgt.core.device.mgt.api.jaxrs.util.Constants;
 import javax.ws.rs.*;

Implement Device Tagging Feature #492

Reviewers