{"swagger":"2.0","info":{"title":"Taisei sensor hub","description":"Sensor hub for Taisei API platforms.","version":"1.0.0-02ca107"},"definitions":{},"tags":[],"securityDefinitions":{"Bearer":{"type":"apiKey","in":"header","name":"Authorization"}},"paths":{"/devices":{"get":{"parameters":[{"in":"query","name":"page","type":"integer","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false,"default":1,"description":"If 0 is specified, only meta data will be returned."},{"in":"query","name":"perPage","type":"integer","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false,"default":20,"description":"If 0 is specified, retrieve unlimited."},{"in":"query","name":"q","type":"string","description":"Keywords for name or memo."},{"in":"query","name":"id","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv"},{"in":"query","name":"buildingId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv"},{"in":"query","name":"floorId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv","description":"deprecated"},{"in":"query","name":"area","type":"array","items":{"type":"string"},"collectionFormat":"ssv","description":"deprecated"},{"in":"query","name":"tag","type":"array","items":{"type":"string"},"collectionFormat":"ssv","description":"タグ名 (キーと値を`:`で連結した文字列) を指定します. タグ名の先頭に`+`があるとAND(必須条件), `-`はNOT(除外条件), デフォルトはOR(いずれかが必要)."},{"in":"query","name":"rssi","type":"number","exclusiveMinimum":false,"exclusiveMaximum":false},{"in":"query","name":"rssi.min","type":"number","exclusiveMinimum":false,"exclusiveMaximum":false},{"in":"query","name":"rssi.max","type":"number","exclusiveMinimum":false,"exclusiveMaximum":false},{"in":"query","name":"lastLoggedAt","type":"string","format":"date-time"},{"in":"query","name":"lastLoggedAt.since","type":"string","format":"date-time"},{"in":"query","name":"lastLoggedAt.until","type":"string","format":"date-time"},{"in":"query","name":"withDeleted","type":"boolean","default":false},{"in":"query","name":"sort","type":"string","enum":["id","-id","name","-name","buildingId","-buildingId","floorId","-floorId","areaId","-areaId","rssi","-rssi","lastLoggedAt","-lastLoggedAt","createdAt","-createdAt","updatedAt","-updatedAt"],"default":"-id"},{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"}],"summary":"Search devices","responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong auth headers"}},"security":[{"Bearer":[]}],"tags":["Device"]},"post":{"parameters":[{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"},{"in":"body","name":"data","schema":{"type":"object","properties":{"type":{"type":"number","enum":[1,2],"exclusiveMinimum":false,"exclusiveMaximum":false,"example":1},"name":{"type":"string","maxLength":32,"example":"Device Name"},"buildingId":{"type":"number","exclusiveMinimum":false,"exclusiveMaximum":false,"example":1},"floorId":{"type":"number","exclusiveMinimum":false,"exclusiveMaximum":false,"description":"deprecated","example":1},"area":{"type":"string","description":"deprecated","example":"南口ドア"},"tags":{"type":"array","items":{"type":"string","maxLength":100,"example":"A0001"},"collectionFormat":"ssv","description":"タグ名 (キーと値を`:`で連結した文字列) を指定します."},"rssi":{"type":"number","exclusiveMinimum":false,"exclusiveMaximum":false,"example":-100},"memo":{"type":"string","maxLength":2000,"example":"2022/4/1に購入\nメモ"}},"required":["type","name","buildingId"]}}],"summary":"Create a device","responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong auth headers"}},"security":[{"Bearer":[]}],"tags":["Device"]}},"/devices/{id}":{"get":{"parameters":[{"in":"path","name":"id","type":"number","required":true,"description":"id of device. (device type 16bit, serial 32bit)"},{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"}],"summary":"Find a device by ID","responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong auth headers"}},"security":[{"Bearer":[]}],"tags":["Device"]},"patch":{"parameters":[{"in":"path","name":"id","type":"number","required":true,"description":"id of device. (device type 16bit, serial 32bit)"},{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"},{"in":"body","name":"data","schema":{"type":"object","properties":{"name":{"type":"string","maxLength":32,"example":"Device Name"},"buildingId":{"type":"number","exclusiveMinimum":false,"exclusiveMaximum":false,"example":1},"floorId":{"type":"number","exclusiveMinimum":false,"exclusiveMaximum":false,"description":"deprecated","example":1},"area":{"type":"string","description":"deprecated","example":"南口ドア"},"tags":{"type":"array","items":{"type":"string","maxLength":100,"example":"A0001"},"collectionFormat":"ssv","description":"タグ名 (キーと値を`:`で連結した文字列) を指定します."},"rssi":{"type":"number","exclusiveMinimum":false,"exclusiveMaximum":false,"example":-100},"memo":{"type":"string","maxLength":2000,"example":"2022/4/1に購入\nメモ"}}}}],"summary":"Update a device","responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong auth headers"}},"security":[{"Bearer":[]}],"tags":["Device"]},"delete":{"parameters":[{"in":"path","name":"id","type":"number","required":true,"description":"id of device. (device type 16bit, serial 32bit)"},{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"}],"summary":"Delete device by ID","responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong auth headers"}},"security":[{"Bearer":[]}],"tags":["Device"]}},"/devices/{id}/restore":{"post":{"parameters":[{"in":"path","name":"id","type":"number","required":true,"description":"id of device. (device type 16bit, serial 32bit)"},{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"}],"summary":"Restore deleted device by ID","responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong auth headers"}},"security":[{"Bearer":[]}],"tags":["Device"]}},"/sensorLogs":{"get":{"parameters":[{"in":"query","name":"page","type":"integer","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false,"default":1,"description":"If 0 is specified, only meta data will be returned."},{"in":"query","name":"perPage","type":"integer","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false,"default":20,"description":"If 0 is specified, retrieve unlimited."},{"in":"query","name":"deviceId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv"},{"in":"query","name":"buildingId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv"},{"in":"query","name":"floorId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv","description":"deprecated"},{"in":"query","name":"area","type":"array","items":{"type":"string"},"collectionFormat":"ssv","description":"deprecated"},{"in":"query","name":"tag","type":"array","items":{"type":"string"},"collectionFormat":"ssv","description":"タグ名 (キーと値を`:`で連結した文字列) を指定します. タグ名の先頭に`+`があるとAND(必須条件), `-`はNOT(除外条件), デフォルトはOR(いずれかが必要)."},{"in":"query","name":"time","type":"string","format":"date-time"},{"in":"query","name":"time.since","type":"string","format":"date-time"},{"in":"query","name":"time.until","type":"string","format":"date-time"},{"in":"query","name":"sort","type":"string","enum":["id","-id","time","-time"],"default":"-time"},{"in":"query","name":"include","type":"array","items":{"type":"string","enum":["device"]},"collectionFormat":"ssv"},{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"}],"summary":"Search sensor logs","responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong jwt token"}},"security":[{"Bearer":[]}],"tags":["SensorLog"]},"post":{"parameters":[{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"},{"in":"body","name":"data","schema":{"type":"object","properties":{"time":{"type":"string","format":"date-time"},"deviceId":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false,"example":65696},"buildingId":{"type":"number","exclusiveMinimum":false,"exclusiveMaximum":false,"description":"省略した場合`device`の値を使う","example":1},"floorId":{"type":"number","exclusiveMinimum":false,"exclusiveMaximum":false,"description":"省略した場合`device`の値を使う. deprecated","example":1},"area":{"type":"string","description":"省略した場合`device`の値を使う. deprecated","example":"南口ドア"},"tags":{"type":"array","items":{"type":"string","maxLength":100,"example":"A0001"},"collectionFormat":"ssv","description":"タグ名 (キーと値を`:`で連結した文字列) を指定します.\n省略した場合`device`の値を使う"},"data":{"type":"object","example":{"count":2}}},"required":["deviceId","area"]}}],"summary":"Add a sensor log","responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong jwt token"}},"security":[{"Bearer":[]}],"tags":["SensorLog"]}},"/sensorLogs/output":{"get":{"parameters":[{"in":"query","name":"page","type":"integer","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false,"default":1,"description":"If 0 is specified, only meta data will be returned."},{"in":"query","name":"perPage","type":"integer","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false,"default":20,"description":"If 0 is specified, retrieve unlimited."},{"in":"query","name":"deviceId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv"},{"in":"query","name":"buildingId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv"},{"in":"query","name":"floorId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv","description":"deprecated"},{"in":"query","name":"area","type":"array","items":{"type":"string"},"collectionFormat":"ssv","description":"deprecated"},{"in":"query","name":"tag","type":"array","items":{"type":"string"},"collectionFormat":"ssv","description":"タグ名 (キーと値を`:`で連結した文字列) を指定します. タグ名の先頭に`+`があるとAND(必須条件), `-`はNOT(除外条件), デフォルトはOR(いずれかが必要)."},{"in":"query","name":"time","type":"string","format":"date-time"},{"in":"query","name":"time.since","type":"string","format":"date-time"},{"in":"query","name":"time.until","type":"string","format":"date-time"},{"in":"query","name":"sort","type":"string","enum":["id","-id","time","-time"],"default":"-time"},{"in":"query","name":"header","type":"boolean","default":true,"description":"Output header row."},{"in":"query","name":"splitValues","type":"boolean","default":false,"description":"If true, split the row by data name. By default, output for each record."},{"in":"query","name":"fields","type":"array","items":{"type":"string"},"collectionFormat":"ssv","default":["id","time:datetime","deviceId","areaId","tags","data"],"description":"'id', 'time', 'deviceId', 'buildingId', 'floorId', 'areaId', 'tags', 'data', etc. are available.\nSpecify the dot notated key to get the nested value (e.g. 'data.count').\nYou may apply filters (such as 'datetime', 'date' and 'time') to values by separating using a colon (e.g. 'time:date')."},{"in":"query","name":"tagSeparator","type":"string","default":"/"},{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"}],"summary":"Output sensor logs","produces":["text/csv"],"responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong jwt token"}},"security":[{"Bearer":[]}],"tags":["SensorLog"]}},"/sensorLogs/array":{"post":{"parameters":[{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"},{"in":"body","name":"data","schema":{"type":"object","properties":{"time":{"type":"string","format":"date-time","description":"指定した場合`dataArray`での省略時の代替値として使う"},"deviceId":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false,"example":65696},"buildingId":{"type":"number","exclusiveMinimum":false,"exclusiveMaximum":false,"description":"省略した場合`device`の値を使う","example":1},"floorId":{"type":"number","exclusiveMinimum":false,"exclusiveMaximum":false,"description":"省略した場合`device`の値を使う. deprecated","example":1},"area":{"type":"string","description":"省略した場合`device`の値を使う. deprecated","example":"南口ドア"},"tags":{"type":"array","items":{"type":"string","maxLength":100,"example":"A0001"},"collectionFormat":"ssv","description":"タグ名 (キーと値を`:`で連結した文字列) を指定します.\n省略した場合`device`の値を使う"},"dataArray":{"type":"array","items":{"type":"object"},"example":[{"time":"2026-08-30T00:32:14.986Z","data":{"count":2}}]}},"required":["deviceId","area","dataArray"]}}],"summary":"Add sensor logs in bulk","responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong jwt token"}},"security":[{"Bearer":[]}],"tags":["SensorLog"]}},"/sensorLogs/aggregate":{"get":{"parameters":[{"in":"query","name":"step","type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false,"default":1},{"in":"query","name":"stepUnit","type":"string","enum":["second","minute","hour","day","week","month","year","hour_of_day","day_of_month","day_of_week","month_of_year"],"default":"day"},{"in":"query","name":"time.since","type":"string","format":"date-time"},{"in":"query","name":"time.until","type":"string","format":"date-time"},{"in":"query","name":"name","type":"string","required":true,"description":"target data name"},{"in":"query","name":"method","type":"array","items":{"type":"string","enum":["count","sum","avg","min","max"]},"collectionFormat":"ssv","required":true},{"in":"query","name":"deviceId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv"},{"in":"query","name":"buildingId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv"},{"in":"query","name":"floorId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv","description":"deprecated"},{"in":"query","name":"area","type":"array","items":{"type":"string"},"collectionFormat":"ssv","description":"deprecated"},{"in":"query","name":"tag","type":"array","items":{"type":"string"},"collectionFormat":"ssv","description":"タグ名 (キーと値を`:`で連結した文字列) を指定します. タグ名の先頭に`+`があるとAND(必須条件), `-`はNOT(除外条件), デフォルトはOR(いずれかが必要)."},{"in":"query","name":"include","type":"array","items":{"type":"string","enum":["ids","tagIds","tags","areaIds","deviceIds"]},"collectionFormat":"ssv"},{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"}],"summary":"Aggregate sensor logs","responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong jwt token"}},"security":[{"Bearer":[]}],"tags":["SensorLog"]}},"/areas":{"get":{"parameters":[{"in":"query","name":"page","type":"integer","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false,"default":1,"description":"If 0 is specified, only meta data will be returned."},{"in":"query","name":"perPage","type":"integer","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false,"default":20,"description":"If 0 is specified, retrieve unlimited."},{"in":"query","name":"id","type":"array","items":{"type":"string"},"collectionFormat":"ssv"},{"in":"query","name":"q","type":"string","description":"Keywords for name."},{"in":"query","name":"buildingId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv"},{"in":"query","name":"used","type":"boolean","default":true,"description":"Retrieve related areas only."},{"in":"query","name":"used.buildingId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv"},{"in":"query","name":"used.floorId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv"},{"in":"query","name":"sort","type":"string","enum":["id","-id","name","-name","buildingId","-buildingId"],"default":"-id"},{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"}],"summary":"Search areas","responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong jwt token"}},"security":[{"Bearer":[]}],"tags":["Area"],"deprecated":true}},"/tags":{"get":{"parameters":[{"in":"query","name":"page","type":"integer","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false,"default":1,"description":"If 0 is specified, only meta data will be returned."},{"in":"query","name":"perPage","type":"integer","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false,"default":20,"description":"If 0 is specified, retrieve unlimited."},{"in":"query","name":"id","type":"array","items":{"type":"string"},"collectionFormat":"ssv"},{"in":"query","name":"q","type":"string","description":"Keywords for name."},{"in":"query","name":"key","type":"array","items":{"type":"string"},"collectionFormat":"ssv"},{"in":"query","name":"value","type":"string","description":"Keyword for value."},{"in":"query","name":"used","type":"boolean","default":false,"description":"Retrieve related tags only."},{"in":"query","name":"used.buildingId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv"},{"in":"query","name":"used.floorId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv","description":"deprecated"},{"in":"query","name":"choicesFor","type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false,"description":"Building ID that put in the choice list."},{"in":"query","name":"suggestionsFor","type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false,"description":"Building ID for which is suggested."},{"in":"query","name":"asStruct","type":"boolean","default":false,"description":"If true, responds as an object. If false, only the tag name will be response."},{"in":"query","name":"include","type":"array","items":{"type":"string","enum":["buildings"]},"collectionFormat":"ssv"},{"in":"query","name":"sort","type":"string","enum":["id","-id","name","-name","key","-key"],"default":"-id"},{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"}],"summary":"Search tags","responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong jwt token"}},"security":[{"Bearer":[]}],"tags":["Tag"]}},"/tags/{id}":{"delete":{"parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"ID or name of the tag."},{"in":"query","name":"force","type":"boolean","description":"If true, also deletes relations with devices and logs."},{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"}],"summary":"Delete tag by ID or name (and item of the choice list).","responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong jwt token"}},"security":[{"Bearer":[]}],"tags":["Tag"]}},"/tag_choice_lists":{"get":{"parameters":[{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"}],"summary":"Get list of the tag choice list information","responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong jwt token"}},"security":[{"Bearer":[]}],"tags":["Tag"]}},"/tag_choice_lists/{id}":{"get":{"parameters":[{"in":"path","name":"id","type":"number","required":true,"description":"id of building."},{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"}],"summary":"Get the tag choice list information","responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong jwt token"}},"security":[{"Bearer":[]}],"tags":["Tag"]}},"/tag_choice_lists/{id}/tags":{"get":{"parameters":[{"in":"path","name":"id","type":"number","required":true,"description":"id of building."},{"in":"query","name":"page","type":"integer","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false,"default":1,"description":"If 0 is specified, only meta data will be returned."},{"in":"query","name":"perPage","type":"integer","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false,"default":20,"description":"If 0 is specified, retrieve unlimited."},{"in":"query","name":"id","type":"array","items":{"type":"string"},"collectionFormat":"ssv"},{"in":"query","name":"q","type":"string","description":"Keywords for name."},{"in":"query","name":"key","type":"array","items":{"type":"string"},"collectionFormat":"ssv"},{"in":"query","name":"value","type":"string","description":"Keyword for value."},{"in":"query","name":"used","type":"boolean","default":false,"description":"Retrieve related tags only."},{"in":"query","name":"used.buildingId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv"},{"in":"query","name":"used.floorId","type":"array","items":{"type":"integer","exclusiveMinimum":false,"exclusiveMaximum":false},"collectionFormat":"ssv","description":"deprecated"},{"in":"query","name":"asStruct","type":"boolean","default":false,"description":"If true, responds as an object. If false, only tag name are response."},{"in":"query","name":"sort","type":"string","enum":["id","-id","name","-name","key","-key"],"default":"-id"},{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"}],"summary":"Search tags in the choice list.","responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong jwt token"}},"security":[{"Bearer":[]}],"tags":["Tag"]},"put":{"parameters":[{"in":"path","name":"id","type":"number","required":true,"description":"id of building."},{"in":"header","name":"X-TSH-Client-Id","type":"string","description":"APIクライアントに払い出されたID"},{"in":"header","name":"X-TSH-Signature","type":"string","description":"所定の手続きにより生成したシグネチャ文字列"},{"in":"header","name":"X-TSH-Date","type":"string","description":"ISO8601形式(`20220315T080000Z` or `2022-03-15T08:00:00Z`)","example":"20220315T080000Z"},{"in":"body","name":"data","schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"collectionFormat":"ssv","description":"完全タグ名 (キーと名前を`:`で連結した文字列) を指定します.\nキーは省略すると`_`にフォールバックされます.\n他のビルのタグ候補に含めたくない場合は先頭に`*`をつけてください.","example":["key1:name1","key2:name2","*key3:name3"]}},"required":["tags"]}}],"summary":"Update all tags in the choice list.","responses":{"200":{"description":"success"},"201":{"description":"created"},"400":{"description":"bad request"},"401":{"description":"unauthorized, missing/wrong jwt token"}},"security":[{"Bearer":[]}],"tags":["Tag"]}},"/":{"get":{"parameters":[],"responses":{"200":{"description":"success"}},"tags":["Reference"],"summary":"API schema as Swagger 2.0"}},"/explorer":{"get":{"parameters":[],"responses":{"200":{"description":"success"}},"tags":["Reference"],"summary":"API explorer as Swagger-UI 2.0"}}}}