• API Reference

APIの使い方 / 共通設定

{productName}のAPI機能では、OAuth2.0のクライアント・クレデンシャル・グラントを用いてAPIアクセスの認証・認可を行い、リクエストごとにAPIのアクセストークンを発行します。 以下にリクエストメソッドやAPI共通の応答ステータスコード、assetスコープでのサンプル結果を示します。

対応するリクエストメソッド：

項目[スコープ] GET POST PUT DELETE
アセット [asset] 〇 - 〇 -
アセット一覧 [asset] 〇 - - -
アセットタグ [asset-tag] 〇 〇 〇 〇
アセットタグ一覧 [asset-tag] 〇 - - -
アセット所在管理 [asset-location] 〇 - - -
アラートルール [alert-rule] 〇 〇 〇 〇
アラートルール一覧 [alert-rule] 〇 - - -
アラート一覧 [alert] 〇 - - -
ジオフェンス入出 [geozone-io] 〇 - - -
アクティビティ一覧 [activity] 〇 - - -
ロウデータ一覧 [rowdata] 〇 - - -
高度化データ(時系列)
[advanced-time]		 〇 - - -
高度化データ(デバイス)
[advanced-device]		 〇 - - -

API項目の説明とサンプル:

項目 説明
Method Web APIで使用するリクエストメソッドです。
「GET / POST / PUT / DELETE」をサポートします。
Path 該当Web APIのエンドポイント
(APIにアクセスするためのURL)を指します。
https://{serviceCode}.iot-tracker.io
/web/api/auth

{serviceCode}:
ドメインに表示されている固有のサービスコード
Headers リクエストの詳細情報
Query
Parameters		 指定した値がリクエストURLの末尾に付与されます。
Body
Parameters		 指定した値がリクエスト内容に付与されます。

Response (共通項目):

time [API共通] API処理を行った時刻をunixtime(ミリ秒)で出力します。
message [API共通] 処理結果メッセージを出力します。
error [API共通] エラーメッセージを出力します。
warn [API共通] 警告メッセージを出力します。
data [API共通] 各スコープの返却値を出力します。

応答ステータスコード：

項目 説明
200 処理が正常に完了した場合
400 入力パラメータが不正の場合
401 認証エラーの場合
403 制限(スコープ/IPなど)により接続できない場合
404 対象のデータが見つからない場合
500 上記以外のエラー

1. 認証・認可

API「認証・認可」では、APIクライアントの認証・認可処理を行い、各APIの実行に必要なアクセストークンの発行を行います。
認証・認可処理にはOAuth 2.0のクライアント・クレデンシャル・グラントを用います。

POSTメソッドでは、認証・認可の実行を行います。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/auth/
  • Header:
    • Content-Type:
      application/x-www-form-urlencoded
  • request:
      • Body:
        • キー 必須 型 項目 説明
          grant-type 〇 文字列 グラント種別 client_credentials
          client-id 〇 文字列 クライアントID -
          client-secret 〇 文字列 クライアントシークレット -
          scope 〇 文字列 認可範囲 認可範囲

Response:

apiClientId APIクライアントの管理ID
accessToken アクセストークン。
トークン種別は”Bearer”固定
expiresIn アクセストークンの有効期限。
単位は[秒]
scope 該当APIアクセスの認可範囲

Response[application/json]:

  • {
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":{
      • "apiClientId":"1",
      • "accessToken":"abc",
      • "expiresIn": 3600,
      • "scope": "asset"
    • }
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

2. アセット

API「アセット」では、登録されているデバイス/アセット情報の参照・更新を行うことができます。

GETメソッドでは、指定したデバイス/アセット情報の参照を行います。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/device/{deviceCode}/asset
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Query Parameters:
        • キー 必須 型 項目 説明
          deviceCode 〇 文字列 デバイスID 対象指定

Response:

deviceId デバイスのシステム管理IDを出力します。
deviceCode デバイスのSigfox管理IDを出力します。
deviceTypeId デバイスに設定されるデバイスタイプの、システム管理IDを出力します。
active デバイス/アセットの活性状態を出力します。
1:活性 0:非活性
lastData デバイスの最新情報
lastData.time 最終検知時刻
UNIX時間[ミリ秒]/ JP Locale
lastData.deviceStatus デバイスの状態
0 電源ON
1 移動開始
2 移動停止
3 移動中
4 定期通信
5 ボタン押下
-1/null 非対応
lastData.lqi 最終電波強度
データ範囲は0~1 (少数含む)
lastData.battery バッテリー残量
データ範囲は0~1 (少数含む)
lastData.temperature 温度
lastData.humidity 湿度
lastData.contact 接点の値
lastData.contact_view 接点の値に対応するラベル
lastData.places Private DB位置ラベル情報
lastLocations 最新の位置情報を、測位種別毎に出力します。
lastLocations.[i].source 位置測位方法
2 Atlas Native
3 Atlas WiFi
4 Google Geolocation WiFi
5 GPS
-1 それ以外
lastLocations.[i].time 最終検知時刻
UNIX時間[ミリ秒]/ JP Locale
lastLocations.[i].lat 緯度
少数含む
lastLocations.[i].lng 経度
少数含む
lastLocations.[i].radius 推定領域
測位位置を中心に半径x[m]範囲内に該当デバイス/アセットがある
lastLocations.[i].deviceStatus デバイスの状態
0 電源ON
1 移動開始
2 移動停止
3 移動中
4 定期通信
5 ボタン押下
-1/null 非対応
lastLocations.[i].lqi 最終電波強度
データ範囲は0~1 (少数含む)
lastLocations.[i].temperature 温度
lastLocations.[i].humidity 湿度
lastLocations.[i].contact 接点の値
lastLocations.[i].contact_view 接点の値に対応するラベル
lastLocations.[i].places Private DB位置ラベル情報
asset アセット情報を出力します。
asset.assetId アセットのシステム管理IDを出力します。
asset.dataStatus アセットの有効性を出力します。
1:有効 0:無効
asset.assetName アセットの設定名称
asset.remarks 備考
tags デバイス/アセットに設定されているアセットタグの名称を、配列形式で出力します。

PUTメソッドでは、指定したデバイス/アセット情報の更新を行います。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/device/{deviceCode}/asset
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Query Parameters:
        • キー 必須 型 項目 説明
          deviceCode 〇 文字列 デバイスID 対象指定
      • Body Parameters:
        • キー 必須 型 項目 説明
          active 〇 数値 活性フラグ 許可値範囲内で指定
          (活性:1 非活性:0)
          assetName - 文字列 アセット名
          remarks - 文字列 備考
          tags - 文字列 アセットタグ 複数指定可

Response:

deviceId デバイスのシステム管理IDを出力します。
deviceCode デバイスのSigfox管理IDを出力します。
deviceTypeId デバイスに設定されるデバイスタイプの、システム管理IDを出力します。
active デバイス/アセットの活性状態を出力します。
1:活性 0:非活性
lastData デバイスの最新情報
lastData.time 最終検知時刻
UNIX時間[ミリ秒]/ JP Locale
lastData.deviceStatus デバイスの状態
0 電源ON
1 移動開始
2 移動停止
3 移動中
4 定期通信
5 ボタン押下
-1/null 非対応
lastData.lqi 最終電波強度
データ範囲は0~1 (少数含む)
lastData.battery バッテリー残量
データ範囲は0~1 (少数含む)
lastData.temperature 温度
lastData.humidity 湿度
lastData.contact 接点の値
lastData.contact_view 接点の値に対応するラベル
lastData.places Private DB位置ラベル情報
lastLocations 最新の位置情報を、測位種別毎に出力します。
lastLocations.[i].source 位置測位方法
2 Atlas Native
3 Atlas WiFi
4 Google Geolocation WiFi
5 GPS
-1 それ以外
lastLocations.[i].time 最終検知時刻
UNIX時間[ミリ秒]/ JP Locale
lastLocations.[i].lat 緯度
少数含む
lastLocations.[i].lng 経度
少数含む
lastLocations.[i].radius 推定領域
測位位置を中心に半径x[m]範囲内に該当デバイス/アセットがある
lastLocations.[i].deviceStatus デバイスの状態
0 電源ON
1 移動開始
2 移動停止
3 移動中
4 定期通信
5 ボタン押下
-1/null 非対応
lastLocations.[i].lqi 最終電波強度
データ範囲は0~1 (少数含む)
lastLocations.[i].temperature 温度
lastLocations.[i].humidity 湿度
lastLocations.[i].contact 接点の値
lastLocations.[i].contact_view 接点の値に対応するラベル
lastLocations.[i].places Private DB位置ラベル情報
asset アセット情報を出力します。
asset.assetId アセットのシステム管理IDを出力します。
asset.dataStatus アセットの有効性を出力します。
1:有効 0:無効
asset.assetName アセットの設定名称
asset.remarks 備考
tags デバイス/アセットに設定されているアセットタグの名称を、配列形式で出力します。

Response[application/json]:

  • {
    • "time":1568276259879,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":{
      • "deviceId": 1,
      • "deviceCode": "000001",
      • "deviceTypeId": 1,
      • "active": 1,
      • "lastData": {
        • "time": 1561085724000,
        • "deviceStatus": 4,
        • "lqi": 1.0,
        • "battery": 0.97,
        • "temperature": 10.0,
        • "humidity": 60,
        • "contact": 0,
        • "contact_view": "接点OFF",
        • "places": [{
          • "id": "12345",
          • "name": "KCCS 三田事業所 7F",
          • "shortname": "三田事業所 7F",
          • "parentPlace": "",
          • "type": "premise"
        • }]
      • },
      • "lastLocations":[{
        • "source": 2,
        • "time": 1561085724000,
        • "lat": 35.65714263916015625,
        • "lng": 139.734283447265625,
        • "radius": 29486,
        • "deviceStatus": null,
        • "lqi": 1.0,
        • "temperature": 10.0,
        • "humidity": 60,
        • "contact": 0,
        • "contact_view": "接点OFF",
        • "places": [{
          • "id": "12345",
          • "name": "KCCS 三田事業所 7F",
          • "shortname": "三田事業所 7F",
          • "parentPlace": "",
          • "type": "premise"
        • }]
      • }],
      • "asset": {
        • "assetId": 1,
        • "dataStatus": 1,
        • "assetName": "Testasset",
        • "remarks": "Bikou",
        • "tags": [
          • "TestB"
        • ]
      • }
    • }
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

3. アセット一覧

API「アセット一覧」では、複数のデバイス/アセットの最新情報を一括参照することができます。

GETリクエストでは、管理するデバイス/アセット全体、または指定したデバイス/アセットの最新情報を取得します。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/device/list
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Query Parameters:
        • キー 必須 型 項目 説明
          assetId - 数値 アセットID 指定値を、アセットのシステム管理IDに持つ情報を出力します。 取得対象アセットのシステム管理IDを指定します。
          複数指定可
          deviceCode - 文字列 デバイスID 指定値を「デバイスID」に持つ情報を出力します。
          複数指定可
          tags - 文字列 アセットタグ 指定値をアセットタグのシステム管理IDに持つアセットタグ情報を取得し、
          そのアセットタグに設定されたデバイス/アセット情報を出力します。
          複数指定可
          assetName - 文字列 アセット名 指定値を「アセット名」に含む情報をフィルタして出力します。
          曖昧検索

Response:

deviceId デバイスのシステム管理IDを出力します。
deviceCode デバイスのSigfox管理IDを出力します。
deviceTypeId デバイスに設定されるデバイスタイプの、システム管理IDを出力します。
active デバイス/アセットの活性状態を出力します。
1:活性 0:非活性
lastData デバイスの最新情報
lastData.time 最終検知時刻
UNIX時間[ミリ秒]/ JP Locale
lastData.deviceStatus デバイスの状態
0 電源ON
1 移動開始
2 移動停止
3 移動中
4 定期通信
5 ボタン押下
-1/null 非対応
lastData.lqi 最終電波強度
データ範囲は0~1 (少数含む)
lastData.battery バッテリー残量
データ範囲は0~1 (少数含む)
lastData.temperature 温度
lastData.humidity 湿度
lastData.contact 接点の値
lastData.contact_view 接点の値に対応するラベル
lastData.places Private DB位置ラベル情報
lastLocations 位置測位方法ごとの最新地点
lastLocations.[i].source 位置測位方法
2 Atlas Native
3 Atlas WiFi
4 Google Geolocation WiFi
5 GPS
-1 それ以外
lastLocations.[i].time 最終検知時刻
UNIX時間[ミリ秒]/ JP Locale
lastLocations.[i].lat 緯度
少数含む
lastLocations.[i].lng 経度
少数含む
lastLocations.[i].radius 推定領域
測位位置を中心に半径x[m]範囲内に該当デバイス/アセットがある
lastLocations.[i].deviceStatus デバイスの状態
0 電源ON
1 移動開始
2 移動停止
3 移動中
4 定期通信
5 ボタン押下
-1/null 非対応
lastLocations.[i].lqi 最終電波強度
データ範囲は0~1 (少数含む)
lastLocations.[i].temperature 温度
lastLocations.[i].humidity 湿度
lastLocations.[i].contact 接点の値
lastLocations.[i].contact_view 接点の値に対応するラベル
lastLocations.[i].places Private DB位置ラベル情報
asset アセット情報
asset.assetId アセットの管理ID
asset.dataStatus デバイス/アセットの活性フラグ 1:活性 0:非活性
asset.assetName アセットの名称
asset.remarks 備考
tags デバイス/アセットに紐づいたアセットタグ

Response[application/json]:

  • {
    • "time": 1568362592768,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":[
    • {
      • "deviceId": 1,
      • "deviceCode": "000001",
      • "deviceTypeId": 1,
      • "active": 1,
      • "lastData": {
        • "time": 1561085724000,
        • "deviceStatus": 4,
        • "lqi": 1.0,
        • "battery": 0.97,
        • "temperature": 10.0,
        • "humidity": 60,
        • "contact": 0,
        • "contact_view": "接点OFF",
        • "places": [{
          • "id": "12345",
          • "name": "KCCS 三田事業所 7F",
          • "shortname": "三田事業所 7F",
          • "parentPlace": "",
          • "type": "premise"
        • }]
      • },
      • "lastLocations":[{
        • "source": 2,
        • "time": 1561085724000,
        • "lat": 35.65714263916015625,
        • "lng": 139.734283447265625,
        • "radius": 29486,
        • "deviceStatus": null,
        • "lqi": 1.0,
        • "temperature": 10.0,
        • "humidity": 60,
        • "contact": 0,
        • "contact_view": "接点OFF",
        • "places": [{
          • "id": "12345",
          • "name": "KCCS 三田事業所 7F",
          • "shortname": "三田事業所 7F",
          • "parentPlace": "",
          • "type": "premise"
        • }]
      • }],
      • "asset": {
        • "assetId": 1,
        • "dataStatus": 1,
        • "assetName": "Testasset",
        • "remarks": "Bikou",
        • "tags": [
          • "TestB"
        • ]
      • }
    • }
    • ]
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

4. アセットタグ

API「アセットタグ」では、アセットタグの新規登録、および登録されているアセットタグ設定の参照・編集・削除を行うことができます。

GETメソッドでは、指定したアセットタグ設定の参照を行います。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/asset-tag/{id}
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Query Parameters:
        • キー 必須 型 項目 説明
          id 〇 数値 アセットタグID 対象指定

Response:

assetTagId アセットタグの管理ID
dataStatus アセットタグの有効・無効
1:有効 0:無効
tag アセットタグ名
style アセットタグの配色
remarks 備考

POSTメソッドでは、アセットタグ設定の新規登録を行います。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/asset-tag/
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Body:
        • キー 必須 型 項目 説明
          dataStatus 〇 数値 データステータス 許可値範囲内で指定
          無効:0 有効:1
          tag 〇 文字列 アセットタグ ";"や","を含む文字列、および、重複を許容しない
          style - 文字列 スタイル 許可値範囲内で指定
          英字小文字のみ
          remarks - 文字列 備考 -

Response:

assetTagId アセットタグの管理ID
dataStatus アセットタグの有効・無効
1:有効 0:無効
tag アセットタグ名
style アセットタグの配色
remarks 備考

PUTメソッドでは、指定したアセットタグ設定の編集を行います。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/asset-tag/{id}
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Query Parameters:
        • キー 必須 型 項目 説明
          id 〇 数値 アセットタグID 対象指定
      • Body:
        • キー 必須 型 項目 説明
          dataStatus 〇 数値 データステータス 許可値範囲内で指定
          無効:0 有効:1
          tag 〇 文字列 アセットタグ ";"や","を含む文字列、および、重複を許容しない
          style - 文字列 スタイル 許可値範囲内で指定
          英字小文字のみ
          remarks - 文字列 備考 -

Response:

assetTagId アセットタグの管理ID
dataStatus アセットタグの有効・無効
1:有効 0:無効
tag アセットタグ名
style アセットタグの配色
remarks 備考

DELETEメソッドでは、指定したアセットタグ設定の削除を行います。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/asset-tag/{id}
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Query Parameters:
        • キー 必須 型 項目 説明
          id 〇 数値 アセットタグID 対象指定

Response[application/json]:

  • {
    • "time": 1568364022388,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":{
      • "assetTagId": 1,
      • "dataStatus": 1,
      • "tag": "Test.A",
      • "style": "red",
      • "remarks": "アセットタグ"
    • }
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

Response[application/json]:

  • {
    • "time": 1568364022388,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":{
      • "assetTagId": 1,
      • "dataStatus": 1,
      • "tag": "Test.A",
      • "style": "red",
      • "remarks": "アセットタグ"
    • }
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

Response[application/json]:

  • {
    • "time": 1568364022388,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":{
      • "assetTagId": 1,
      • "dataStatus": 1,
      • "tag": "Test.A",
      • "style": "red",
      • "remarks": "アセットタグ"
    • }
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

Response[application/json]:

  • {
    • "time": 1568364022388,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

5. アセットタグ一覧

API「アセット一覧」では、アセットタグ設定を一括参照することができます。

GETリクエストでは、管理するアセットタグ全体、または指定したアセットタグの設定の参照を行います。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/asset-tag/list
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Query Parameters:
        • キー 必須 型 項目 説明
          tag - 文字列 アセットタグ フィルター条件:
          曖昧検索

Response:

assetTagId アセットタグの管理ID
dataStatus アセットタグの有効・無効
1:有効 0:無効
tag アセットタグ名
style アセットタグの配色
remarks 備考

Response[application/json]:

  • {
    • "time": 1568364022388,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":[
    • {
      • "assetTagId": 1,
      • "dataStatus": 1,
      • "tag": "Test.A",
      • "style": "red",
      • "remarks": "アセットタグ"
    • }
    • ]
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

6. アセット所在管理

API「アセット所在管理」では、アセット所在管理の情報の参照ができます。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/asset-location/list
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Query Parameters:
        • キー 必須 型 項目 説明
          dataType 〇 数値 出力形式 0:集計情報、1:差分情報
          showDate 〇 文字列 情報参照日 「yyyy-MM-dd」の日付形式で指定
          diff △ 数値 差分比較日 差分情報を参照する、情報参照日に対する差分日数を指定。(1~180の整数値のみ)
          ※dataTypeが「1」の場合に必須。
          (例：「1」を指定すると、情報参照日の1日前が差分参照対象日となる)
          stayThreshold 〇 数値 滞留 出力閾値(日) 滞留情報取得の閾値。
          入力範囲: 1~180
          lostThreshold 〇 数値 紛失 出力閾値(日) 紛失情報取得の閾値。
          入力範囲: 1~180
          geozoneId - 文字列 ジオフェンス管理ID フィルター条件:
          複数指定可(※1項目に指定可能な件数は1件まで)
          tags - 文字列 アセットタグ フィルター条件:
          複数指定可(※1項目に指定可能な件数は1件まで)

Response:

geofence ジオフェンス情報を出力。出力詳細は以下の表の通り。
geofenceId 対象ジオフェンスの管理ID
geofenceName 対象のジオフェンス名
total 対象ジオフェンスの管理するステータスを出力。出力詳細は以下の表の通り。
statusCode ステータス種別管理コードを出力。
数値とステータスの対応は以下の通り。
1:滞在 2:移動中 3:滞留 4:紛失
statusCodeName ステータス種別名を出力。
出力名称とステータスの対応は以下の通り。
STAY:滞在 MOVING:移動中 DWELL:滞留 LOST:紛失
amount ステータスの管理するデバイス件数を出力。
deviceIds ステータスの管理するデバイスの管理ID群を出力。
※集計表示(dataType=0)の場合のみ出力される

Response[application/json]:

  • 0: 集計情報
  • {
    • "time": 1558972458642,
    • "message":{
      • "error":[],
      • "warn":[]
    • },
    • "data":[
      • {
        • "geofence": {
          • "geofenceId": 1,
          • "geodenceName": "三田事業所"
        • },
        • "total": [
          • {
            • "statusCode" : 1,
            • "statusCodeName" : "STAY",
            • "amount" : 50,
            • "deviceIds": [ 1,2,3 ]
          • },{
            • "statusCode" : 2,
            • "statusCodeName" : "MOVING",
            • "amount" : 20,
            • "deviceIds": [ 1,3 ]
          • },{
            • "statusCode" : 3,
            • "statusCodeName" : "DWELL",
            • "amount" : 1,
            • "deviceIds": [ 1 ]
          • },{
            • "statusCode" : 4,
            • "statusCodeName" : "LOST",
            • "amount" : 3,
            • "deviceIds": [ 2,3 ]
          • }
        • ]
      • }
    • ]
  • }
  • 1: 差分情報
  • {
    • "time": 1558972458642,
    • "message":{
      • "error":[],
      • "warn":[]
    • },
    • "data":[
      • {
        • "geofence": {
          • "geofenceId": 1,
          • "geodenceName": "三田事業所",
        • },
        • "total": [
          • {
            • "statusCode" : 1,
            • "statusCodeName" : "STAY",
            • "amount" : "+30"
          • },{
            • "statusCode" : 2,
            • "statusCodeName" : "MOVING",
            • "amount" : "-60"
          • },{
            • "statusCode" : 3,
            • "statusCodeName" : "DWELL",
            • "amount" : "+60"
          • },{
            • "statusCode" : 4,
            • "statusCodeName" : "LOST",
            • "amount" : "0"
          • }
        • ]
      • }
    • ]
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

7. アラートルール

API「アラートルール」メニューでは、アラートルール設定の新規登録、および登録されているアラートメール設定の参照・編集・削除を行うことができます。

API「アラートルール」のGETメソッドでは、指定したアラートメール設定の参照を行うことができます。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/alert-rule/{id}
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Query Parameters:
        • キー 必須 型 項目 説明
          id 〇 数値 アラートルールID 参照するアラートルール設定のシステム管理IDを指定します。

Response:

alertRuleId アラートルール設定のシステム管理IDを出力します。
dataStatus アラートルール設定の有効性を出力します。
1:有効 0:無効
alertRuleName アラートルールの設定名称を出力します。
severity アラートルールに設定された重要性のシステム管理の数値(数値)を出力します。
1:通知 2:警告 3:緊急
alertRuleType アラートルールに設定された、アラートルール種別のシステム管理値(数値)を、以下の通り出力します。
アラートルール種別 出力値
アセット到着 3
アセット出発 4
アセット滞留 1
アセット紛失 2
バッテリー減少 5
アクティビティ減少 6
温度 7
湿度 8
接点 9
target.deviceIds 対象「デバイスID」に設定されたデバイスのシステム管理IDを、配列形式で出力します。
target.assetTagIds 対象「アセットタグ」に設定されたアセットタグのシステム管理IDを、配列形式で出力します。
alertCondition 条件の設定値を出力します。
配下の要素はアラートルール種別によって異なる
remarks 備考

POSTメソッドでは、アラートルール設定の新規登録を行います。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/alert-rule/
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Body:
        • キー 必須 型 項目 説明
          dataStatus 〇 数値 データステータス 許可値範囲内で指定
          1:有効 0:無効
          alertRuleName 〇 文字列 アラートルール名 -
          severity 〇 数値 重要性 許可値範囲内で指定
          1:通知 2:警告 3:緊急
          alertRuleType - 数値 アラートルール種別 許可値範囲内で指定
          1:アセット滞留
          2:アセット紛失
          3:アセット到着
          4:アセット出発
          5:バッテリー低下
          6:アクティビティ低下
          7:温度
          8:湿度
          9:接点
          deviceId - 数値 デバイスID 複数指定の場合、deviceId の行を追加します 例：デバイス 0001と0002を対象とする場合、 deviceId=0001＆deviceId=0002
          assetTagId - 数値 アセットタグID 複数指定の場合、assetTagId の行を追加します
          例：アセットタグ Test01とTest02を対象とする場合、 assetTagId=Test01＆assetTagId=Test02
          condition 〇 文字列 発砲条件 以下参照（6.1. ~ 6.4.）
          alertMailEnabled - 数値 アラートメール送信設定 0:利用しない
          1:利用する
          remarks - 文字列 備考 -
      • 7.1 アラートルール種別=1.アセット滞留 or 2.アセット紛失の場合:
        • キー 必須 型 項目 説明
          condition.geozoneIo.geozoneId 〇 数値 ジオフェンスID 複数可
          condition.geozoneIo.activateDay 〇 数値 経過日数 自然数のみ
          1-180の日単位で指定
      • 7.2 アラートルール種別=3.アセット到着 or 4.アセット出発の場合:
        • キー 必須 型 項目 説明
          condition.geozoneIo.geozoneId 〇 数値 ジオフェンスID 複数可
          condition.geozoneIo.activatePeriod.day 〇 数値 検出期間(日) 自然数のみ
          1-180の日単位で指定
          condition.geozoneIo.activatePeriod.hour 〇 数値 検出期間(時間) 自然数のみ
          時間単位で指定
          condition.geozoneIo.activatePeriod.minute 〇 数値 検出期間(分) 自然数のみ
          分単位で指定
      • 7.3 アラートルール種別=5.バッテリー減少の場合:
        • キー 必須 型 項目 説明
          condition.lowBattery.threshold 〇 数値 閾値 自然数のみ
      • 7.4 アラートルール種別=6.アクティビティ減少の場合:
        • キー 必須 型 項目 説明
          condition.lowActivity.threshold 〇 数値 閾値 自然数のみ
          condition.lowActivity.calcTerm 〇 数値 閾値 自然数のみ
      • 7.5 アラートルール種別=7.温度の場合:
        • キー 必須 型 項目 説明
          condition.temperature.upper 〇 数値 検出条件(上限) -100.0~100.0の範囲で指定可能。
          condition.temperature.lower 〇 数値 検出条件(下限) -100.0~100.0の範囲で指定可能。
          condition.temperature.activatePeriod.day 〇 数値 解消条件(日) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。
          condition.temperature.activatePeriod.hour 〇 数値 解消条件(時) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。
          condition.temperature.activatePeriod.minute 〇 数値 解消条件(分) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。
      • 7.6 アラートルール種別=8.湿度の場合:
        • キー 必須 型 項目 説明
          condition.humidity.upper 〇 数値 検出条件(上限) -100.0~100.0の範囲で指定可能。
          condition.humidity.lower 〇 数値 検出条件(下限) -100.0~100.0の範囲で指定可能。
          condition.humidity.activatePeriod.day 〇 数値 解消条件(日) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。
          condition.humidity.activatePeriod.hour 〇 数値 解消条件(時) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。
          condition.humidity.activatePeriod.minute 〇 数値 解消条件(分) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。
      • 7.7 アラートルール種別=9.接点の場合:
        • キー 必須 型 項目 説明
          condition.contact.detectionType 〇 数値 検出条件 1:状態変化, 2:接点ON, 3:接点OFF
          condition.contact.activatePeriod.day 〇 数値 解消条件(日) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。
          condition.contact.activatePeriod.hour 〇 数値 解消条件(時) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。
          condition.contact.activatePeriod.minute 〇 数値 解消条件(分) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。

Response:

alertRuleId アラートルールの管理ID
dataStatus アラートルールの有効・無効
1:有効 0:無効
alertRuleName アラートルール名
severity 重要性(数値)
1:通知 2:警告 3:緊急
alertRuleType アラートルール種別
1:アセット滞留
2:アセット紛失
3:アセット到着
4:アセット出発
5:バッテリー低下
6:アクティビティ低下
7:温度
8:湿度
9:接点
target アラート検知対象
deviceIds {productName}上のデバイスの管理ID
assetTagIds アセットタグの管理ID
alertCondition 発砲条件
配下の要素はアラートルール種別によって異なる
remarks 備考

PUTメソッドでは、指定したアラートルール設定の編集を行います。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/alert-rule/{id}
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Path Parameters:
        • キー 必須 型 項目 説明
          id 〇 数値 アラートルールID 対象指定
      • Body:
        • キー 必須 型 項目 説明
          dataStatus 〇 数値 データステータス 許可値範囲内で指定
          1:有効 0:無効
          alertRuleName - 文字列 アラートルール名 -
          severity 〇 数値 重要性 許可値範囲内で指定
          1:通知 2:警告 3:緊急
          alertRuleType 〇 数値 アラートルール種別 許可値範囲内で指定
          1:アセット滞留
          2:アセット紛失
          3:アセット到着
          4:アセット出発
          5:バッテリー低下
          6:アクティビティ低下
          7:温度
          8:湿度
          9:接点
          deviceId - 数値 デバイスID 複数指定の場合、deviceId の行を追加します
          例：デバイス 0001と0002を対象とする場合、 deviceId=0001＆deviceId=0002
          assetTagId - 数値 アセットタグID 複数指定の場合、assetTagId の行を追加します
          例：アセットタグ Test01とTest02を対象とする場合、 assetTagId=Test01＆assetTagId=Test02
          condition 〇 文字列 発砲条件 以下参照（6.1. ~ 6.4.）
          alertMailEnabled - 数値 アラートメール送信設定 0:利用しない
          1:利用する
          remarks - 文字列 備考 -
      • 7.1. アラートルール種別=1.アセット滞留 or 2.アセット紛失:
        • キー 必須 型 項目 説明
          condition.geozoneIo.geozoneId 〇 数値 ジオフェンスID 複数可
          condition.geozoneIo.activateDay 〇 数値 経過日数 自然数のみ
          1-180の日単位で指定
      • 7.2. アラートルール種別=3.アセット到着 or 4.アセット出発の場合:
        • キー 必須 型 項目 説明
          condition.geozoneIo.geozoneId 〇 数値 ジオフェンスID 複数可
          condition.geozoneIo.activatePeriod.day 〇 数値 検出期間(日) 自然数のみ
          1-180の日単位で指定
          condition.geozoneIo.activatePeriod.hour 〇 数値 検出期間(時間) 自然数のみ
          時間単位で指定
          condition.geozoneIo.activatePeriod.minute 〇 数値 検出期間(分) 自然数のみ
          分単位で指定
      • 7.3. アラートルール種別=5.バッテリー減少:
        • キー 必須 型 項目 説明
          condition.lowBattery.threshold 〇 数値 閾値 複数可
      • 7.4. アラートルール種別=6.アクティビティ減少:
        • キー 必須 型 項目 説明
          condition.lowActivity.threshold 〇 数値 閾値 自然数のみ
          condition.lowActivity.calcTerm 〇 数値 閾値 自然数のみ
      • 7.5 アラートルール種別=7.温度の場合:
        • キー 必須 型 項目 説明
          condition.temperature.upper 〇 数値 検出条件(上限) -100.0~100.0の範囲で指定可能。
          condition.temperature.lower 〇 数値 検出条件(下限) -100.0~100.0の範囲で指定可能。
          condition.temperature.activatePeriod.day 〇 数値 解消条件(日) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。
          condition.temperature.activatePeriod.hour 〇 数値 解消条件(時) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。
          condition.temperature.activatePeriod.minute 〇 数値 解消条件(分) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。
      • 7.6 アラートルール種別=8.湿度の場合:
        • キー 必須 型 項目 説明
          condition.humidity.upper 〇 数値 検出条件(上限) -100.0~100.0の範囲で指定可能。
          condition.humidity.lower 〇 数値 検出条件(下限) -100.0~100.0の範囲で指定可能。
          condition.humidity.activatePeriod.day 〇 数値 解消条件(日) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。
          condition.humidity.activatePeriod.hour 〇 数値 解消条件(時) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。
          condition.humidity.activatePeriod.minute 〇 数値 解消条件(分) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。
      • 7.7 アラートルール種別=9.接点の場合:
        • キー 必須 型 項目 説明
          condition.contact.detectionType 〇 数値 検出条件 1:状態変化, 2:接点ON, 3:接点OFF
          condition.contact.activatePeriod.day 〇 数値 解消条件(日) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。
          condition.contact.activatePeriod.hour 〇 数値 解消条件(時) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。
          condition.contact.activatePeriod.minute 〇 数値 解消条件(分) day, hour, minute合わせて 0日0分1秒～180日0分0秒 の範囲で指定可能。

Response:

alertRuleId アラートルールの管理ID
dataStatus アラートルールの有効・無効
1:有効 0:無効
alertRuleName アラートルール名
severity 重要性(数値)
1:通知 2:警告 3:緊急
alertRuleType アラートルール種別
1:アセット滞留
2:アセット紛失
3:アセット到着
4:アセット出発
5:バッテリー低下
6:アクティビティ低下
7:温度
8:湿度
9:接点
target アラート検知対象
deviceIds {productName}上のデバイスの管理ID
assetTagIds アセットタグの管理ID
alertCondition 発砲条件
配下の要素はアラートルール種別によって異なる
remarks 備考

DELETEメソッドでは、指定したアラートルール設定の削除を行います。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/alert-rule/{id}
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Path Parameters:
        • キー 必須 型 項目 説明
          id 〇 数値 アラートルールID 対象指定

Response[application/json]:

  • {
    • "time": 1568366488400,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":{
      • "alertRuleId": 1,
      • "dataStatus": 1,
      • "alertRuleName": "オフィス滞留",
      • "severity": 1,
      • "alertRuleType": 1,
      • "target": {
        • "deviceIds": [],
        • "assetTagIds": [1]
      • },
      • "alertCondition": {
        • "geozoneIds":[1],
        • "activateDay": 1,
      • },
      • "remarks": "オフィス管理"
    • }
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

Response[application/json]:

  • {
    • "time": 1568366488400,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":{
      • "alertRuleId": 1,
      • "dataStatus": 1,
      • "alertRuleName": "オフィス滞留",
      • "severity": 1,
      • "alertRuleType": 1,
      • "target": {
        • "deviceIds": [],
        • "assetTagIds": [1]
      • },
      • "alertCondition": {
        • "geozoneIds":[1],
        • "activateDay": 1
      • },
      • "remarks": "オフィス管理"
    • }
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

Response[application/json]:

  • {
    • "time": 1568366488400,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":{
      • "alertRuleId": 1,
      • "dataStatus": 1,
      • "alertRuleName": "オフィス滞留",
      • "severity": 1,
      • "alertRuleType": 1,
      • "target": {
        • "deviceIds": [],
        • "assetTagIds": [1]
      • },
      • "alertCondition": {
        • "geozoneIds":[1],
        • "activateDay": 1
      • },
      • "remarks": "オフィス管理"
    • }
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

Response[application/json]:

  • {
    • "time": 1568366488400,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

8. アラートルール一覧

API「アラートルール一覧」では、複数のアラートルール設定を一括参照することができます。

GETメソッドでは、管理するアラートルール全体、または指定したアラートルールの設定を参照します。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/alert-rule/list
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Path Parameters:
          • キー 必須 型 項目 説明
            alertRuleName - 文字列 アラートルール名 フィルター条件:
            曖昧検索
            severity - 文字列 重要性 フィルター条件:
            一致検索
            許可値範囲内で指定
            1:通知 2:警告 3:緊急
            alertRuleType - 文字列 アラートルール種別 フィルター条件:
            一致検索
            許可値範囲内で指定
            1:アセット滞留
            2:アセット紛失
            3:アセット到着
            4:アセット出発
            5:バッテリー低下
            6:アクティビティ低下
            7:温度
            8:湿度
            9:接点

Response:

alertRuleId アラートルールの管理ID
dataStatus アラートルールの有効・無効
1:有効 0:無効
alertRuleName アラートルール名
severity 重要性(数値)
1:通知 2:警告 3:緊急
alertRuleType アラートルール種別
1:アセット滞留
2:アセット紛失
3:アセット到着
4:アセット出発
5:バッテリー低下
6:アクティビティ低下
7:温度
8:湿度
9:接点
target アラート検知対象
deviceIds {productName}上のデバイスの管理ID
assetTagIds アセットタグの管理ID
alertCondition 発砲条件
配下の要素はアラートルール種別によって異なる
remarks 備考

Response[application/json]:

  • {
    • "time": 1568371765140,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":[
    • {
      • "alertRuleId": 1,
      • "dataStatus": 1,
      • "alertRuleName": "オフィス滞留",
      • "severity": 1,
      • "alertRuleType": 1,
      • "target": {
        • "deviceIds": [],
        • "assetTagIds": [1]
      • },
      • "alertCondition": {
        • "geozoneIds":[1],
        • "activateDay": 1
      • },
      • "remarks": "オフィス管理"
    • }
    • ]
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

9. アラート一覧

API「アラート一覧」では、アラート履歴情報を一括参照することができます。
一度に取得できるデータの件数は最大1,000件です。

GETリクエストでは、アラート履歴全体、または指定したアラート履歴を取得します。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/alert/list/
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Query Parameters:
        • キー 必須 型 項目 説明
          ruleId - 数値 アラートルールID フィルター条件:
          複数指定可
          ruleType - 数値 アラートルール種別 フィルター条件:
          複数指定可
          assetId - 数値 アセットID フィルター条件:
          複数指定可
          deviceCode - 文字列 デバイスID フィルター条件:
          複数指定可
          tag - 文字列 アセットタグ フィルター条件:
          複数指定可
          active - 数値 未解消のみ フィルター条件:
          1:true 0:false
          dtf - 文字列 検知日時From フィルター条件:
          日時(yyyyMMdd)
          dtt - 文字列 検知日時To フィルター条件:
          日時(yyyyMMdd)
          ctf - 文字列 解除日時From フィルター条件:
          日時(yyyyMMdd)
          ctt - 文字列 解除日時To フィルター条件:
          日時(yyyyMMdd)

Response:

alertId アラート番号
dataStatus アラートルールの有効・無効
1:有効 0:無効
severity 重要性(数値)
1:通知 2:警告 3:緊急
severityDisplay 重要性(表示名)
detectionTime 検知時刻[ミリ秒]
clearTime 解消時刻[ミリ秒]
alertRule アラートルール情報
alertRuleId アラートルールの管理ID
alertRuleName アラートルール名
alertRuleType アラートルール種別(数値)
1:アセット滞留
2:アセット紛失
3:アセット到着
4:アセット出発
5:バッテリー低下
6:アクティビティ低下
7:温度
8:湿度
9:接点
alertRuleTypeDisplay アラートルール種別(表示名)
ASSET_STAY:アセット滞留
ASSET_LOST:アセット紛失
ASSET_ARRIVAL:アセット到着
ASSET_DEPARTURE:アセット出発
LOW_BATTERY:バッテリー低下
LOW_ACTIVITY:アクティビティ低下
TEMPERATURE:温度
HUMIDITY:湿度
CONTACT:接点
asset アセット情報
assetId アセットの管理ID
assetName アセットの名称
tag アセットタグ
device デバイスID
半角英数字 / 16進数
deviceId {productName}上のデバイスの管理ID
deviceCode Sigfoxクラウドに登録されているデバイスの固有ID
deviceTypeId デバイスタイプの管理ID

Response[application/json]:

  • {
    • "time": 1568364022388,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":[
    • {
      • "alertId": 647,
      • "dataStatus": 1,
      • "severity": 1,
      • "severityDisplay": "通知",
      • "detectionTime": 1568357649000,
      • "clearTime": null,
      • "alertRule":{
        • "alertRuleId": 2,
        • "alertRuleName": "オフィス滞留",
        • "alertRuleType": 1,
        • "alertRuleTypeDisplay": "アセット滞留"
      • },
      • "asset":{
        • "assetId": 3,
        • "assetName": "サンプルA",
        • "tag": [
          • "TEST_A",
          • "TestC"
        • ]
      • },
      • "device":{
        • "deviceId": 2,
        • "deviceCode": "000002",
        • "deviceTypeId": 1
      • }
    • }
    • ]
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

10. ジオフェンス入出一覧

API「ジオフェンス入出一覧」では、ジオフェンス入出履歴を一括参照することができます。
一度に取得できるデータの件数は最大1,000件です。

GETリクエストでは、管理するジオフェンス入出履歴全体、または指定したジオフェンス入出履歴を取得します。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/geozone-io/list/
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Query Parameters:
        • キー 必須 型 項目 説明
          geozoneId - 数値 ジオフェンスの管理ID フィルター条件:
          複数指定可
          assetId - 数値 アセットの管理ID フィルター条件:
          複数指定可
          deviceCode - 文字列 Sigfoxクラウド上の
          デバイスの固有ID          		 フィルター条件:
          複数指定可
          tag - 文字列 アセットタグ フィルター条件:
          複数指定可
          active - 数値 未解消のみ フィルター条件:
          1:true　0:false
          dtf - 文字列 検知日時From フィルター条件:
          日時(yyyyMMdd)
          dtt - 文字列 検知日時To フィルター条件:
          日時(yyyyMMdd)
          ctf - 文字列 解除日時From フィルター条件:
          日時(yyyyMMdd)
          ctt - 文字列 解除日時To フィルター条件:
          日時(yyyyMMdd)

Response:

geozoneIoId ジオフェンス入出の管理ID
dataStatus ジオフェンスの有効・無効
1:有効 0:無効
detectionTime 検知時刻[ミリ秒]
clearTime 解消時刻[ミリ秒]
geozone ジオフェンス
geozoneId ジオフェンスの管理ID
geozoneName ジオフェンス名
asset アセット情報
assetId アセットの管理ID
assetName アセットの名称
tag アセットタグ
device デバイスID
半角英数字 / 16進数
deviceId {productName}上のデバイスの管理ID
deviceCode Sigfoxクラウドに登録されているデバイスの固有ID
deviceTypeId デバイスタイプの管理ID

Response[application/json]:

  • {
    • "time": 1568374605418,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":[
    • {
      • "geozoneIoId": 150,
      • "dataStatus": 1,
      • "detectionTime": 1568357649000,
      • "clearTime": null,
      • "geozone":{
        • "geozoneId": 1,
        • "geozoneName": "KCCS 三田事業所"
      • },
      • "asset":{
        • "assetId": 3,
        • "assetName": "サンプルA",
        • "tag": [
          • "TEST_A",
          • "TestC"
        • ]
      • },
      • "device":{
        • "deviceId": 2,
        • "deviceCode": "000002",
        • "deviceTypeId": 1
      • }
    • }
    • ]
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

11. アクティビティ一覧

API「アクティビティ」では、デバイス毎のアクティビティ情報を参照することができます。
集計区分の指定により、日毎のサマリを出力することもできます。
一度に取得できるデータの件数は最大1,000件で、取得期間には3ヶ月の期間で指定可能です。

GETリクエストでは、指定された条件で、アクティビティ情報の参照を行います。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/activity/list/
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Query Parameters:
        • キー 必須 型 項目 説明
          summary - 数値 集計区分 処理条件
          0:false 1:true
          df 〇 文字列 対象日時From フィルター条件:
          日時(yyyyMMdd)
          dt 〇 文字列 対象日時To フィルター条件:
          日時(yyyyMMdd)
          assetId - 数値 アセットID フィルター条件:
          複数指定可
          deviceCode - 文字列 デバイスID フィルター条件:
          複数指定可
          tag - 文字列 アセットタグ フィルター条件:
          複数指定可
          deviceTypeId - 数値 デバイスタイプID フィルター条件:
          複数指定可

Response:

activityId アクティビティID
dataStatus デバイス/アセットの活性化
1:活性 0:非活性
date 対象日
日付形式（yyyyMMdd）
rate アクティビティ値
asset アセット情報
assetId アセットの管理ID
assetName アセットの名称
tag アセットタグ
device デバイスID
半角英数字 / 16進数
deviceId {productName}上のデバイスの管理ID
deviceCode Sigfoxクラウドに登録されているデバイスの固有ID
deviceTypeId デバイスタイプの管理ID

Response[application/json]:

  • ※集計区分=1
  • {
    • "time": 1568375897831,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":[
    • {
      • "activityId": null,
      • "dataStatus": null,
      • "date": null,
      • "rate": 1027,
      • "asset":{
        • "assetId": 3,
        • "assetName": "サンプルA",
        • "tag": [
          • "TEST_A",
          • "TestC"
        • ]
      • },
      • "device":{
        • "deviceId": 2,
        • "deviceCode": "000002",
        • "deviceTypeId": 1
      • }
    • }
    • ]
  • }
  • ※集計区分=0
  • {
    • "time": 1568376165077,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":[
    • {
      • "activityId": 701,
      • "dataStatus": 1,
      • "date": "20190801",
      • "rate": 23,
      • "asset":{
        • "assetId": 3,
        • "assetName": "サンプルA",
        • "tag": [
          • "TEST_A",
          • "TestC"
        • ]
      • },
      • "device":{
        • "deviceId": 2,
        • "deviceCode": "000002",
        • "deviceTypeId": 1
      • }
    • }
    • ]
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

12. ロウデータ一覧

API「ロウデータ」では、指定したデバイスのペイロード（SigfoxクラウドからCallbackされた生データ）を参照することができます。
期間には、最大3ヶ月まで指定可能です。

GETメソッドでは、指定された条件で、ロウデータの参照を行います。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/rowdata/list/
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Query Parameters:
        • キー 必須 型 項目 説明
          deviceCode 〇 文字列 デバイスID フィルター条件:
          参照対象デバイスのSigfox管理IDを指定します。
          df 〇 文字列 対象日時From フィルター条件:
          参照日時のfromを「YYYYMMDD」形式で指定します。
          dt 〇 文字列 対象日時To フィルター条件:
          参照日時のtoを「YYYYMMDD」形式で指定します。

Response:

device デバイスID
デバイスのSigfox管理IDを出力します。
time ペイロード受信日時をunixtime形式で出力します。
deviceType デバイス種別毎のシステム管理コードを出力します。
deviceTypeId SigfoxクラウドのDeviceType管理IDを出力します。
serviceCode サービスコード(環境管理コード)を出力します。
data ペイロードの「data」属性を出力します。
lqi 電波強度情報を出力します。
「Limit / Average / Good / Excellent」の定型値で出力します。
seqNumber ペイロードのシーケンス番号を出力します。
countryCode 国コードを出力します。
fixedLat Sigfoxクラウド上で設定された該当デバイスの固定座標[緯度]を出力します。
fixedLng Sigfoxクラウド上で設定された該当デバイスの登録座標[経度]を出力します。
operatorName オペレーター名情報を出力します。
computedLocation Atlas測位情報から、「緯度(lat) / 経度(lng) / 推定領域(radius) / 位置測位方法(source) / 取得結果(status)」の情報を出力します。
placeIds Sigfoxクラウドから受信した、WiFi APのID情報 (computedLocation.placeIds) を出力します。
places Sigfoxクラウドから受信した、WiFi APから取得した位置情報 (computedLocation.places) を出力します。

Response[application/json]:

  • {
    • "time": 1568375897831,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":[
    • {
      • "device": "000001"
      • "time": "1564610962",
      • "deviceType": "1",
      • "deviceTypeId": "123456",
      • "fixedLat": 0,
      • "data": "1cb17fa596de1eb17fa596de",
      • "lqi": "Good",
      • "serviceCode": "-",
      • "countryCode": 392,
      • "fixedLng": 0,
      • "seqNumber": 2257,
      • "operatorName": "-",
      • "computedLocation":"{lat=35.79253701740493, lng=140.05520792361904, radius=10065, source=2, status=1}",
      • "places": [{
        • "id": "12345",
        • "name": "KCCS 三田事業所 7F",
        • "shortname": "三田事業所 7F",
        • "parentPlace": "",
        • "type": "premise"
      • }]
      • "placeIds":"[ "12345" ]
    • }
    • ]
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

13. 高度化データ(時系列)

API「高度化データ(時系列)」では、位置情報や通信損失回数などのペイロードから解析した情報を、デバイス毎に参照することができます。
期間には、最大3ヶ月まで指定可能です。

GETメソッドでは、指定した条件で、高度化データ(時系列)の参照を行います。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/advanced-data/time/list/
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Query Parameters:
        • キー 必須 型 項目 説明
          deviceCode 〇 文字列 デバイスID フィルター条件:
          参照対象デバイスのSigfox管理IDを指定します。
          df 〇 文字列 対象日時From フィルター条件:
          参照日時のfromを「YYYYMMDD」形式で指定します。
          dt 〇 文字列 対象日時To フィルター条件:
          参照日時のtoを「YYYYMMDD」形式で指定します。

Response:

device デバイスID
デバイスのSigfox管理IDを出力します。
time 本レコードの最新更新時の、
位置情報解析元となったペイロード受信日時をunixtime形式で出力します。
deviceType デバイス種別毎のシステム管理コードを出力します。
serviceCode サービスコード(環境管理コード)を出力します。
deviceStatus 本レコードの最新更新時の、
デバイスの状態を、以下の通りシステム管理コードで出力します。
0 電源ON
1 移動開始
2 移動停止
3 移動中
4 定期通信
5 ボタン押下
-1/null 非対応
lqi 本レコードの最新更新時の、
電波強度情報を、0~1の浮動小数値で出力します。
locations 位置情報をObject配列形式で出力します。Objectの各要素の詳細は以下の通りです。
locations.[i].source 位置測位種別を、以下の通りシステム管理コードで出力します。
2 Atlas Native
3 Atlas WiFi
4 Google WiFi
5 GPS
-1 それ以外
locations.[i].lat 緯度の値(浮動小数値)を出力します。
locations.[i].lng 経度の値(浮動小数値)を出力します。
locations.[i].radius 推定領域
測位位置を中心に半径x[m]範囲内に該当デバイス/アセットがある
locations.[i].time 位置情報解析元となったペイロード受信日時をunixtime形式で出力します。
locations.[i].lqi 電波強度情報を、0~1の浮動小数値で出力します。
locations.[i].deviceStatus デバイスの状態を出力します。
0 電源ON
1 移動開始
2 移動停止
3 移動中
4 定期通信
5 ボタン押下
-1/null 非対応
battery バッテリー残量値を出力します。
データ範囲は0~1 (小数含む)
voltage デバイスの電圧値を出力します。
gpsCnt GPS測位回数を出力します。
wifiCnt WiFi測位回数を出力します。
cnt01 01通信回数を出力します。
temperature 温度測位値を出力します。
humidity 湿度測位値を出力します。
contact 接点測位値を出力します。
contact_view 接点測位値に対するラベルを出力します。
places 位置ラベル管理情報をObject形式で出力します。

Response[application/json]:

  • {
    • "time": 1568375897831,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":[{
      • "lostCnt": 80,
      • "deviceType": "1",
      • "wifiCnt": 134,
      • "lqi": 0.75,
      • "serviceCode": "-",
      • "locations": [{
        • "lng": 140.05520792361904,
        • "source": 2,
        • "time": "1564610962",
        • "radius": 10065,
        • "lat": 35.79253701740493
      • }],
      • "deviceStatus": -1,
      • "time": "1564610962",
      • "battery": 0.97,
      • "device": "000001",
      • "gpsCnt": 0,
      • "voltage": -1,
      • "temperature": 10.0,
      • "humidity": 60,
      • "contact": 0,
      • "contact_view": "接点OFF",
      • "places": [{
        • "id": "12345",
        • "name": "KCCS 三田事業所 7F",
        • "shortname": "三田事業所 7F",
        • "parentPlace": "",
        • "type": "premise",
      • }]
    • }]
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"認証に失敗しました。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

14. 高度化データ(デバイス)

API「高度化データ(デバイス)」では、のペイロードから解析した最新情報を、デバイス毎に参照することができます。

GETメソッドでは、指定した条件で、高度化データ(デバイス)の参照を行います。

Request:

  • Path:
    • https://{serviceCode}.iot-tracker.io
      /web/api/advanced-data/device/list/
  • Header:
    • Authorization: Bearer {accessToken}
    • Content-Type :
      application/x-www-form-urlencoded
  • request:
      • Query Parameters:
        • キー 必須 型 項目 説明
          deviceCode 〇 文字列 デバイスID フィルター条件:
          複数指定可

Response:

device デバイスID
デバイスのSigfox管理IDを出力します。
time 本レコードの最新更新時の、
位置情報解析元となったペイロード受信日時をunixtime形式で出力します。
deviceType デバイス種別毎のシステム管理コードを出力します。
deviceTypeId SigfoxクラウドのDeviceType管理IDを出力します。
serviceCode サービスコード(環境管理コード)を出力します。
deviceStatus 本レコードの最新更新時の、
デバイスの状態を、以下の通りシステム管理コードで出力します。
0 電源ON
1 移動開始
2 移動停止
3 移動中
4 定期通信
5 ボタン押下
-1/null 非対応
lqi 本レコードの最新更新時の、
電波強度情報を、0~1の浮動小数値で出力します。
locations 位置情報をObject配列形式で出力します。Objectの各要素の詳細は以下の通りです。
locations.[i].source 位置測位方法
2 Atlas Native
3 Atlas WiFi
4 Google Geolocation WiFi
5 GPS
-1 それ以外
locations.[i].time 位置情報解析元となったペイロード受信日時をunixtime形式で出力します。
locations.[i].deviceStatus デバイスの状態を出力します。
0 電源ON
1 移動開始
2 移動停止
3 移動中
4 定期通信
5 ボタン押下
-1/null 非対応
locations.[i].lqi 電波強度情報を、0~1の浮動小数値で出力します。
locations.[i].lat 緯度の値(浮動小数値)を出力します。
locations.[i].lng 経度の値(浮動小数値)を出力します。
locations.[i].radius 推定領域
測位位置を中心に半径x[m]範囲内に該当デバイス/アセットがある
temperature 温度測位値を出力します。
humidity 湿度測位値を出力します。
contact 接点測位値を出力します。
contact_view 接点測位値に対するラベルを出力します。
places 位置ラベル管理情報をObject形式で出力します。

Response[application/json]:

  • {
    • "time": 1568375897831,
    • "message":{
      • "error":[],
      • "warn":[],
    • },
    • "data":[{
      • "deviceType": "1",
      • "lqi": 1,
      • "serviceCode": "-",
      • "locations": [{
        • "lng": 139.75036927479636,
        • "lqi": 1,
        • "source": 2,
        • "time": "1568677462",
        • "radius": 30074,
        • "lat": 35.65386135016884
      • }]
      • "deviceStatus": 2,
      • "time": "1568677462",
      • "battery": 0.08,
      • "device": "000001",
      • "temperature": 10.0,
      • "humidity": 60,
      • "contact": 0,
      • "contact_view": "接点OFF",
      • "places": [{
        • "id": "12345",
        • "name": "KCCS 三田事業所 7F",
        • "shortname": "三田事業所 7F",
        • "parentPlace": "",
        • "type": "premise",
      • }]
    • }]
  • }
  • {
    • "message":{
      • "error":[{
          • columnId":"clientId",
          • message":"クライアントIDは入力必須です。"
      • }],
      • "warn":[],
    • },
    • "data":null
  • }

認証エラーの場合