Skip to main content

Query Machine of Tenant (v2.3)

POST 

/sdwan/v2.3/api/machines/query

Query the machines of a tenant.

Request

Body

    aggregate Aggregate

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

    group_by string[]

    Group the machines for the query.

    id string

    List the machines 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.

    total_count int64

    Total number.

    items MachineQueryFilterV2N3[]
  • Array [
  • connected boolean

    The device is connected. True or False.

    console_conf_passphrase string

    The console password.

    em_element_id string

    The element ID.

    esp_tenant_id string

    The MSP tenant ID.

    hw_id string

    The hardware ID.

    id string

    Id

    image_version string

    The image version.

    inventory_op string

    Possible values: [CLAIM, RETURN, REVOKE, REUSE, RETIRE, RECOVER, REMANUFACTURE, DEFAULT, INVALID, ALLOCATE, RECEIVED_STOCK, ESP_ALLOCATE, ESP_RECEIVED_STOCK, ESP_RETURN, ESP_REVOKE, ESP_REUSE]

    The inventory lifecycle values.

    machine_state string

    Possible values: [MANUFACTURED, MANUFACTURED_QA_PENDING, MANUFACTURED_QA_OK, MANUFACTURED_QA_NOK, MANUFACTURED_BATTERY_TEST_PENDING, MANUFACTURED_BATTERY_TEST_START, MANUFACTURED_BATTERY_TEST_PASS, MANUFACTURED_BATTERY_TEST_FAILED, MANUFACTURED_MIC_ISSUE_PENDING, MANUFACTURED_MIC_ISSUED, MANUFACTURED_MIC_FAILED, MANUFACTURED_MIC_OPERATIONAL, MANUFACTURED_CIC_ISSUE_PENDING, MANUFACTURED_CIC_ISSUED, MANUFACTURED_CIC_REVOKED, MANUFACTURED_CIC_OPERATIONAL, MANUFACTURED_MIC_SIGNING_PENDING, MANUFACTURED_CIC_SIGNING_PENDING, MACHINE_ALLOCATED, MACHINE_ALLOCATED_TO_ESP, MACHINE_ELEMENT_ID_PENDING, MACHINE_INIT, MACHINE_INIT_FAILED, MACHINE_ASSIGNED, MACHINE_CLAIM_PENDING, MACHINE_CLAIMED, MACHINE_CLAIM_FAILED, MACHINE_TO_BE_RETURNED, MACHINE_RETURNED, MACHINE_REVOKED, MACHINE_ELEMENT_DELETE_PENDING, MACHINE_RETURN_FAILED, MACHINE_RECEIVED_STOCK, REMANUFACTURED, MACHINE_RETIRED, MACHINE_RECOVER, MACHINE_DECOMMISSIONED, MACHINE_CLAIM_VALID, MACHINE_CLAIM_INVALID, MACHINE_CIC_RENEW_INITIAL, MACHINE_CIC_RENEW_ISSUE_PENDING, MACHINE_CIC_RENEW_ISSUED, MACHINE_CIC_RENEW_SIGNING_PENDING, MACHINE_CIC_RENEW_FAILED, MACHINE_CIC_RENEWED, MACHINE_SUSPEND_INIT, MACHINE_SUSPEND_IN_PROGRESS, MACHINE_SUSPENDED_MIC_OPERATIONAL, MACHINE_SUSPENDED_CIC_OPERATIONAL, MACHINE_SUSPEND_FAILED, MACHINE_SUSPENDED_EMPTY_TOKEN, MACHINE_SUSPENDED_INVALID_TOKEN, MACHINE_SUSPENDED_TOKEN_EXPIRED, MACHINE_SUSPENDED, MACHINE_SUSPEND_FAILED_TIMEOUT, MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS, MACHINE_ALLOCATED_TO_SHELL]

    The various device states.

    manufacture_id string

    The manufacture ID. The manufacture ID.

    model_name string

    The model name of the device.

    ordering_info string

    The order information.

    owner_tenant_id string

    The owner tenant ID.

    pki_op CAStoreOperation

    Pki Op

    ca_list string[]

    Ca List

    operation string

    Possible values: [UPDATE_CASTORE]

    Operation

    renew_state string

    Possible values: [MANUFACTURED, MANUFACTURED_QA_PENDING, MANUFACTURED_QA_OK, MANUFACTURED_QA_NOK, MANUFACTURED_BATTERY_TEST_PENDING, MANUFACTURED_BATTERY_TEST_START, MANUFACTURED_BATTERY_TEST_PASS, MANUFACTURED_BATTERY_TEST_FAILED, MANUFACTURED_MIC_ISSUE_PENDING, MANUFACTURED_MIC_ISSUED, MANUFACTURED_MIC_FAILED, MANUFACTURED_MIC_OPERATIONAL, MANUFACTURED_CIC_ISSUE_PENDING, MANUFACTURED_CIC_ISSUED, MANUFACTURED_CIC_REVOKED, MANUFACTURED_CIC_OPERATIONAL, MANUFACTURED_MIC_SIGNING_PENDING, MANUFACTURED_CIC_SIGNING_PENDING, MACHINE_ALLOCATED, MACHINE_ALLOCATED_TO_ESP, MACHINE_ELEMENT_ID_PENDING, MACHINE_INIT, MACHINE_INIT_FAILED, MACHINE_ASSIGNED, MACHINE_CLAIM_PENDING, MACHINE_CLAIMED, MACHINE_CLAIM_FAILED, MACHINE_TO_BE_RETURNED, MACHINE_RETURNED, MACHINE_REVOKED, MACHINE_ELEMENT_DELETE_PENDING, MACHINE_RETURN_FAILED, MACHINE_RECEIVED_STOCK, REMANUFACTURED, MACHINE_RETIRED, MACHINE_RECOVER, MACHINE_DECOMMISSIONED, MACHINE_CLAIM_VALID, MACHINE_CLAIM_INVALID, MACHINE_CIC_RENEW_INITIAL, MACHINE_CIC_RENEW_ISSUE_PENDING, MACHINE_CIC_RENEW_ISSUED, MACHINE_CIC_RENEW_SIGNING_PENDING, MACHINE_CIC_RENEW_FAILED, MACHINE_CIC_RENEWED, MACHINE_SUSPEND_INIT, MACHINE_SUSPEND_IN_PROGRESS, MACHINE_SUSPENDED_MIC_OPERATIONAL, MACHINE_SUSPENDED_CIC_OPERATIONAL, MACHINE_SUSPEND_FAILED, MACHINE_SUSPENDED_EMPTY_TOKEN, MACHINE_SUSPENDED_INVALID_TOKEN, MACHINE_SUSPENDED_TOKEN_EXPIRED, MACHINE_SUSPENDED, MACHINE_SUSPEND_FAILED_TIMEOUT, MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS, MACHINE_ALLOCATED_TO_SHELL]

    The device renew states.

    sales_order_number string

    The sales order number.

    ship_state string

    Possible values: [MACHINE_SHIPPED, MACHINE_SHIPPED_CORRECT_ADDRESS, MACHINE_SHIPPED_WRONG_ADDRESS, MACHINE_NOT_SHIPPED]

    The shipping status.

    sl_no string

    Sl No

    suspend_state string

    Possible values: [MANUFACTURED, MANUFACTURED_QA_PENDING, MANUFACTURED_QA_OK, MANUFACTURED_QA_NOK, MANUFACTURED_BATTERY_TEST_PENDING, MANUFACTURED_BATTERY_TEST_START, MANUFACTURED_BATTERY_TEST_PASS, MANUFACTURED_BATTERY_TEST_FAILED, MANUFACTURED_MIC_ISSUE_PENDING, MANUFACTURED_MIC_ISSUED, MANUFACTURED_MIC_FAILED, MANUFACTURED_MIC_OPERATIONAL, MANUFACTURED_CIC_ISSUE_PENDING, MANUFACTURED_CIC_ISSUED, MANUFACTURED_CIC_REVOKED, MANUFACTURED_CIC_OPERATIONAL, MANUFACTURED_MIC_SIGNING_PENDING, MANUFACTURED_CIC_SIGNING_PENDING, MACHINE_ALLOCATED, MACHINE_ALLOCATED_TO_ESP, MACHINE_ELEMENT_ID_PENDING, MACHINE_INIT, MACHINE_INIT_FAILED, MACHINE_ASSIGNED, MACHINE_CLAIM_PENDING, MACHINE_CLAIMED, MACHINE_CLAIM_FAILED, MACHINE_TO_BE_RETURNED, MACHINE_RETURNED, MACHINE_REVOKED, MACHINE_ELEMENT_DELETE_PENDING, MACHINE_RETURN_FAILED, MACHINE_RECEIVED_STOCK, REMANUFACTURED, MACHINE_RETIRED, MACHINE_RECOVER, MACHINE_DECOMMISSIONED, MACHINE_CLAIM_VALID, MACHINE_CLAIM_INVALID, MACHINE_CIC_RENEW_INITIAL, MACHINE_CIC_RENEW_ISSUE_PENDING, MACHINE_CIC_RENEW_ISSUED, MACHINE_CIC_RENEW_SIGNING_PENDING, MACHINE_CIC_RENEW_FAILED, MACHINE_CIC_RENEWED, MACHINE_SUSPEND_INIT, MACHINE_SUSPEND_IN_PROGRESS, MACHINE_SUSPENDED_MIC_OPERATIONAL, MACHINE_SUSPENDED_CIC_OPERATIONAL, MACHINE_SUSPEND_FAILED, MACHINE_SUSPENDED_EMPTY_TOKEN, MACHINE_SUSPENDED_INVALID_TOKEN, MACHINE_SUSPENDED_TOKEN_EXPIRED, MACHINE_SUSPENDED, MACHINE_SUSPEND_FAILED_TIMEOUT, MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS, MACHINE_ALLOCATED_TO_SHELL]

    The suspend state.

    token string

    A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$.

  • ]
Loading...