Skip to main content

Query for Toolkit Sessions (v2.0)

POST 

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

Query the DB for toolkit sessions that match query parameters.

Request

Path Parameters

    tenant_id stringrequired

    The tenant ID.

Body

    aggregate Aggregate

    The aggregate number of passages 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 passages deleted for a time frame.

    group_by string[]

    Group the passages for the query.

    id string

    List the passages 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

    Query using query parameters.

    retrieved_fields string[]

    Retrieve information from a field.

    retrieved_fields_mask boolean

    List the fields to query.

    sort_params object

    Specify the order in which you want the search criteria to display.

    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 PassageQueryFilter[]
  • Array [
  • element_id stringrequired

    The element ID.

    id string

    Id

    inactive boolean

    Indicate if passage is inactive. True or False.

    session_id stringrequired

    The session ID.

    state string

    Possible values: [ACTIVE, REMOVED, REMOVE_IN_PROGRESS]

    The passage state.

  • ]
Loading...