|
|
@ -90,53 +90,66 @@ public interface DeviceManagementService {
|
|
|
|
message = "Internal Server ErrorResponse. \n Server error occurred while fetching the device list.",
|
|
|
|
message = "Internal Server ErrorResponse. \n Server error occurred while fetching the device list.",
|
|
|
|
response = ErrorResponse.class)
|
|
|
|
response = ErrorResponse.class)
|
|
|
|
})
|
|
|
|
})
|
|
|
|
@Permission(scope = "device-list", permissions = {"/permission/admin/device-mgt/admin/devices/list"})
|
|
|
|
@Permission(
|
|
|
|
|
|
|
|
scope = "device-list",
|
|
|
|
|
|
|
|
permissions = {"/permission/admin/device-mgt/admin/devices/list"}
|
|
|
|
|
|
|
|
)
|
|
|
|
Response getDevices(
|
|
|
|
Response getDevices(
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "type",
|
|
|
|
name = "type",
|
|
|
|
value = "The device type, such as ios, android or windows.",
|
|
|
|
value = "The device type, such as ios, android or windows.",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@QueryParam("type") String type,
|
|
|
|
@QueryParam("type")
|
|
|
|
|
|
|
|
String type,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "user", value = "Username of owner of the devices.",
|
|
|
|
name = "user",
|
|
|
|
|
|
|
|
value = "Username of owner of the devices.",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@QueryParam("user") String user,
|
|
|
|
@QueryParam("user")
|
|
|
|
|
|
|
|
String user,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "roleName",
|
|
|
|
name = "roleName",
|
|
|
|
value = "Role name of the devices to be fetched.",
|
|
|
|
value = "Role name of the devices to be fetched.",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@QueryParam("roleName") String roleName,
|
|
|
|
@QueryParam("roleName")
|
|
|
|
|
|
|
|
String roleName,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "ownership",
|
|
|
|
name = "ownership",
|
|
|
|
allowableValues = "BYOD, COPE",
|
|
|
|
allowableValues = "BYOD, COPE",
|
|
|
|
value = "Ownership of the devices to be fetched registered under.",
|
|
|
|
value = "Ownership of the devices to be fetched registered under.",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@QueryParam("ownership") String ownership,
|
|
|
|
@QueryParam("ownership")
|
|
|
|
|
|
|
|
String ownership,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "status",
|
|
|
|
name = "status",
|
|
|
|
value = "Enrollment status of devices to be fetched.",
|
|
|
|
value = "Enrollment status of devices to be fetched.",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@QueryParam("status") String status,
|
|
|
|
@QueryParam("status")
|
|
|
|
|
|
|
|
String status,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "since",
|
|
|
|
name = "since",
|
|
|
|
value = "Last modified timestamp",
|
|
|
|
value = "Last modified timestamp",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@QueryParam("since") String since,
|
|
|
|
@QueryParam("since")
|
|
|
|
|
|
|
|
String since,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "If-Modified-Since",
|
|
|
|
name = "If-Modified-Since",
|
|
|
|
value = "Timestamp of the last modified date",
|
|
|
|
value = "Timestamp of the last modified date",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@HeaderParam("If-Modified-Since") String timestamp,
|
|
|
|
@HeaderParam("If-Modified-Since")
|
|
|
|
|
|
|
|
String timestamp,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "offset",
|
|
|
|
name = "offset",
|
|
|
|
value = "Starting point within the complete list of items qualified.",
|
|
|
|
value = "Starting point within the complete list of items qualified.",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@QueryParam("offset") int offset,
|
|
|
|
@QueryParam("offset")
|
|
|
|
|
|
|
|
int offset,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "limit",
|
|
|
|
name = "limit",
|
|
|
|
value = "Maximum size of resource array to return.",
|
|
|
|
value = "Maximum size of resource array to return.",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@QueryParam("limit") int limit);
|
|
|
|
@QueryParam("limit")
|
|
|
|
|
|
|
|
int limit);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@GET
|
|
|
|
@GET
|
|
|
@ -184,25 +197,32 @@ public interface DeviceManagementService {
|
|
|
|
"Server error occurred while retrieving information requested device.",
|
|
|
|
"Server error occurred while retrieving information requested device.",
|
|
|
|
response = ErrorResponse.class)
|
|
|
|
response = ErrorResponse.class)
|
|
|
|
})
|
|
|
|
})
|
|
|
|
@Permission(scope = "device-view", permissions = {
|
|
|
|
@Permission(
|
|
|
|
|
|
|
|
scope = "device-view",
|
|
|
|
|
|
|
|
permissions = {
|
|
|
|
"/permission/admin/device-mgt/admin/devices/view",
|
|
|
|
"/permission/admin/device-mgt/admin/devices/view",
|
|
|
|
"/permission/admin/device-mgt/user/devices/view"})
|
|
|
|
"/permission/admin/device-mgt/user/devices/view"
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
)
|
|
|
|
Response getDevice(
|
|
|
|
Response getDevice(
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "type",
|
|
|
|
name = "type",
|
|
|
|
value = "The device type, such as ios, android or windows.",
|
|
|
|
value = "The device type, such as ios, android or windows.",
|
|
|
|
required = true)
|
|
|
|
required = true)
|
|
|
|
@PathParam("type") String type,
|
|
|
|
@PathParam("type")
|
|
|
|
|
|
|
|
String type,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "id",
|
|
|
|
name = "id",
|
|
|
|
value = "The device identifier of the device.",
|
|
|
|
value = "The device identifier of the device.",
|
|
|
|
required = true)
|
|
|
|
required = true)
|
|
|
|
@PathParam("id") String id,
|
|
|
|
@PathParam("id")
|
|
|
|
|
|
|
|
String id,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "If-Modified-Since",
|
|
|
|
name = "If-Modified-Since",
|
|
|
|
value = "Validates if the requested variant has not been modified since the time specified",
|
|
|
|
value = "Validates if the requested variant has not been modified since the time specified",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@HeaderParam("If-Modified-Since") String ifModifiedSince);
|
|
|
|
@HeaderParam("If-Modified-Since")
|
|
|
|
|
|
|
|
String ifModifiedSince);
|
|
|
|
|
|
|
|
|
|
|
|
@GET
|
|
|
|
@GET
|
|
|
|
@Path("/{type}/{id}/features")
|
|
|
|
@Path("/{type}/{id}/features")
|
|
|
@ -263,24 +283,31 @@ public interface DeviceManagementService {
|
|
|
|
"Server error occurred while retrieving feature list of the device.",
|
|
|
|
"Server error occurred while retrieving feature list of the device.",
|
|
|
|
response = ErrorResponse.class)
|
|
|
|
response = ErrorResponse.class)
|
|
|
|
})
|
|
|
|
})
|
|
|
|
@Permission(scope = "device-search", permissions = {"/permission/admin/device-mgt/admin/devices/view",
|
|
|
|
@Permission(
|
|
|
|
"/permission/admin/device-mgt/user/devices/view"})
|
|
|
|
scope = "device-search",
|
|
|
|
|
|
|
|
permissions = {"/permission/admin/device-mgt/admin/devices/view",
|
|
|
|
|
|
|
|
"/permission/admin/device-mgt/user/devices/view"
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
)
|
|
|
|
Response getFeaturesOfDevice(
|
|
|
|
Response getFeaturesOfDevice(
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "type",
|
|
|
|
name = "type",
|
|
|
|
value = "The device type, such as ios, android or windows.",
|
|
|
|
value = "The device type, such as ios, android or windows.",
|
|
|
|
required = true)
|
|
|
|
required = true)
|
|
|
|
@PathParam("type") String type,
|
|
|
|
@PathParam("type")
|
|
|
|
|
|
|
|
String type,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "id",
|
|
|
|
name = "id",
|
|
|
|
value = "The device identifier of the device.",
|
|
|
|
value = "The device identifier of the device.",
|
|
|
|
required = true)
|
|
|
|
required = true)
|
|
|
|
@PathParam("id") String id,
|
|
|
|
@PathParam("id")
|
|
|
|
|
|
|
|
String id,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "If-Modified-Since",
|
|
|
|
name = "If-Modified-Since",
|
|
|
|
value = "Validates if the requested variant has not been modified since the time specified",
|
|
|
|
value = "Validates if the requested variant has not been modified since the time specified",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@HeaderParam("If-Modified-Since") String ifModifiedSince);
|
|
|
|
@HeaderParam("If-Modified-Since")
|
|
|
|
|
|
|
|
String ifModifiedSince);
|
|
|
|
|
|
|
|
|
|
|
|
@POST
|
|
|
|
@POST
|
|
|
|
@Path("/search-devices")
|
|
|
|
@Path("/search-devices")
|
|
|
@ -335,23 +362,28 @@ public interface DeviceManagementService {
|
|
|
|
"Server error occurred while enrolling the device.",
|
|
|
|
"Server error occurred while enrolling the device.",
|
|
|
|
response = ErrorResponse.class)
|
|
|
|
response = ErrorResponse.class)
|
|
|
|
})
|
|
|
|
})
|
|
|
|
@Permission(scope = "device-search", permissions = {"/permission/admin/device-mgt/admin/devices/list"})
|
|
|
|
@Permission(
|
|
|
|
|
|
|
|
scope = "device-search",
|
|
|
|
|
|
|
|
permissions = {"/permission/admin/device-mgt/admin/devices/list" }
|
|
|
|
|
|
|
|
)
|
|
|
|
Response searchDevices(
|
|
|
|
Response searchDevices(
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "offset",
|
|
|
|
name = "offset",
|
|
|
|
value = "Starting point within the complete list of items qualified.",
|
|
|
|
value = "Starting point within the complete list of items qualified.",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@QueryParam("offset") int offset,
|
|
|
|
@QueryParam("offset")
|
|
|
|
|
|
|
|
int offset,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "limit",
|
|
|
|
name = "limit",
|
|
|
|
value = "Maximum size of resource array to return.",
|
|
|
|
value = "Maximum size of resource array to return.",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@QueryParam("limit") int limit,
|
|
|
|
@QueryParam("limit")
|
|
|
|
|
|
|
|
int limit,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "searchContext",
|
|
|
|
name = "searchContext",
|
|
|
|
value = "List of search conditions.",
|
|
|
|
value = "List of search conditions.",
|
|
|
|
required = true)
|
|
|
|
required = true)
|
|
|
|
SearchContext searchContext);
|
|
|
|
SearchContext searchContext);
|
|
|
|
|
|
|
|
|
|
|
|
@GET
|
|
|
|
@GET
|
|
|
|
@Path("/{type}/{id}/applications")
|
|
|
|
@Path("/{type}/{id}/applications")
|
|
|
@ -378,7 +410,8 @@ public interface DeviceManagementService {
|
|
|
|
"Used by caches, or in conditional requests."),
|
|
|
|
"Used by caches, or in conditional requests."),
|
|
|
|
@ResponseHeader(
|
|
|
|
@ResponseHeader(
|
|
|
|
name = "Last-Modified",
|
|
|
|
name = "Last-Modified",
|
|
|
|
description = "Date and time the resource has been modified the last time.\n" +
|
|
|
|
description = "Date and time the resource has been modified the "
|
|
|
|
|
|
|
|
+ "last time.\n" +
|
|
|
|
"Used by caches, or in conditional requests.")}),
|
|
|
|
"Used by caches, or in conditional requests.")}),
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 303,
|
|
|
|
code = 303,
|
|
|
@ -391,14 +424,16 @@ public interface DeviceManagementService {
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 304,
|
|
|
|
code = 304,
|
|
|
|
message = "Not Modified. \n " +
|
|
|
|
message = "Not Modified. \n " +
|
|
|
|
"Empty body because the client already has the latest version of the requested resource."),
|
|
|
|
"Empty body because the client already has the latest version of the "
|
|
|
|
|
|
|
|
+ "requested resource."),
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 400,
|
|
|
|
code = 400,
|
|
|
|
message = "Bad Request. \n Invalid request or validation error.",
|
|
|
|
message = "Bad Request. \n Invalid request or validation error.",
|
|
|
|
response = ErrorResponse.class),
|
|
|
|
response = ErrorResponse.class),
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 404,
|
|
|
|
code = 404,
|
|
|
|
message = "Not Found. \n Device of which the application list is requested, is not found.",
|
|
|
|
message = "Not Found. \n Device of which the application list is requested, is "
|
|
|
|
|
|
|
|
+ "not found.",
|
|
|
|
response = ErrorResponse.class),
|
|
|
|
response = ErrorResponse.class),
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 406,
|
|
|
|
code = 406,
|
|
|
@ -406,38 +441,47 @@ public interface DeviceManagementService {
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 500,
|
|
|
|
code = 500,
|
|
|
|
message = "Internal Server ErrorResponse. \n " +
|
|
|
|
message = "Internal Server ErrorResponse. \n " +
|
|
|
|
"Server error occurred while retrieving installed application list of the device.",
|
|
|
|
"Server error occurred while retrieving installed application list of "
|
|
|
|
|
|
|
|
+ "the device.",
|
|
|
|
response = ErrorResponse.class)
|
|
|
|
response = ErrorResponse.class)
|
|
|
|
})
|
|
|
|
})
|
|
|
|
@Permission(scope = "operation-view", permissions = {
|
|
|
|
@Permission(
|
|
|
|
|
|
|
|
scope = "operation-view",
|
|
|
|
|
|
|
|
permissions = {
|
|
|
|
"/permission/admin/device-mgt/admin/devices/view",
|
|
|
|
"/permission/admin/device-mgt/admin/devices/view",
|
|
|
|
"/permission/admin/device-mgt/user/devices/view"
|
|
|
|
"/permission/admin/device-mgt/user/devices/view"
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
)
|
|
|
|
Response getInstalledApplications(
|
|
|
|
Response getInstalledApplications(
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "type",
|
|
|
|
name = "type",
|
|
|
|
value = "The device type, such as ios, android or windows.", required = true)
|
|
|
|
value = "The device type, such as ios, android or windows.", required = true)
|
|
|
|
@PathParam("type") String type,
|
|
|
|
@PathParam("type")
|
|
|
|
|
|
|
|
String type,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "id",
|
|
|
|
name = "id",
|
|
|
|
value = "The device identifier of the device.",
|
|
|
|
value = "The device identifier of the device.",
|
|
|
|
required = true)
|
|
|
|
required = true)
|
|
|
|
@PathParam("id") String id,
|
|
|
|
@PathParam("id")
|
|
|
|
|
|
|
|
String id,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "If-Modified-Since",
|
|
|
|
name = "If-Modified-Since",
|
|
|
|
value = "Validates if the requested variant has not been modified since the time specified",
|
|
|
|
value = "Validates if the requested variant has not been modified since the time specified",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@HeaderParam("If-Modified-Since") String ifModifiedSince,
|
|
|
|
@HeaderParam("If-Modified-Since")
|
|
|
|
|
|
|
|
String ifModifiedSince,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "offset",
|
|
|
|
name = "offset",
|
|
|
|
value = "Starting point within the complete list of items qualified.",
|
|
|
|
value = "Starting point within the complete list of items qualified.",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@QueryParam("offset") int offset,
|
|
|
|
@QueryParam("offset")
|
|
|
|
|
|
|
|
int offset,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "limit",
|
|
|
|
name = "limit",
|
|
|
|
value = "Maximum size of resource array to return.",
|
|
|
|
value = "Maximum size of resource array to return.",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@QueryParam("limit") int limit);
|
|
|
|
@QueryParam("limit")
|
|
|
|
|
|
|
|
int limit);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@GET
|
|
|
|
@GET
|
|
|
@ -446,9 +490,9 @@ public interface DeviceManagementService {
|
|
|
|
produces = MediaType.APPLICATION_JSON,
|
|
|
|
produces = MediaType.APPLICATION_JSON,
|
|
|
|
httpMethod = "GET",
|
|
|
|
httpMethod = "GET",
|
|
|
|
value = "Getting paginated details for operations on a device.",
|
|
|
|
value = "Getting paginated details for operations on a device.",
|
|
|
|
notes = "You will carry out many operations on a device. In a situation where you wish to view the all" +
|
|
|
|
notes = "You will carry out many operations on a device. In a situation where you wish to view "
|
|
|
|
" the operations carried out on a device it is not feasible to show all the details on one page" +
|
|
|
|
+ "the all the operations carried out on a device it is not feasible to show all the "
|
|
|
|
" therefore the details are paginated.",
|
|
|
|
+ "details on one page therefore the details are paginated.",
|
|
|
|
tags = "Device Management")
|
|
|
|
tags = "Device Management")
|
|
|
|
@ApiResponses(
|
|
|
|
@ApiResponses(
|
|
|
|
value = {
|
|
|
|
value = {
|
|
|
@ -467,7 +511,8 @@ public interface DeviceManagementService {
|
|
|
|
"Used by caches, or in conditional requests."),
|
|
|
|
"Used by caches, or in conditional requests."),
|
|
|
|
@ResponseHeader(
|
|
|
|
@ResponseHeader(
|
|
|
|
name = "Last-Modified",
|
|
|
|
name = "Last-Modified",
|
|
|
|
description = "Date and time the resource has been modified the last time.\n" +
|
|
|
|
description = "Date and time the resource has been modified the "
|
|
|
|
|
|
|
|
+ "last time.\n" +
|
|
|
|
"Used by caches, or in conditional requests.")}),
|
|
|
|
"Used by caches, or in conditional requests.")}),
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 303,
|
|
|
|
code = 303,
|
|
|
@ -480,14 +525,16 @@ public interface DeviceManagementService {
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 304,
|
|
|
|
code = 304,
|
|
|
|
message = "Not Modified. \n " +
|
|
|
|
message = "Not Modified. \n " +
|
|
|
|
"Empty body because the client already has the latest version of the requested resource."),
|
|
|
|
"Empty body because the client already has the latest version of the "
|
|
|
|
|
|
|
|
+ "requested resource."),
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 400,
|
|
|
|
code = 400,
|
|
|
|
message = "Bad Request. \n Invalid request or validation error.",
|
|
|
|
message = "Bad Request. \n Invalid request or validation error.",
|
|
|
|
response = ErrorResponse.class),
|
|
|
|
response = ErrorResponse.class),
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 404,
|
|
|
|
code = 404,
|
|
|
|
message = "Not Found. \n Device of which the operation list is requested, is not found.",
|
|
|
|
message = "Not Found. \n Device of which the operation list is requested, is not "
|
|
|
|
|
|
|
|
+ "found.",
|
|
|
|
response = ErrorResponse.class),
|
|
|
|
response = ErrorResponse.class),
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 406,
|
|
|
|
code = 406,
|
|
|
@ -495,39 +542,49 @@ public interface DeviceManagementService {
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 500,
|
|
|
|
code = 500,
|
|
|
|
message = "Internal Server ErrorResponse. \n " +
|
|
|
|
message = "Internal Server ErrorResponse. \n " +
|
|
|
|
"Server error occurred while retrieving operation list scheduled for the device.",
|
|
|
|
"Server error occurred while retrieving operation list scheduled for the "
|
|
|
|
|
|
|
|
+ "device.",
|
|
|
|
response = ErrorResponse.class)
|
|
|
|
response = ErrorResponse.class)
|
|
|
|
})
|
|
|
|
})
|
|
|
|
@Permission(scope = "operation-view", permissions = {
|
|
|
|
@Permission(
|
|
|
|
|
|
|
|
scope = "operation-view",
|
|
|
|
|
|
|
|
permissions = {
|
|
|
|
"/permission/admin/device-mgt/admin/devices/view",
|
|
|
|
"/permission/admin/device-mgt/admin/devices/view",
|
|
|
|
"/permission/admin/device-mgt/user/devices/view"
|
|
|
|
"/permission/admin/device-mgt/user/devices/view"
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
)
|
|
|
|
Response getDeviceOperations(
|
|
|
|
Response getDeviceOperations(
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "type",
|
|
|
|
name = "type",
|
|
|
|
value = "The device type, such as ios, android or windows.",
|
|
|
|
value = "The device type, such as ios, android or windows.",
|
|
|
|
required = true)
|
|
|
|
required = true)
|
|
|
|
@PathParam("type") String type,
|
|
|
|
@PathParam("type")
|
|
|
|
|
|
|
|
String type,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "id",
|
|
|
|
name = "id",
|
|
|
|
value = "The device identifier of the device.",
|
|
|
|
value = "The device identifier of the device.",
|
|
|
|
required = true)
|
|
|
|
required = true)
|
|
|
|
@PathParam("id") String id,
|
|
|
|
@PathParam("id")
|
|
|
|
|
|
|
|
String id,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "If-Modified-Since",
|
|
|
|
name = "If-Modified-Since",
|
|
|
|
value = "Validates if the requested variant has not been modified since the time specified",
|
|
|
|
value = "Validates if the requested variant has not been modified since the time "
|
|
|
|
|
|
|
|
+ "specified",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@HeaderParam("If-Modified-Since") String ifModifiedSince,
|
|
|
|
@HeaderParam("If-Modified-Since")
|
|
|
|
|
|
|
|
String ifModifiedSince,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "offset",
|
|
|
|
name = "offset",
|
|
|
|
value = "Starting point within the complete list of items qualified.",
|
|
|
|
value = "Starting point within the complete list of items qualified.",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@QueryParam("offset") int offset,
|
|
|
|
@QueryParam("offset")
|
|
|
|
|
|
|
|
int offset,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "limit",
|
|
|
|
name = "limit",
|
|
|
|
value = "Maximum size of resource array to return.",
|
|
|
|
value = "Maximum size of resource array to return.",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@QueryParam("limit") int limit);
|
|
|
|
@QueryParam("limit")
|
|
|
|
|
|
|
|
int limit);
|
|
|
|
|
|
|
|
|
|
|
|
@GET
|
|
|
|
@GET
|
|
|
|
@Path("/{type}/{id}/effective-policy")
|
|
|
|
@Path("/{type}/{id}/effective-policy")
|
|
|
@ -535,9 +592,10 @@ public interface DeviceManagementService {
|
|
|
|
produces = MediaType.APPLICATION_JSON,
|
|
|
|
produces = MediaType.APPLICATION_JSON,
|
|
|
|
httpMethod = "GET",
|
|
|
|
httpMethod = "GET",
|
|
|
|
value = "Get the effective policy calculated for a device.",
|
|
|
|
value = "Get the effective policy calculated for a device.",
|
|
|
|
notes = "When a device registers with WSO2 EMM a policy is enforced on the device. Initially the EMM " +
|
|
|
|
notes = "When a device registers with WSO2 EMM a policy is enforced on the device. Initially the "
|
|
|
|
"filters the policies based on the Platform (device type), filters based on the device ownership" +
|
|
|
|
+ "EMM filters the policies based on the Platform (device type), filters based on the "
|
|
|
|
" type , filters based on the user role or name and finally the policy is enforced on the device.",
|
|
|
|
+ "device ownership type , filters based on the user role or name and finally the policy"
|
|
|
|
|
|
|
|
+ " is enforced on the device.",
|
|
|
|
tags = "Device Management")
|
|
|
|
tags = "Device Management")
|
|
|
|
@ApiResponses(
|
|
|
|
@ApiResponses(
|
|
|
|
value = {
|
|
|
|
value = {
|
|
|
@ -555,7 +613,8 @@ public interface DeviceManagementService {
|
|
|
|
"Used by caches, or in conditional requests."),
|
|
|
|
"Used by caches, or in conditional requests."),
|
|
|
|
@ResponseHeader(
|
|
|
|
@ResponseHeader(
|
|
|
|
name = "Last-Modified",
|
|
|
|
name = "Last-Modified",
|
|
|
|
description = "Date and time the resource has been modified the last time.\n" +
|
|
|
|
description = "Date and time the resource has been modified the "
|
|
|
|
|
|
|
|
+ "last time.\n" +
|
|
|
|
"Used by caches, or in conditional requests.")}),
|
|
|
|
"Used by caches, or in conditional requests.")}),
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 303,
|
|
|
|
code = 303,
|
|
|
@ -568,14 +627,16 @@ public interface DeviceManagementService {
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 304,
|
|
|
|
code = 304,
|
|
|
|
message = "Not Modified. \n " +
|
|
|
|
message = "Not Modified. \n " +
|
|
|
|
"Empty body because the client already has the latest version of the requested resource."),
|
|
|
|
"Empty body because the client already has the latest version of the "
|
|
|
|
|
|
|
|
+ "requested resource."),
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 400,
|
|
|
|
code = 400,
|
|
|
|
message = "Bad Request. \n Invalid request or validation error.",
|
|
|
|
message = "Bad Request. \n Invalid request or validation error.",
|
|
|
|
response = ErrorResponse.class),
|
|
|
|
response = ErrorResponse.class),
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 404,
|
|
|
|
code = 404,
|
|
|
|
message = "Not Found. \n Device of which the effective policy is requested, is not found.",
|
|
|
|
message = "Not Found. \n Device of which the effective policy is requested, is "
|
|
|
|
|
|
|
|
+ "not found.",
|
|
|
|
response = ErrorResponse.class),
|
|
|
|
response = ErrorResponse.class),
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 406,
|
|
|
|
code = 406,
|
|
|
@ -583,27 +644,50 @@ public interface DeviceManagementService {
|
|
|
|
@ApiResponse(
|
|
|
|
@ApiResponse(
|
|
|
|
code = 500,
|
|
|
|
code = 500,
|
|
|
|
message = "Internal Server ErrorResponse. \n " +
|
|
|
|
message = "Internal Server ErrorResponse. \n " +
|
|
|
|
"Server error occurred while retrieving the effective policy calculated for the device.",
|
|
|
|
"Server error occurred while retrieving the effective policy calculated "
|
|
|
|
|
|
|
|
+ "for the device.",
|
|
|
|
response = ErrorResponse.class)
|
|
|
|
response = ErrorResponse.class)
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
)
|
|
|
|
Response getEffectivePolicyOfDevice(
|
|
|
|
Response getEffectivePolicyOfDevice(
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "type",
|
|
|
|
name = "type",
|
|
|
|
value = "The device type, such as ios, android or windows.",
|
|
|
|
value = "The device type, such as ios, android or windows.",
|
|
|
|
required = true)
|
|
|
|
required = true)
|
|
|
|
@PathParam("type") String type,
|
|
|
|
@PathParam("type")
|
|
|
|
|
|
|
|
String type,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "id",
|
|
|
|
name = "id",
|
|
|
|
value = "Device Identifier",
|
|
|
|
value = "Device Identifier",
|
|
|
|
required = true)
|
|
|
|
required = true)
|
|
|
|
@PathParam("id") String id,
|
|
|
|
@PathParam("id")
|
|
|
|
|
|
|
|
String id,
|
|
|
|
@ApiParam(
|
|
|
|
@ApiParam(
|
|
|
|
name = "If-Modified-Since",
|
|
|
|
name = "If-Modified-Since",
|
|
|
|
value = "Validates if the requested variant has not been modified since the time specified",
|
|
|
|
value = "Validates if the requested variant has not been modified since the time "
|
|
|
|
|
|
|
|
+ "specified",
|
|
|
|
required = false)
|
|
|
|
required = false)
|
|
|
|
@HeaderParam("If-Modified-Since") String ifModifiedSince);
|
|
|
|
@HeaderParam("If-Modified-Since")
|
|
|
|
|
|
|
|
String ifModifiedSince);
|
|
|
|
|
|
|
|
|
|
|
|
@GET
|
|
|
|
@GET
|
|
|
|
@Path("/types")
|
|
|
|
@Path("/types")
|
|
|
|
|
|
|
|
@ApiOperation(
|
|
|
|
|
|
|
|
produces = MediaType.APPLICATION_JSON,
|
|
|
|
|
|
|
|
httpMethod = "GET",
|
|
|
|
|
|
|
|
value = "Get the device type.",
|
|
|
|
|
|
|
|
notes = "You are able to register Android, iOS and Windows devices with WSO2 EMM. In order to"
|
|
|
|
|
|
|
|
+ "retrieve the device type details that are registered this end-point van be used.",
|
|
|
|
|
|
|
|
tags = "Device Management")
|
|
|
|
|
|
|
|
@ApiResponses(
|
|
|
|
|
|
|
|
value = {
|
|
|
|
|
|
|
|
@ApiResponse(
|
|
|
|
|
|
|
|
code = 200,
|
|
|
|
|
|
|
|
message = "OK. \n Registered device types have successfully retrieved"),
|
|
|
|
|
|
|
|
@ApiResponse(
|
|
|
|
|
|
|
|
code = 500,
|
|
|
|
|
|
|
|
message = "Error occurred while fetching the list of device types.")
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
)
|
|
|
|
Response getDeviceTypes();
|
|
|
|
Response getDeviceTypes();
|
|
|
|
}
|
|
|
|
}
|
|
|
|