Skip to main content

Query DB for APN Profiles (v2.0)

POST 

/v2.0/api/tenants/:tenant_id/apnprofiles/query

Query the DB for limit number of APN profiles that match the query parameters.

Request

Path Parameters

    tenant_id stringrequired

    ID of the tenant.

Body

    aggregate Aggregate

    The aggregate number of APN profiles 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

    Field

    name string

    The name of the query response.

    operator string

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

    Operator

    statistic string

    QoS application aggregate statistics.

    unit string

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number of APN profiles for a time frame.

    group_by string[]

    Group the APN profiles for the query.

    id string

    Lists the APN profiles 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.

    tenant_id string

    The tenant ID.

    total_count int64

    Total number.

    items APNProfileQueryFilter[]
  • Array [
  • apn string

    Enter the APN name that provides access to the mobile broadband network. APN information is provided by the operator. APN name must be greater than one character and an allowed max length is 100. Valid characters are alphanumeric, hyphen (-), and period (.). Must begin and end with an alphanumeric character.

    authentication stringrequired

    Possible values: [none, pap, chap, pap_or_chap]

    Authentication mode to access the mobile broadband network.

    clear_password boolean

    Ignore this field.

    description

    Enter the name or acronym of the mobile broadband service provider or any other information that might help you to identify the APN profile. Max size = 256.

    id string

    Ignore this field.

    name stringrequired

    Enter the name or acronym to identify the APN profile. Max size = 128.

    password string

    If you select an authentication mode, enter the password to access the mobile broadband network.

    tags string[]

    Tags is a mechanism to group the content for easy retrieval. It helps to organize the content. The tags associate a relevance to the object.

    user_name string

    If you select an authentication mode, enter the user name to access the mobile broadband network. Size (max = 100, min = 0).

  • ]
Loading...