Function queryDevices

  • デバイス一覧取得

    概要

    • API実行時点でアクセス権限のあるデバイスの一覧を取得します
    • itemId パラメータを指定することで、特定のオプションが付与されているデバイスの情報のみを取得することが可能です

    必要なOAuth2.0 scope:

    • Safie APIで利用可能なscopeのいずれか一つ以上

    Parameters

    • options: {
          limit?: number;
          offset?: number;
          itemId?: number;
      } = {}

      オプション

      • Optional limit?: number

        返却するリストの最大件数 (規定値: 20, 最大値: 100)

      • Optional offset?: number

        返却するリストのオフセット (規定値: 0)

      • Optional itemId?: number

        デバイスに設定されているオプションによる絞り込み

    Returns Promise<QueryDevicesResult>

    Throws

    ErrorDetail

    Example

    //最大件数:30件、オフセット:10で実行
    const result = await Safie.Devices.queryDevices({ limit: 30, offset: 10});