List things by model

GET 
/iot/models/:modelId/things

Retrieves list of things belonging to specified model with pagination metadata.

Authorization Action:

core:models:getThings

Request

Path Parameters

modelId uuidrequired

Unique model identifier.

Query Parameters

offset integer

Number of items to skip during retrieval.

limit integer

Possible values: >= 1 and <= 100

Default value: 10

Size of the subset to retrieve.

order string

Possible values: [name, id]

Default value: id

Order type.

dir string

Possible values: [asc, desc]

Default value: desc

Order direction.

Responses

200

Data retrieved.

application/json

Schema

Schema

things object[]
Array [
id uuidrequired
Unique thing identifier generated by the service.
name string
Free-form thing name.
key uuidrequired
Auto-generated access key.
metadata object
oneOf
DeviceMetadata
type string
Possible values: [device]
control_channel_id uuid
event_channel_id uuid
EdgeMetadata
type string
Possible values: [edge]
cfg_id string
init_id string
init_key string
control_channel_id uuid
event_channel_id uuid
description string
]
total integer

Total number of items.

offset integer

Number of items to skip during retrieval.

limit integer

Maximum number of items to return in one page.

Example (from schema)

{
  "things": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "metadata": {}
    }
  ],
  "total": 0,
  "offset": 0,
  "limit": 0
}

400

Failed due to malformed query parameters.

401

Missing or invalid access token provided.

404

Model does not exist.

422

Database can't process request.

500

Unexpected server error.

application/json

Schema

Schema

• string byte

Loading...