IotDash.Controllers.V1.InterfaceController Class Reference

Inheritance diagram for IotDash.Controllers.V1.InterfaceController:

Collaboration diagram for IotDash.Controllers.V1.InterfaceController:

Public Member Functions
	InterfaceController (IIdentityService identity, IInterfaceStore interfaces, IUserStore users, IHistoryStore history)
async Task< IActionResult >	GetInterfaces ()
Task< IActionResult >	GetInterface ()
async Task< IActionResult >	CreateInterface ([FromBody] InterfaceCreateRequest request)
async Task< IActionResult >	UpdateInterface ([FromBody] InterfacePatchRequest request)
async Task< IActionResult >	DeleteInterface ()
async Task< IActionResult >	GetHistory ([FromBody] HistoryRequest request)

Properties
string	BaseUrl [get]

Member Function Documentation

CreateInterface()

async Task< IActionResult > IotDash.Controllers.V1.InterfaceController.CreateInterface ( [FromBody] InterfaceCreateRequest  request )

inline

Create a new interface.

Parameters

request

Interface creation request.

Returns

The created interface and Location header with the interface uri.

DeleteInterface()

async Task< IActionResult > IotDash.Controllers.V1.InterfaceController.DeleteInterface ( )

inline

Delete a specific interface.

Returns

No content.

GetHistory()

async Task< IActionResult > IotDash.Controllers.V1.InterfaceController.GetHistory ( [FromBody] HistoryRequest  request )

inline

Get interface history over a specified time period with given point density.

Parameters

request

Time period information with point density.

Returns

List of data points.

GetInterface()

Task< IActionResult > IotDash.Controllers.V1.InterfaceController.GetInterface ( )

inline

Get information about the specific interface.

Returns

The interface information.

GetInterfaces()

async Task< IActionResult > IotDash.Controllers.V1.InterfaceController.GetInterfaces ( )

inline

Get information about all interfaces.

Returns

The interface information array.

UpdateInterface()

async Task< IActionResult > IotDash.Controllers.V1.InterfaceController.UpdateInterface ( [FromBody] InterfacePatchRequest  request )

inline

Update one or more fields of the specified interface.

Parameters

request

Update request. At least one field must be specified.

Returns

The updated interface.

---

The documentation for this class was generated from the following file:

• Controllers/V1/InterfaceController.cs