API docs by Redocly

EXOffice App-Service API (1.7.3)

Download OpenAPI specification:Download

E-mail: developer@where123.jp

本資料について

  • EXOfficeでは、ダッシュボード（ユーザ・インターフェース）の他に、任意のクライアントプログラムから、APIを用いてアクセスするインターフェースも提供しています。
  • マスタの取得・更新や、位置情報、予定情報の取得・更新等を可能にしており、標準のEXOfficeの機能を拡張したり、外部システムとの連携を実装することが可能です。

APIの利用

  • EXOfficeのご契約時に、どのAPIを利用するか合わせてご連絡ください。指定APIにアクセス可能なAPIキーを発行します。
  • １つのAPIキーで複数の種類のAPIを利用することもできますし、使用する機能に応じて複数のAPIキーを発行することもできます。
  • APIキーは、HTTPリクエストヘッダ（x-api-key）に設定していただきます。
  • セキュリティ確保のため、アクセス元のIPアドレスをご連絡ください。それ以外からはアクセスできないように設定します。

APIの形式

  • EXOffice App Service APIは、REST原則に準拠したインターフェースを採用しています。操作するリソースをURLで指定し、操作の種別をHTTPメソッドで指定します。
  • リソースの詳細情報は、BODYにUTF-8で、JSON形式（もしくはCSV形式）で設定する必要があります。
  • その際、JSONを受け取る場合はAcceptヘッダーに、JSONを送信する場合はContent-Typeヘッダーにapplication/jsonを指定する必要があります。
  • リクエストが正常に受け付けられたかどうかなどの処理結果は、HTTP 1.1の仕様に従ってステータスコードレスポンスで返されます。一般に、200台は正常、400台はリクエストエラー、500台はサーバ側エラーであり、500台エラーが返された場合は処理結果が保証されません。
  • エラーの際、返却値として定義されていない値を返する場合があります。
  • 記載されている返却値の順序が異なる場合もあります。また、サーバ側のシステム設定値によって、同じAPIでも異なった処理・異なった返却値となる場合があります。

パス・パラメータ

  • {version}は、基本的に1.0で固定です。本ドキュメントのバージョンとは連動しません。APIの処理内容・返却内容に変更がある場合にバージョンアップします。仮にあるAPIの最新版が1.1であるとき、1.0のバージョンは下位互換として維持されます。
  • {tenantCd}や{regionCd}は、契約後にAPIキーと合わせてご連絡します。
  • その他のパス・パラーメータは各APIに記載しています。

利用制限

  • 契約時に合意したアクセス頻度で、APIの使用をお願いします。
  • アクセス頻度が高い場合、429（Too Many Request）を返却する場合があります。
  • 位置情報やセンサー情報等の取得については、アクセス頻度を高めても、キャッシュされた同じ値を返却する場合があります。
  • マスタ等更新後、即取得アクセスを行った場合、古いデータが返却される場合があります。
  • サーバ・メンテナンスは、定期および不定期に実施され、その間アクセスしても、500系のエラーが返却される場合があります。その場合、一定時間経過後にリトライしてください。

position

位置情報の取得・登録

測位履歴のダウンロード

  • 指定日付の測位履歴をCSV形式で出力する
  • 実行間隔は１日１回を想定。
  • 下記APIはdeprecated
    • /core/positionHistory/download/{regionCd}/{date}/{charset}
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

date
required
integer

YYYYMMDD形式で指定

charset
required
string

UTF8 or SJIS

query Parameters
groupCd
string

グループコード

btxId
string

btxIdを指定

Responses

Response samples

Content type
{
  • "status": 400,
  • "message": "RequestBody is not found."
}

最新の測位情報を取得

  • 測位情報をcsv形式で出力する
  • 実行間隔は測位バッチの実行間隔より長くすること
  • 下記APIはdeprecated
    • /core/positionHistory/downloadPositions/{tenantCd}/{regionCd}/{lang}/{headerLabels}
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

lang
required
string

言語コード(ja/en)

headerLabels
required
string

パラメータをカンマ区切りで指定

query Parameters
btxIds
string

btxIdをカンマ区切りで指定

btxFrom
integer

btxIdの開始を数値で指定

btxTo
integer

btxIdの終了を数値で指定

groupCds
string

グループコードをカンマ区切りで指定

includeChildren
boolean

groupCdsで指定したグループを階層的に取得する

Responses

Response samples

Content type
{
  • "status": 400,
  • "message": "RequestBody is not found."
}

測位履歴の登録（外部システム用）

  • 外部システムより測位情報を登録する
  • 下記APIは廃止
    • /core/positionHistory/ext/{regionCd}
path Parameters
version
required
string

APIバージョン(1.0)

regionCd
required
string

リージョンコード(UTF8)

Request Body schema: application/json

content-type=application/json (UTF8)

Array
dt
required
integer <int64>

日時（Unix timeミリ秒）

potCd
required
string

人＆物コード

locationCd
required
string

場所コード

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "create position history succeeded.",
  • "total": 123,
  • "count": 32
}

フロアマップ表示用URLを発行

  • フロアマップを表示するためのURLを発行する。
  • 下記APIはdeprecated
    • /core/positionHistory/issuePositionMapUrl/{tenanCd}/{regionCd}/{potCd}
path Parameters
version
required
string

APIバージョン(1.0)

regionCd
required
string

リージョンコード

potCd
required
string

ポップアップを表示する人のIDを指定

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "RequestBody is not found."
}

stayTime

滞在情報の取得

滞在履歴の取得

  • 滞在開始日時FROM～TOの範囲に存在する滞在情報をcsv形式で取得する。
  • 当日の情報取得には対応していない。
  • 実行間隔は１日１回、もしくは１月１回を想定。
  • 下記APIはdeprecated
    • /office/stayTime/download/{tenantCd}/{regionCd}/{from}/{to}/{headerLabels}
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

from
required
string

滞在開始日時FROM(YYYYMMDDHHmmss)

to
required
string

滞在終了日時TO(YYYYMMDDHHmmss)

headerLabels
required
string

パラメータをカンマ区切りで指定

query Parameters
groupCds
string

グループIDをカンマ区切りで指定

includeChildren
boolean

groupCdsで指定したグループを階層的に取得する

potCds
string

人IDをカンマ区切りで指定

Responses

Response samples

Content type
{
  • "status": 400,
  • "message": "RequestBody is not found."
}

attendance

チェックイン情報の取得

チェックイン情報の取得

  • 指定日時のチェックイン・アウトの情報をcsv形式で取得する。
  • 実行間隔は１日１回、もしくは１月１回を想定。
  • 前日以前を指定することが前提であり、当日のデータは保証しない。
  • 日付指定で取得する場合、以下のパスを使用できる。
    • /ext/{version}/attendance/download/{tenantCd}/{regionCd}/{date}/{headerLabels}
    • {date}はYYYYMMDD形式
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

from
required
string

開始日時FROM(YYYYMMDDHHmmss)

to
required
string

終了日時TO(YYYYMMDDHHmmss)

headerLabels
required
string

取得する値のキーをカンマ区切りで指定

項目 列名 型
名前コード potCd string
名前 potName string
グループコード groupCd string
グループ名 groupName string
拠点コード siteCd string
拠点名 siteName string
エリアコード areaCd string
エリア名 areaName string
場所コード locationCd string
場所名 locationName string
外部場所コード outsideCd string
外部場所 outsideName string
外部場所の補足情報 outsideText string
チェックイン日時 checkInDt string
チェックアウト日時 checkOutDt string
query Parameters
groupCds
string

グループIDをカンマ区切りで指定

includeChildren
boolean

groupCdsで指定したグループを階層的に取得する

potCds
string

人IDをカンマ区切りで指定

Responses

Response samples

Content type
{
  • "status": 400,
  • "message": "RequestBody is not found."
}

plan

予約の取得・登録・更新・削除

座席予約情報の取得

  • 予約時間FROM～TOの範囲に存在する座席予約情報をjson形式で返す。更新日時を指定時、その日時以降に登録、変更、削除、チェックイン、チェックアウトされた予約のみを返す。
  • 下記APIはdeprecated
    • /office/plans/seatReservation/{tenantCd}/{regionCd}/{from}/{to}
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

from
required
string

予約時間FROM(YYYYMMDDHHmm)

to
required
string

予約時間TO(YYYYMMDDHHmm)

query Parameters
updateDt
string

更新日時(YYYYMMDDHHmm)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

会議室予約情報の取得

  • 予約時間FROM～TOの範囲に存在する会議室予約情報をjson形式で返す。更新日時を指定時、その日時以降に登録、変更、削除、チェックイン、チェックアウトされた予約のみを返す。
  • 外部登録者の予約は登録者・主催者(organizer)の人＆物名(potName)に外部登録者名を含め、人＆物ID(potCd)やグループの情報は空で返却する。
  • 外部参加者は参加予定者(attendee)の人＆物名(potName)に外部参加者のメールアドレスを含め、人＆物ID(potCd)やグループの情報は空で返却する。
  • 下記APIはdeprecated
    • /office/plans/meetingReservation/{tenantCd}/{regionCd}/{from}/{to}
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

from
required
string

予約時間FROM(YYYYMMDDHHmm)

to
required
string

予約時間TO(YYYYMMDDHHmm)

query Parameters
updateDt
string

更新日時(YYYYMMDDHHmm)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

タグ毎の予約情報の取得

  • 拠点単位でタグ毎の予約情報をjson形式で返す。予約日を指定時はその日、未指定時は当日の予約を返す。更新日時を指定時、その日時以降に登録、変更、削除された予約のみを返す。
  • 下記APIはdeprecated
    • /office/plans/txReservation/{tenantCd}/{regionCd}/{siteCd}
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

siteCd
required
string

拠点コード

query Parameters
reserveDt
string

予約日(YYYYMMDD)

updateDt
string

更新日時(YYYYMMDDHHmm)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

予約の登録・更新

  • 座席予約、会議室予約の登録・更新を行う。
  • 更新時は更新対象の予約固有IDを指定する。
  • ログインID、人＆物IDのいずれかを予約登録者として指定が必要。両方を指定した場合は人＆物IDが優先される。
  • 終日フラグをtrueで指定した場合、予約開始日時は年月日のみ指定する。予約終了日時は未指定で登録可能。
  • 拠点ID、場所のいずれかを予約場所として指定が必要。場所が未指定の場合、指定拠点内の座席がランダムで選択される。両方を指定した場合は場所が優先される。
  • ログインIDか人＆物IDのいずれかを参加予定者として指定する。参加予定者が未指定の場合、予約登録者を参加予定者として登録される。
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

Request Body schema: application/x-www-form-urlencoded
reservationId
integer <int32>

予約固有ID

loginId
required
string

ログインID

potCd
required
string

人＆物ID

subject
string <= 255 characters

予定名

description
string <= 255 characters

備考

startDt
required
string

予約開始日時(yyyy/MM/dd HH:mm 終日フラグがtrue時はyyyy/MM/dd)

endDt
required
string

予約終了日時(yyyy/MM/dd HH:mm)

isAllDay
boolean

終日フラグ

siteCd
required
string

拠点ID

location
required
string

場所(拠点ID:場所ID カンマ区切りで複数指定可能)

attendee
string

参加予定者(カンマ区切りで複数指定可能)

visibility
integer <int32>

可視性(0:公開,1:非公開予定あり,2:非公開予定なし)

purpose
string <= 255 characters

目的(通常は使用不可)

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "RequestBody is not found."
}

予約の削除

  • 座席予約、会議室予約の削除を行う。
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

Request Body schema: application/x-www-form-urlencoded
reservationId
required
integer <int32>

予約固有ID

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "RequestBody is not found."
}

master

マスタの取得・登録・更新・削除

タグマスタの取得

  • タグマスタを指定形式で取得する
  • 下記APIはdeprecated
    • /core/tx/ext/{version}/{tenantCd}/{regionCd}:
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "btxId,major,minor,disp"

jsonの場合、headerLabelsで指定した以下の項目を返却

項目 列名 型
btxId btxId integer
major major integer
minor minor integer
sensorNames センサ名 string
disp 表示フラグ integer
siteCd 拠点コード string
siteName 拠点名 string
areaCd エリアコード string
areaName エリア名 string
locationCd 場所コード string
locationName 場所名 string
x x座標 integer
y y座標 integer
delFlg 削除フラグ integer
charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Responses

Response samples

Content type
{
  • "status": 400,
  • "message": "RequestBody is not found."
}

タグマスタの登録

  • タグマスタを指定形式(json/csv)から登録する
  • 下記APIはdeprecated
    • /core/tx/ext/{version}/{tenantCd}/{regionCd}:
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "btxId,major,minor,disp"

jsonによる更新時、パラメータをカンマ区切りで指定

charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Request Body schema: application/x-www-form-urlencoded

jsonデータを設定

csvFile
string <binary>

csvファイルで更新する。項目はjson同様。updateKeyが設定されている行は更新、空の場合は新規登録となる。

Responses

Response samples

Content type
{
  • "status": 200,
  • "message": "operation succeeded."
}

タグマスタの削除

  • タグマスタを削除する
  • 下記APIはdeprecated
    • /core/tx/ext/{version}/{tenantCd}/{regionCd}:
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

Request Body schema: application/json

jsonデータを設定

Array
btxId
integer

タグID

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "operation succeeded."
}

人＆物マスタの取得

  • 人＆物マスタを指定形式で取得する
  • 下記APIはdeprecated
    • /basic/pot/ext/{version}/{tenantCd}/{regionCd}
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "ID,potName,btxId,major,minor,potType,displayName,groupCd,groupName"

jsonの場合、headerLabelsにカンマ区切りで指定した以下の項目を返却

項目 列名 型
人＆物ID ID string
人＆物名 potName string
タグID btxId integer
タグMajor major integer
タグMinor minor integer
種類 potType string
表示名 displayName string
カテゴリコード categoryCd string
カテゴリ名 categoryName string
グループコード groupCd string
グループ名 groupName string
権限コード authCd string(複数の場合は;区切り)
権限名 authName string(複数の場合は;区切り)
場所コード locationCd string(拠点コード/場所コードの形式。複数の場合は;区切り)
場所名 locationName string(拠点コード/場所名の形式。複数の場合は;区切り)
削除フラグ delFlg integer
charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Responses

Response samples

Content type
{
  • "status": 400,
  • "message": "RequestBody is not found."
}

人＆物マスタの登録

  • 人＆物マスタを指定形式(json/csv)から登録する
  • 下記APIはdeprecated
    • /basic/pot/ext/{version}/{tenantCd}/{regionCd}
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "ID,potName,btxId,potType,displayName,groupCd,groupName"

パラメータをカンマ区切りで指定

charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Request Body schema: application/x-www-form-urlencoded

jsonデータを設定

csvFile
string <binary>

csvファイルで更新する。項目はjson同様。updateKeyが設定されている行は更新、空の場合は新規登録となる。

Responses

Response samples

Content type
{
  • "status": 200,
  • "message": "operation succeeded."
}

人＆物マスタの削除

  • 人＆物マスタを削除する
  • 下記APIはdeprecated
    • /basic/pot/ext/{version}/{tenantCd}/{regionCd}
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

Request Body schema: application/json

jsonデータを設定

Array
ID
string

人＆物コード

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
appliaction/json
{
  • "status": 200,
  • "message": "operation succeeded."
}

拠点マスタの取得

  • 拠点マスタを指定形式で取得する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "ID,siteName,meshId,description"

jsonの場合、headerLabelsにカンマ区切りで指定した以下の項目を返却

項目 列名 型
拠点コード ID string
拠点名 siteName string
メッシュID meshId integer
備考 description string
削除フラグ delFlg integer
charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Responses

Response samples

Content type
{
  • "status": 400,
  • "message": "RequestBody is not found."
}

拠点マスタの登録

  • 拠点マスタを指定形式(json/csv)から登録する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "ID,siteName,meshId,description"

パラメータをカンマ区切りで指定

charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Request Body schema: application/x-www-form-urlencoded

jsonデータを設定

csvFile
string <binary>

csvファイルで更新する。項目はjson同様。updateKeyが設定されている行は更新、空の場合は新規登録となる。

Responses

Response samples

Content type
{
  • "status": 200,
  • "message": "operation succeeded."
}

拠点マスタの削除

  • 拠点マスタを削除する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

Request Body schema: application/json

jsonデータを設定

Array
ID
string

拠点コード

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
appliaction/json
{
  • "status": 200,
  • "message": "operation succeeded."
}

エリアマスタの取得

  • エリアマスタを指定形式で取得する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "ID,areaName,capacity,siteCd,siteName"

jsonの場合、headerLabelsにカンマ区切りで指定した以下の項目を返却

項目 列名 型
エリアコード ID string
エリア名 areaName string
定員 capacity integer
拠点コード siteCd string
拠点名 siteName string
削除フラグ delFlg integer
charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Responses

Response samples

Content type
{
  • "status": 400,
  • "message": "RequestBody is not found."
}

エリアマスタの登録

  • エリアマスタを指定形式(json/csv)から登録する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "ID,areaName,capacity,siteCd"

パラメータをカンマ区切りで指定

charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Request Body schema: application/x-www-form-urlencoded

jsonデータを設定

csvFile
string <binary>

csvファイルで更新する。項目はjson同様。updateKeyが設定されている行は更新、空の場合は新規登録となる。

Responses

Response samples

Content type
{
  • "status": 200,
  • "message": "operation succeeded."
}

エリアマスタの削除

  • エリアマスタを削除する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

Request Body schema: application/json

jsonデータを設定

Array
ID
string

エリアコード

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
appliaction/json
{
  • "status": 200,
  • "message": "operation succeeded."
}

場所マスタの取得

  • 場所マスタを指定形式で取得する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "ID,locationName,capacity,locationType,areaCd,areaName,siteCd,siteName,x,y"

jsonの場合、headerLabelsにカンマ区切りで指定した以下の項目を返却。拡張項目も指定可能。

項目 列名 型
場所コード ID string
場所名 locationName string
定員 capacity integer
タイプ locationType integer
エリアコード areaCd string
エリア名 areaName string
拠点コード siteCd string
拠点名 siteName string
X座標 x integer
Y座標 y integer
タグ表示形式 displayFormat integer
タイル表示縦行数 horizon integer
タイル表示横列数 vertical integer
ゾーン（分類）コード zoneClassCd string
ゾーン（分類） zoneClass string
ゾーン（区画） zoneBlock string
EXB deviceId deviceId
btxId btxId string
人＆物コード potCd string
人＆物名 potName string
削除フラグ delFlg integer
charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Responses

Response samples

Content type
{
  • "status": 400,
  • "message": "RequestBody is not found."
}

場所マスタの登録

  • 場所マスタを指定形式(json/csv)から登録する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "ID,locationName,capacity,locationType,areaCd,siteCd,x,y"

パラメータをカンマ区切りで指定

charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Request Body schema: application/x-www-form-urlencoded

jsonデータを設定

csvFile
string <binary>

csvファイルで更新する。項目はjson同様。updateKeyが設定されている行は更新、空の場合は新規登録となる。

Responses

Response samples

Content type
{
  • "status": 200,
  • "message": "operation succeeded."
}

場所マスタの削除

  • 場所マスタを削除する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

Request Body schema: application/json

jsonデータを設定

Array
ID
string

場所コード

siteCd
string

拠点コード

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
appliaction/json
{
  • "status": 200,
  • "message": "operation succeeded."
}

EXBマスタの取得

  • EXBマスタを指定形式で取得する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "deviceId,threshold1,threshold2,adjust1,adjust2,sensorNames,locationCd,locationName,siteCd,siteName"

jsonの場合、headerLabelsにカンマ区切りで指定した以下の項目を返却

項目 列名 型
デバイスID deviceId integer
閾値(人) threshold1 integer
閾値(物) threshold2 integer
調整値(人) adjust1 integer
調整値(物) adjust2 integer
タイプ sensorNames string
場所コード locationCd string
場所名 locationName string
拠点コード siteCd string
拠点名 siteName string
削除フラグ delFlg integer
charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Responses

Response samples

Content type
{
  • "status": 400,
  • "message": "RequestBody is not found."
}

EXBマスタの登録

  • EXBマスタを指定形式(json/csv)から登録する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "deviceId,threshold1,threshold2,adjust1,adjust2,sensorNames,locationCd,siteCd,delFlg"

パラメータをカンマ区切りで指定

charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Request Body schema: application/x-www-form-urlencoded

jsonデータを設定

csvFile
string <binary>

csvファイルで更新する。項目はjson同様。updateKeyが設定されている行は更新、空の場合は新規登録となる。

Responses

Response samples

Content type
{
  • "status": 200,
  • "message": "operation succeeded."
}

EXBマスタの削除

  • EXBマスタを削除する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

Request Body schema: application/json

jsonデータを設定

Array
ID
integer

デバイスID

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
appliaction/json
{
  • "status": 200,
  • "message": "operation succeeded."
}

ゾーンマスタの取得

  • ゾーンマスタを指定形式で取得する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "ID,zoneKind,zoneType,zoneName,capacity,siteCd,siteName,areaCd,areaName,shape"

jsonの場合、headerLabelsにカンマ区切りで指定した以下の項目を返却。拡張項目も指定可能。

項目 列名 型
ゾーンコード ID string
形式 zoneKind string
ゾーンタイプ zoneType string
ゾーン名 zoneName string
定員 capacity integer
拠点コード siteCd string
拠点名 siteName string
エリアコード areaCd string
エリア名 areaName string
形 shape json
カテゴリコード categoryCd string
カテゴリ名 categoryName string
削除フラグ delFlg integer
charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Responses

Response samples

Content type
{
  • "status": 400,
  • "message": "RequestBody is not found."
}

ゾーンマスタの登録

  • ゾーンマスタを指定形式(json/csv)から登録する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "ID,zoneType,zoneName,capacity,siteCd,areaCd,shape"

パラメータをカンマ区切りで指定

charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Request Body schema: application/x-www-form-urlencoded

jsonデータを設定

csvFile
string <binary>

csvファイルで更新する。項目はjson同様。updateKeyが設定されている行は更新、空の場合は新規登録となる。

Responses

Response samples

Content type
{
  • "status": 200,
  • "message": "operation succeeded."
}

ゾーンマスタの削除

  • ゾーンマスタを削除する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

Request Body schema: application/json

jsonデータを設定

Array
ID
string

ゾーンコード

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
appliaction/json
{
  • "status": 200,
  • "message": "operation succeeded."
}

カテゴリマスタの取得

  • カテゴリマスタを指定形式で取得する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "ID,categoryName,categoryType,color,bgColor,shape"

jsonの場合、headerLabelsにカンマ区切りで指定した以下の項目を返却。拡張項目も指定可能。

項目 列名 型
カテゴリコード ID string
カテゴリ名 categoryName string
種別 categoryType string
文字色 color string
背景色 bgColor string
形 shape integer
備考 description string
削除フラグ delFlg integer
charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Responses

Response samples

Content type
{
  • "status": 400,
  • "message": "RequestBody is not found."
}

カテゴリマスタの登録

  • カテゴリマスタを指定形式(json/csv)から登録する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "ID,categoryName,categoryType,color,bgColor,shape"

パラメータをカンマ区切りで指定

charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Request Body schema: application/x-www-form-urlencoded

jsonデータを設定

csvFile
string <binary>

csvファイルで更新する。項目はjson同様。updateKeyが設定されている行は更新、空の場合は新規登録となる。

Responses

Response samples

Content type
{
  • "status": 200,
  • "message": "operation succeeded."
}

カテゴリマスタの削除

  • カテゴリマスタを削除する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

Request Body schema: application/json

jsonデータを設定

Array
ID
string

カテゴリコード

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
appliaction/json
{
  • "status": 200,
  • "message": "operation succeeded."
}

グループマスタの取得

  • グループマスタを指定形式で取得する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "ID,groupName,color,bgColor,shape"

jsonの場合、headerLabelsにカンマ区切りで指定した以下の項目を返却。拡張項目も指定可能。

項目 列名 型
グループコード ID string
親グループコード parentGroupCd string
親グループ名 parentGroup string
親グループ階層 ancestorGroups string
グループ階層 groupNameWithAncestors string
グループ名 groupName string
文字色 color string
背景色 bgColor string
形 shape integer
ソートキー sortKey integer
権限コード authCd string
権限名 authName string
備考 description string
削除フラグ delFlg integer
charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Responses

Response samples

Content type
{
  • "status": 400,
  • "message": "RequestBody is not found."
}

グループマスタの登録

  • グループマスタを指定形式(json/csv)から登録する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "ID,groupName,color,bgColor,shape"

パラメータをカンマ区切りで指定

charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Request Body schema: application/x-www-form-urlencoded

jsonデータを設定

csvFile
string <binary>

csvファイルで更新する。項目はjson同様。updateKeyが設定されている行は更新、空の場合は新規登録となる。

Responses

Response samples

Content type
{
  • "status": 200,
  • "message": "operation succeeded."
}

グループマスタの削除

  • グループマスタを削除する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

Request Body schema: application/json

jsonデータを設定

Array
ID
string

グループコード

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
appliaction/json
{
  • "status": 200,
  • "message": "operation succeeded."
}

外部場所マスタの取得

  • 外部場所マスタを指定形式で取得する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "ID,outsideName,kind,other,reservable"

jsonの場合、headerLabelsにカンマ区切りで指定した以下の項目を返却

項目 列名 型
外部場所コード ID string
外部場所名 outsideName string
種別 kind string
テキスト入力 other string
予約可能フラグ reservable integer
削除フラグ delFlg integer
charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Responses

Response samples

Content type
{
  • "status": 400,
  • "message": "RequestBody is not found."
}

外部場所マスタの登録

  • 外部場所マスタを指定形式(json/csv)から登録する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

query Parameters
format
string
Default: "json"

形式(json/csv)

lang
string
Default: "ja"

言語コード(ja/en)

headerLabels
string
Default: "ID,outsideName,kind,other,reservable"

パラメータをカンマ区切りで指定

charset
string
Default: "UTF8"

文字コード（形式がcsvの場合に指定）

Request Body schema: application/x-www-form-urlencoded

jsonデータを設定

csvFile
string <binary>

csvファイルで更新する。項目はjson同様。updateKeyが設定されている行は更新、空の場合は新規登録となる。

Responses

Response samples

Content type
{
  • "status": 200,
  • "message": "operation succeeded."
}

外部場所マスタの削除

  • 外部場所マスタを削除する
path Parameters
version
required
string

APIバージョン(1.0)

tenantCd
required
string

テナントコード

regionCd
required
string

リージョンコード

Request Body schema: application/json

jsonデータを設定

Array
ID
string

外部場所コード

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
appliaction/json
{
  • "status": 200,
  • "message": "operation succeeded."
}