Skip to main content

Query Cellular Modules (v2.0)

POST 

/sdwan/v2.0/api/cellular_modules/query

Query the DB for limit number of cellular modules that match query parameters.

Request

Body

    aggregate Aggregate

    The aggregate number of cellular module that match the query parameters.

    data AggregateData[]

    The details of the aggregate data.

  • Array [
  • value number

    Value of the aggregate data.

    view object

    View the aggregate date.

  • ]
  • field string

    The field value.

    name string

    The name of the query response.

    operator string

    Possible values: [max, count, min, avg, sum]

    The operator values.

    statistic string

    The aggregate statistics.

    unit string

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number of cellular module for a time frame.

    group_by string[]

    Group the cellular module for the query.

    id string

    Lists the cellular module by ID.

    last_query_ts int64

    Return the ID of a specified query in the current session.

    limit int32

    The query limit.

    next_query object

    The limit.

    query_params object
    retrieved_fields string[]

    Retrieve information from a field.

    retrieved_fields_mask boolean

    List the fields to query.

    sort_params object
    total_count int64

    The total number of query parameters.

Responses

Successful Operation

Schema
    count int32

    The actual count.

    deleted_count int64

    The deleted number.

    deleted_ids string[]

    The deleted IDs.

    description

    Description of the query. Max size = 256.

    id string

    The ID.

    next_query object

    Details of the next query.

    total_count int64

    Total number.

    items CellularModuleQueryFilter[]
  • Array [
  • description

    The description of the cellular module. Max size = 256.

    element_id string

    The element ID.

    gps_enable booleanrequired

    Indicates if the GPS is enabled for the cellular module.

    id string

    The ID of the cellular module.

    name stringrequired

    The name of the cellular module. Max size = 128.urce name.

    primary_sim integerrequired

    The primary SIM attribute of the cellular module.

    radio_on booleanrequired

    Indicates the radio on attribute.

    tags string[]

    An information field that can be added to identify the cellular module. Maximum 10 unique tags of length 1024 each are allowed.

  • ]
Loading...