Retrieves models

GET 
https://apis.<domain>/iot/models

Retrieves a list of models. Due to performance concerns, data is retrieved in subsets. The API must ensure that the entire dataset is consumed either by making subsequent requests, or by increasing the subset size of the initial request.

Authorization Action:

core:models:list

Request

Query Parameters

limit integer
Possible values: >= 1 and <= 100
Size of the subset to retrieve.
Default value: 10
offset integer
Possible values: >= 0
Number of items to skip during retrieval.
Default value: 0
name string

Name filter. Filtering is performed as a case-insensitive partial match.

order string
Possible values: [name, id]
Order type.
Default value: id
dir string
Possible values: [asc, desc]
Order direction.
Default value: desc
metadata object

Metadata filter. Filtering is performed matching the parameter with metadata on top level. Parameter is json.

tag string

Tag filter. Filtering is performed as a case-insensitive match.

tenant string

Possible values: <= 64 characters

Tenant filter. Used to filter models by specific tenant.

Responses

200

List of models with pagination info.

application/json

Schema

Schema

totalinteger
offsetinteger
limitinteger
models object[]
Array [
idstring<uuid>
Unique model identifier.
namestring
Free-form model name.
descriptionstring
Free-form model description.
metadataobject
Arbitrary, object-encoded model data.
tagsstring[]
List of tags associated with the model.
tenantsstring[]
List of tenants that can access this model.
imagestring
URL to model image.
created_atstring<date-time>
Time when the model was created.
updated_atstring<date-time>
Time when the model was last updated.
]

Example (auto)

{
  "total": 0,
  "offset": 0,
  "limit": 0,
  "models": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "metadata": {},
      "tags": [
        "string"
      ],
      "tenants": [
        "string"
      ],
      "image": "string",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  ]
}

400

Failed due to malformed query parameters.

401

Missing or invalid access token provided.

422

Database can't process request.

500

Unexpected server error.

application/json

Schema

Schema

stringstring<byte>

Example (auto)

"string"

Authorization: http

name: bearerTokentype: httpscheme: bearerin: headerdescription: Authorization Header: `Authorization: Bearer <user_token>`

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://apis.<domain>/iot/models");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://apis.<domain>

Auth

Bearer Token

Parameters

limit — query

offset — query

name — query

order — query

---nameid

dir — query

---ascdesc

metadata — query

tag — query

tenant — query