設備・備品(facility)
設備・備品の取得方法に関して説明します。
設備・備品のカテゴリ取得
Request
URL
https://gateway-esm.softbrain.com/calendar-fs/v1/schedules/facilityCategory/tree
HTTP Method
GET
Response
assetType.idがカテゴリIDです。 assetType.typeNameがカテゴリ名です。
Example
[
{
"assetType.id": 1,
"assetType.typeName": "会議室",
"assetType.isNotUse": [
1
],
"assetType.sortOrder": 1,
"assetType.parentAssetTypeId": null,
"assetType.childAssetTypes": []
},
{
"assetType.id": 2,
"assetType.typeName": "ブース",
"assetType.isNotUse": [
1
],
"assetType.sortOrder": 2,
"assetType.parentAssetTypeId": null,
"assetType.childAssetTypes": []
}
]
設備・備品の検索
設備・備品の検索は下記三つのカラムを対象に行えます。
- assetName (設備・備品名)
- asset.id (設備・備品ID)
- assetTypeId (設備・備品の所属カテゴリID) ※カテゴリIDの取得方法は、設備・備品のカテゴリ取得を参照。
Request
URL
https://gateway-esm/softbrain.com/calendar-fs/v1/schedules/facility/search
HTTP Method
POST
Parameter
conditionの指定方法
column
検索対象のカラムをstringで指定します。
operator
演算子を「=」 or 「in」どちらか指定します。
value
検索条件の値を指定します。 operatorが「in」の場合はarray operatorが「=」の場合はstring or number
ref
falseを指定します。
Example
asset.id (設備・備品ID)を対象にした例
{
"condition": [
{
"column": "asset.id",
"operator": "=",
"ref": false,
"value": 2
}
]
}
assetName (設備・備品名)を対象にした例
{
"condition": [
{
"column": "assetName",
"operator": "=",
"ref": false,
"value": "M-1"
}
]
}
assetTypeId (設備・備品の所属カテゴリID)を対象にした例
{
"condition": [
{
"column": "assetTypeId",
"operator": "in",
"ref": false,
"value": [
1
]
}
]
}