com.sitewhere.web.rest.controllers

Class InvocationsController

java.lang.Object

com.sitewhere.web.rest.RestController

com.sitewhere.web.rest.controllers.InvocationsController

@Controller
@RequestMapping(value="/invocations")
public class InvocationsController
extends RestController

Controller for command invocation operations.

Author:

Derek Adams

Constructor Summary

Constructors

Constructor and Description
InvocationsController()

Method Summary

Methods

Modifier and Type	Method and Description
com.sitewhere.spi.device.event.IDeviceCommandInvocation	getDeviceCommandInvocation(String id, javax.servlet.http.HttpServletRequest servletRequest) Get a command invocation by unique id.
com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary	getDeviceCommandInvocationSummary(String id, javax.servlet.http.HttpServletRequest servletRequest) Get a summarized version of the given device command invocation.
com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.event.IDeviceCommandResponse>	listCommandInvocationResponses(String id, javax.servlet.http.HttpServletRequest servletRequest) List all responses for a command invocation.

Methods inherited from class com.sitewhere.web.rest.RestController

getTenant, getTenantAuthToken, handleAccessDenied, handleMissingContent, handleRuntimeException, handleSuccessfulAdd, handleSystemException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InvocationsController

public InvocationsController()

Method Detail

getDeviceCommandInvocation

@RequestMapping(value="/{id}",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.device.event.IDeviceCommandInvocation getDeviceCommandInvocation(@PathVariable
                                                                                                                     String id,
                                                                                                                     javax.servlet.http.HttpServletRequest servletRequest)
                                                                                   throws com.sitewhere.spi.SiteWhereException

Get a command invocation by unique id.

Parameters:

criteria -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getDeviceCommandInvocationSummary

@RequestMapping(value="/{id}/summary",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary getDeviceCommandInvocationSummary(@PathVariable
                                                                                                                                              String id,
                                                                                                                                              javax.servlet.http.HttpServletRequest servletRequest)
                                                                                                            throws com.sitewhere.spi.SiteWhereException

Get a summarized version of the given device command invocation.

Parameters:

criteria -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

listCommandInvocationResponses

@RequestMapping(value="/{id}/responses",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.event.IDeviceCommandResponse> listCommandInvocationResponses(@PathVariable
                                                                                                                                                                String id,
                                                                                                                                                                javax.servlet.http.HttpServletRequest servletRequest)
                                                                                                                              throws com.sitewhere.spi.SiteWhereException

List all responses for a command invocation.

Parameters:

assignmentToken -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException