Type alias GetDevicesArg

GetDevicesArg: {
    bustCache?: boolean;
    createdBy?: string;
    createdDate?: string;
    created_date.gte?: string;
    created_date.lte?: string;
    desc?: boolean;
    groupId?: string;
    isActive?: boolean;
    isDeleteProtected?: boolean;
    isGroupAdmin?: boolean;
    isOrgAdmin?: boolean;
    isProjectAdmin?: boolean;
    lastSeen?: string;
    lastUpdatedBy?: string;
    lastUpdatedDate?: string;
    last_seen.gte?: string;
    last_seen.lte?: string;
    last_updated_date.gte?: string;
    last_updated_date.lte?: string;
    limit?: number;
    locale?: string;
    locale.regex?: string;
    macAddress?: string;
    mac_address.regex?: string;
    manufacturer?: string;
    manufacturer.regex?: string;
    name?: string;
    name.regex?: string;
    objectCount?: boolean;
    orderBy?: string;
    owner?: string;
    page?: number;
    pageCount?: boolean;
    product?: string;
    product.regex?: string;
    projectId?: string;
    roleId?: string;
    search?: string;
    searchFields?: string;
    serialNumber?: string;
    serial_number.regex?: string;
    site?: string;
    site.regex?: string;
    tags?: string;
    tags.contains?: string;
    tags.contains_any?: string;
    zoneinfo?: string;
    zoneinfo.regex?: string;
}

Type declaration

  • Optional bustCache?: boolean

    Whether to bypass the cache and get the latest data

  • Optional createdBy?: string

    ID of the user who created the account

  • Optional createdDate?: string

    Created date of items to return

  • Optional created_date.gte?: string
  • Optional created_date.lte?: string
  • Optional desc?: boolean

    Whether to order results in descending order

  • Optional groupId?: string

    ID of the group to filter accounts by

  • Optional isActive?: boolean

    (Admin only) Whether to only return active accounts

  • Optional isDeleteProtected?: boolean

    Whether to only return delete-protected accounts

  • Optional isGroupAdmin?: boolean

    Whether to only return group admins

  • Optional isOrgAdmin?: boolean

    Whether to only return org admins

  • Optional isProjectAdmin?: boolean

    Whether to only return project admins

  • Optional lastSeen?: string

    Last time the account was seen

  • Optional lastUpdatedBy?: string

    ID of the user who last updated the account

  • Optional lastUpdatedDate?: string

    Last edited date of items to return

  • Optional last_seen.gte?: string
  • Optional last_seen.lte?: string
  • Optional last_updated_date.gte?: string
  • Optional last_updated_date.lte?: string
  • Optional limit?: number

    Maximum number of objects to return

  • Optional locale?: string

    Locale of the account

  • Optional locale.regex?: string
  • Optional macAddress?: string

    MAC address of this device

  • Optional mac_address.regex?: string
  • Optional manufacturer?: string

    Device manufacturer

  • Optional manufacturer.regex?: string
  • Optional name?: string

    Name of the device

  • Optional name.regex?: string
  • Optional objectCount?: boolean

    Whether to only return the number of matching entries

  • Optional orderBy?: string

    Field to order results by

  • Optional owner?: string

    ID of the device owner

  • Optional page?: number

    Page number to return

  • Optional pageCount?: boolean

    Whether to only return the number of pages

  • Optional product?: string

    Product name

  • Optional product.regex?: string
  • Optional projectId?: string

    ID of the project to filter accounts by

  • Optional roleId?: string

    ID of the role to filter accounts by

  • Optional search?: string

    Search term to filter accounts by

  • Optional searchFields?: string

    Comma-delimited list of fields to search in

  • Optional serialNumber?: string

    Device serial number

  • Optional serial_number.regex?: string
  • Optional site?: string

    Location of this device

  • Optional site.regex?: string
  • Optional tags?: string

    Comma delimited list of tags on this account

  • Optional tags.contains?: string
  • Optional tags.contains_any?: string
  • Optional zoneinfo?: string

    Timezone of the account

  • Optional zoneinfo.regex?: string

Settings

Member Visibility

Theme