Skip to main content

Retrieves models

GET 
/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

    Default value: 10

    Size of the subset to retrieve.

    offset integer

    Number of items to skip during retrieval.

    name string

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

    order string

    Possible values: [name, id]

    Default value: id

    Order type.

    dir string

    Possible values: [asc, desc]

    Default value: desc

    Order direction.

    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​

List of models with pagination info.

Schema
    total integer
    offset integer
    limit integer
    models object[]
  • Array [
    • id uuid

    Unique model identifier.

    name string

    Free-form model name.

    description string

    Free-form model description.

    metadata object

    Arbitrary, object-encoded model data.

    tags string[]

    List of tags associated with the model.

    tenants string[]

    List of tenants that can access this model.

    image string

    URL to model image.

    created_at date-time

    Time when the model was created.

    updated_at date-time

    Time when the model was last updated.

  • ]
Loading...