GET api/v1/devices/ByType/{type}?offset={offset}&limit={limit}
Returns a simple summary list of devices by the type specified.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
type |
Device type (e.g. "Particle" or "Mqtt") |
string |
Required |
offset |
Number of devices to skip for pagination |
integer |
Default value is 0 |
limit |
Number of devices to limit to for pagination (default 1000) |
integer |
Default value is 1000 |
Body Parameters
None.
Response Information
Resource Description
Collection of DeviceSummaryDtoName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
UserName | string |
None. |
|
DisplayName | string |
None. |
|
Description | string |
None. |
|
Tags | Collection of string |
None. |
|
Links | Collection of LinkDto |
None. |
|
Actions | Collection of LinkDto |
None. |
Response Formats
application/json, text/json, application/senml+json
Sample:
[ { "Id": "96dc0628-2adf-47b3-a1ff-92e70c1194ff", "UserName": "sample string 2", "DisplayName": "sample string 3", "Description": "sample string 4", "Tags": [ "sample string 1", "sample string 2" ], "Links": [ { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" } ], "Actions": [ { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" } ] }, { "Id": "96dc0628-2adf-47b3-a1ff-92e70c1194ff", "UserName": "sample string 2", "DisplayName": "sample string 3", "Description": "sample string 4", "Tags": [ "sample string 1", "sample string 2" ], "Links": [ { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" } ], "Actions": [ { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" } ] } ]
application/xml, text/xml
Sample:
<ArrayOfDeviceSummaryDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.Models.Devices"> <DeviceSummaryDto> <Actions xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared"> <d3p1:LinkViewModel> <d3p1:Action>sample string 3</d3p1:Action> <d3p1:Href>sample string 1</d3p1:Href> <d3p1:Rel>sample string 2</d3p1:Rel> </d3p1:LinkViewModel> <d3p1:LinkViewModel> <d3p1:Action>sample string 3</d3p1:Action> <d3p1:Href>sample string 1</d3p1:Href> <d3p1:Rel>sample string 2</d3p1:Rel> </d3p1:LinkViewModel> </Actions> <Description>sample string 4</Description> <DisplayName>sample string 3</DisplayName> <Id>96dc0628-2adf-47b3-a1ff-92e70c1194ff</Id> <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared"> <d3p1:LinkViewModel> <d3p1:Action>sample string 3</d3p1:Action> <d3p1:Href>sample string 1</d3p1:Href> <d3p1:Rel>sample string 2</d3p1:Rel> </d3p1:LinkViewModel> <d3p1:LinkViewModel> <d3p1:Action>sample string 3</d3p1:Action> <d3p1:Href>sample string 1</d3p1:Href> <d3p1:Rel>sample string 2</d3p1:Rel> </d3p1:LinkViewModel> </Links> <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Tags> <UserName>sample string 2</UserName> </DeviceSummaryDto> <DeviceSummaryDto> <Actions xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared"> <d3p1:LinkViewModel> <d3p1:Action>sample string 3</d3p1:Action> <d3p1:Href>sample string 1</d3p1:Href> <d3p1:Rel>sample string 2</d3p1:Rel> </d3p1:LinkViewModel> <d3p1:LinkViewModel> <d3p1:Action>sample string 3</d3p1:Action> <d3p1:Href>sample string 1</d3p1:Href> <d3p1:Rel>sample string 2</d3p1:Rel> </d3p1:LinkViewModel> </Actions> <Description>sample string 4</Description> <DisplayName>sample string 3</DisplayName> <Id>96dc0628-2adf-47b3-a1ff-92e70c1194ff</Id> <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared"> <d3p1:LinkViewModel> <d3p1:Action>sample string 3</d3p1:Action> <d3p1:Href>sample string 1</d3p1:Href> <d3p1:Rel>sample string 2</d3p1:Rel> </d3p1:LinkViewModel> <d3p1:LinkViewModel> <d3p1:Action>sample string 3</d3p1:Action> <d3p1:Href>sample string 1</d3p1:Href> <d3p1:Rel>sample string 2</d3p1:Rel> </d3p1:LinkViewModel> </Links> <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Tags> <UserName>sample string 2</UserName> </DeviceSummaryDto> </ArrayOfDeviceSummaryDto>