この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
この API は、通知ルールでサポートされているすべてのノースバウンド通知タイプと該当する属性を返します。
GET
/api/configuration/v1/attributes
N
なし。
application/json
{"networkdesignchanged":{"triggerHeterarchyChanged":
{"name":"triggerHeterarchyChanged","dataType":"BOOLEAN","nameSpace":"networkdesignchanged",
"validValueSet":[],"needValueCheck":false,"evaluateByProvider":false},
"triggerNetworkDesignChanged":{"name":"triggerNetworkDesignChanged",
"dataType":"BOOLEAN","nameSpace":"networkdesignchanged","validValueSet":[],
"needValueCheck":false,"evaluateByProvider":false}},"servicestatus":{"oldStatus":
{"name":"oldStatus","dataType":"ENUM","nameSpace":"servicestatus","validValueSet":
["STOPPED","RUNNING","CRASHED","DISABLED"],"needValueCheck":false,"evaluateByProvider":
false},"status":{"name":"status","dataType":"ENUM","nameSpace":"servicestatus",
"validValueSet":["STOPPED","RUNNING","CRASHED","DISABLED"],"needValueCheck":true,
"evaluateByProvider":true},"statusChanged":{"name":"statusChanged","dataType":"BOOLEAN",
"nameSpace":"servicestatus","validValueSet":[],"needValueCheck":true,"evaluateByProvider":
false}}}
この API は、CMX イメージの現在のバージョンを返します。
GET
/api/config/v1/version/image
N
なし。
application/json
この API は、アクティブ アラートの数を返します。
GET
/api/config/v1/alerts/count
N
なし。
application/json
この API は、すべてのアクティブ アラートを返します。
GET
/api/config/v1/alerts
N
なし。
application/json
この API は、ユーザにロールを追加します。
POST
/api/config/v1/aaa/users/:username/role/:rolename
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
username |
Y |
— |
文字列 |
pathReplace |
ユーザのユーザ名 |
|
rolename |
Y |
— |
文字列 |
pathReplace |
ユーザに追加するロールの名前。 |
application/json
ユーザからロールを削除します。
DELETE
/api/config/v1/aaa/users/:username/role/:rolename
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
username |
Y |
— |
文字列 |
pathReplace |
対象とするユーザのユーザ名。 |
|
rolename |
Y |
— |
文字列 |
pathReplace |
このユーザから削除する必要のあるロールの名前。 |
application/json
この API は、システム内のすべてのユーザの詳細を取得します。
GET
/api/config/v1/aaa/users
N
なし。
application/json
この API は、ユーザを作成するために使用します。
POST
/api/config/v1/aaa/users
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
___username |
Y |
— |
string |
body |
ユーザのユーザ名 |
|
password |
Y |
— |
string |
body |
ユーザのパスワード |
|
firstName |
N |
— |
string |
body |
ユーザの名。 |
|
lastname |
N |
— |
string |
body |
ユーザの姓。 |
|
ロール |
N |
— |
text |
body |
このユーザのロール。 |
|
developerkey |
N |
— |
string |
body |
CMX API 開発者キー。 |
|
lastlogin |
N |
— |
text |
body |
ユーザの最終ログイン。 |
application/json
この API は、ユーザの属性を変更します。
POST
/api/config/v1/aaa/users/:username
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
username |
Y |
— |
文字列 |
pathReplace |
ユーザのユーザ名。 |
|
___username |
Y |
— |
string |
body |
ユーザのユーザ名 |
|
password |
Y |
— |
string |
body |
ユーザのパスワード |
|
firstName |
N |
— |
string |
body |
ユーザの名。 |
|
lastname |
N |
— |
string |
body |
ユーザの姓。 |
|
ロール |
N |
— |
text |
body |
このユーザに割り当てられているロール。 |
|
developerkey |
N |
— |
string |
body |
CMX API 開発者キー。 |
|
lastlogin |
N |
— |
text |
body |
ユーザの最終ログイン。 |
application/json
この API は、ユーザ名を基準にユーザを取得します。
GET
/api/config/v1/aaa/users/:username
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
username |
Y |
— |
文字列 |
pathReplace |
ユーザ名 |
application/json
この API は、ユーザを削除します。
DELETE
/api/config/v1/aaa/users/:username
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
username |
Y |
— |
文字列 |
pathReplace |
ユーザ名。 |
application/json
この API は、すべてのロールを取得します。
GET
/api/config/v1/aaa/roles
N
なし。
application/json
この API は、すべてのキャンパスに関する情報を取得します。
GET
/api/config/v1/campuses
N
なし。
application/json
この API は、名前を基準にキャンパスを返します。
GET
/api/config/v1/campuses/:name
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
name |
Y |
— |
文字列 |
pathReplace |
キャンパス名。 |
application/json
この API は、キャンパスを追加するために使用します。
PUT
/api/config/v1/campuses
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
objectVersion |
N |
— |
number |
body |
オブジェクトのバージョン |
|
name |
Y |
— |
string |
body |
キャンパスの名前。この値は一意である必要があります。 |
|
dimension |
N |
— |
text |
body |
寸法 |
|
image |
N |
— |
text |
body |
イメージ |
|
buildingList |
N |
— |
text |
body |
キャンパス内のビルのリスト。 |
|
aesUid |
N |
— |
number |
body |
aesUid |
|
aesUidString |
N |
— |
string |
body |
aesUidString |
|
members |
N |
— |
text |
body |
メンバー |
application/json
この API は、キャンパス、ビル、フロアの数を表示します。
GET
/api/config/v1/maps/count
N
なし。
application/json
この API は、すべてのビルのリストを表示します。
GET
/api/config/v1/maps/building/list/:name
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
name |
Y |
— |
文字列 |
pathReplace |
キャンパス名。 |
application/json
この API は、すべてのビルのリストを表示します。
GET
/api/config/v1/maps/building/list
N
なし。
application/json
この API は、システム内のすべてのフロアのリストを表示します。
GET
/api/config/v1/maps/floor/list/:name
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
name |
Y |
— |
文字列 |
pathReplace |
ビル名 |
application/json
この API は、システム内のすべてのフロアのリストを表示します。
GET
/api/config/v1/maps/floor/list
N
なし。
application/json
この API は、すべてのマップを返します。
GET
/api/config/v1/maps
N
なし。
application/json
この API は、名前を基準にキャンパスを返します。
GET
/api/config/v1/maps/info/:campusName
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
campusName |
Y |
— |
文字列 |
pathReplace |
キャンパス名。 |
application/json
この API は、名前を基準にビルを返します。
GET
/api/config/v1/maps/info/:campusName/:buildingName
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
campusName |
Y |
— |
文字列 |
pathReplace |
キャンパス名。 |
|
buildingName |
Y |
— |
文字列 |
pathReplace |
ビル名。 |
application/json
この API は、特定のビルとキャンパスに基づき、名前を基準にフロアを返します。
GET
/api/config/v1/maps/info/:campusName/:buildingName/:floorName
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
campusName |
Y |
— |
文字列 |
pathReplace |
キャンパス名。 |
|
buildingName |
Y |
— |
文字列 |
pathReplace |
ビル名。 |
|
floorName |
Y |
— |
文字列 |
pathReplace |
フロア名。 |
application/json
この API は、特定のキャンパス、ビル、フロアの名前の組み合わせを基準に、フロア イメージを返します。
GET
/api/config/v1/maps/image/:campusName/:buildingName/:floorName
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
campusName |
Y |
— |
文字列 |
pathReplace |
キャンパス名。 |
|
buildingName |
Y |
— |
文字列 |
pathReplace |
ビル名。 |
|
floorName |
Y |
— |
文字列 |
pathReplace |
フロア名。 |
application/json
この API は、イメージ名を基準にイメージを返します。
GET
/api/config/v1/maps/imagesource/:imageName
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
imageName |
Y |
— |
文字列 |
pathReplace |
イメージ名。 |
application/json
この API は、すべてのプレゼンス サイトを返します。
GET
/api/config/v1/sites
N
なし。
application/json
この API は、指定された ID または名前のプレゼンス サイトを返します。
GET
/api/config/v1/sites/:id
N
なし。
application/json
この API は、システム設定を取得します。
GET
/api/config/v1/system/preferences/:component/:key
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
component |
Y |
— |
文字列 |
pathReplace |
コンポーネント。 |
|
キー |
N |
— |
文字列 |
pathReplace |
取得するキー。設定されない場合、指定されたコンポーネントのすべてのキーが取得されます。 |
application/json
この API は、システム設定を保存するために使用します。この操作を実行することができるのは「管理者」グループに属するユーザのみです。
PUT
/api/config/v1/system/preferences/:component/:key
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
component |
Y |
— |
文字列 |
pathReplace |
コンポーネント。 |
|
key |
Y |
— |
文字列 |
pathReplace |
キー。 |
|
文字列 |
Y |
— |
string |
body |
値。 |
application/json
この API は、すべての通知サブスクリプションを返します。
GET
/api/config/v1/notifications
N
なし。
application/json
この API は、名前を基準に通知サブスクリプションを返します。
GET
/api/config/v1/notifications/:name
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
name |
Y |
— |
文字列 |
pathReplace |
通知の名前。 |
application/json
この API は、通知サブスクリプションの有無をチェックします。存在する場合は FOUND(302) を返し、見つからない場合は 404 を返します。
GET
/api/config/v1/notifications/exists/:name
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
name |
Y |
— |
文字列 |
pathReplace |
通知の名前。 |
application/json
この API は、通知サブスクリプションを追加するために使用します。
PUT
/api/config/v1/notification
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
userId |
Y |
— |
string |
body |
ユーザ ID。 |
|
ルール |
Y |
— |
text |
body |
ルールのリスト。 |
|
subscribers |
Y |
— |
text |
body |
サブスクライバ |
|
notificationType |
Y |
— |
列挙型 |
body |
次のいずれかの通知タイプを選択します。
|
|
enabled |
N |
— |
列挙型 |
body |
enabled
|
|
enableMacScrambling |
N |
— |
列挙型 |
body |
enableMacScrambling
|
application/json
この API は、通知サブスクリプションのリストを追加するために使用します。
PUT
/api/config/v1/notifications
N
なし。
application/json
この API は、通知サブスクリプションを削除するために使用します。
DELETE
/api/config/v1/notifications/:name
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
name |
Y |
— |
文字列 |
pathReplace |
通知の名前。 |
application/json
この API は、名前を基準にシステム アラートの通知サブスクリプションを返します。
GET
/api/config/v1/notifications/alerts
N
なし。
application/json
この API は、名前を基準にシステム アラートの通知サブスクリプションを返します。
GET
/api/config/v1/notifications/alerts/:name
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
name |
Y |
— |
文字列 |
pathReplace |
通知の名前。 |
application/json
この API は、システム アラート サブスクリプションを追加するために使用します。
PUT
/api/config/v1/notifications/alert
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
severity |
Y |
— |
列挙型 |
body |
次の重大度レベルのいずれかを選択します。
|
|
userId |
Y |
— |
string |
body |
ユーザ ID。 |
|
ルール |
Y |
— |
text |
body |
ルールのリスト。 |
|
subscribers |
Y |
— |
text |
body |
サブスクライバ |
|
notificationType |
Y |
— |
列挙型 |
body |
次のいずれかの通知タイプを選択します。
|
|
enabled |
N |
— |
列挙型 |
body |
イネーブル
|
|
enableMacScrambling |
N |
— |
列挙型 |
body |
enableMacScrambling
|
application/json
この API は、システム アラート サブスクリプションのリストを追加するために使用します。
PUT
/api/config/v1/notifications/alerts
N
なし。
application/json
この API は、システム アラートの通知サブスクリプションを削除するために使用します。
DELETE
/api/config/v1/notifications/alerts/:name
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
name |
Y |
— |
文字列 |
pathReplace |
通知の名前。 |
application/json
この API は、名前を基準に通知サブスクリプションを有効/無効に設定します。
POST
/api/config/v1/notifications/:name/:action
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
name |
Y |
— |
文字列 |
pathReplace |
通知の名前。 |
|
アクション |
Y |
— |
文字列 |
pathReplace |
イネーブル/ディセーブル |
application/json
この API は、時間間隔を基準に、ユニーク アラートのリストを返します。
GET
/api/config/v1/history/alerts/unique
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
startTime |
Y |
— |
Number |
query |
開始時間（ミリ秒）を指定します。 |
|
endTime |
Y |
— |
Number |
query |
終了時間（ミリ秒）を指定します。 |
application/json
この API は、時間間隔を基準にアラートのリストを返します。
GET
/api/config/v1/history/alerts
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
startTime |
Y |
— |
Number |
query |
開始時間（ミリ秒）を指定します。 |
|
endTime |
Y |
— |
Number |
query |
終了時間（ミリ秒）を指定します。 |
application/json
この API は、時間間隔とハッシュキーを基準にアラートのリストを返します。
GET
/api/config/v1/history/alerts/:key
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
キー |
Y |
— |
文字列 |
pathReplace |
アラート ハッシュキー。これは、/config/v1/alerts を呼び出すことで取得できます。 |
|
startTime |
Y |
— |
Number |
query |
開始時間（ミリ秒）を指定します。 |
|
endTime |
Y |
— |
Number |
query |
終了時間（ミリ秒）を指定します。 |
application/json
この API は、特定のアラート キーに対して作成されたアラートの合計数を返します。
GET
/api/config/v1/history/alert/count/:key
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
キー |
Y |
— |
文字列 |
pathReplace |
アラート ハッシュキー。これは、/config/v1/alerts を呼び出すことで取得できます。 |
application/json
この API は、すべてのアクセス ポイントを返します。
GET
/api/config/v1/aps
N
なし。
application/json
この API は、指定されたアクセス ポイント MAC アドレスを基準にアクセス ポイントを返します。
GET
/api/config/v1/aps/:mac
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
mac |
Y |
— |
文字列 |
pathReplace |
アクセス ポイントの MAC アドレス。 |
application/json
この API は、指定されたユーザの設定を取得します。
GET
/api/config/v1/user/preferences/:userid/:component/:key
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
userid |
Y |
— |
文字列 |
pathReplace |
ユーザ ID。 |
|
component |
Y |
— |
文字列 |
pathReplace |
コンポーネント。 |
|
キー |
N |
— |
文字列 |
pathReplace |
取得するキー。設定されない場合、指定されたコンポーネントのすべてのキーが取得されます。 |
application/json
この API は、指定されたユーザの設定を保存します。
PUT
/api/config/v1/user/preferences/:userid/:component/:key
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
userid |
Y |
— |
文字列 |
pathReplace |
ユーザ ID。 |
|
component |
Y |
— |
文字列 |
pathReplace |
コンポーネント。 |
|
key |
Y |
— |
文字列 |
pathReplace |
キー。 |
|
json |
N |
— |
文字列 |
query |
渡されるデータが JSON であるかどうか。このパラメータを設定すると、データが検証されて、不正なフォーマットの JSON は拒否されます。有効な値/形式は true または false です。 |
|
文字列 |
Y |
— |
string |
body |
値 |
application/json
この API は、すべての Cisco WLC コントローラのリストを表示します。
GET
/api/config/v1/controllers
N
なし。
application/json
この API は、指定された IP アドレスを基準にコントローラを返します。
GET
/api/config/v1/controllers/:ipAddress
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
ipAddress |
Y |
— |
文字列 |
pathReplace |
IP アドレス。 |
application/json
http://10.68.40.131/api/config/v1/controllers/10.68.40.124
{"name":null,"ipAddress":"10.68.40.124","readOnlyComm":null,"writeComm":
"iuBXuWikK4nfq52YKODcUg==","snmpVersion":1,"version":"8.1.131","userName":"admin",
"authType":0,"authPassword":null,"privType":0,"privPassword":null,"macAddress":null,
"sysUpTime":0,"unauthenticatedConnection":false,"applicableServices":[0],"aesUId":
1448982516930,"objectVersion":0,"tagNotificationInterval":0,"wlanConfigList":[],
"deviceVersion":null,"type":"WLC","enablePassword":null,"peerMode":false,"members":
null}
この API は、コントローラを追加するために使用します。
PUT
/api/config/v1/controllers
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
name |
Y |
— |
string |
body |
ワイヤレス LAN コントローラの名前。 |
|
ipAddress |
Y |
— |
string |
body |
ワイヤレス LAN コントローラの IP アドレス。 |
|
readOnlyComm |
Y |
— |
string |
body |
SNMP 読み取りコミュニティ。 |
|
writeComm |
Y |
— |
string |
body |
SNMP 書き込みコミュニティ。 |
|
snmpVersion |
N |
— |
number |
body |
SNMP バージョン。 |
|
version |
Y |
— |
string |
body |
WLC コントローラのソフトウェア バージョン。 |
|
userName |
Y |
— |
string |
body |
Telnet 接続のユーザ名。 |
|
authType |
Y |
— |
number |
body |
SNMP V3 認証タイプ。 |
|
authPassword |
N |
— |
string |
body |
認証パスワード。 |
|
privType |
N |
— |
number |
body |
プライバシー タイプ。 |
|
privPassword |
N |
— |
string |
body |
パスワード。 |
|
macAddress |
N |
— |
string |
body |
MAC アドレス。 |
|
sysUpTime |
N |
— |
number |
body |
システムの稼働時間。 |
|
unauthenticatedConnection |
N |
— |
列挙型 |
body |
WLC コントローラに接続するための認証。 |
|
applicableServices |
Y |
— |
配列 |
body |
コントローラに登録するサービス。 |
|
aesUId |
Y |
— |
number |
body |
Cisco Prime Infrastructure によって生成された一意の ID。Cisco Prime Infrastructure にょって ID が生成されない場合は、一意の値を使用してください。 |
|
objectVersion |
N |
— |
number |
body |
オブジェクトのバージョン。 |
|
tagNotificationInterval |
N |
— |
number |
body |
タグ通知間隔。 |
|
wlanConfigList |
N |
— |
text |
body |
WLC コントローラ設定のリスト。 |
|
deviceVersion |
N |
— |
string |
body |
デバイスのバージョン。 |
|
type |
N |
— |
列挙型 |
body |
type
|
|
enablePassword |
N |
— |
string |
body |
enablePassword |
|
peerMode |
N |
— |
列挙型 |
body |
peerMode
|
|
members |
N |
— |
text |
body |
メンバー。 |
application/json
この API は、オプトアウト サービスにデバイスを追加します。
POST
/api/configuration/v1/optout/devices
N
なし。
application/json
この API は、オプトアウト サービスからデバイス リストを削除します。
DELETE
/api/configuration/v1/optout/devices
N
なし。
application/json
この API は、オプトアウト サービスからすべてのオプトアウト デバイスを削除するために使用します。
DELETE
/api/configuration/v1/optout/devices/all
N
なし。
application/json
この API は、指定された日付範囲内のすべてのオプトアウト デバイスのリストを返します。
GET
/api/configuration/v1/optout/devices
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
validFrom |
N |
— |
文字列 |
query |
日付範囲の開始日。有効な値/形式は yyyy-mm-dd hh:mm:ss です。 |
|
validTo |
N |
— |
文字列 |
query |
日付範囲の終了日。有効な値/形式は yyyy-mm-dd hh:mm:ss です。 |
application/json
この API は、オプトアウト デバイスの数を返します。
GET
/api/configuration/v1/optout/count
N
なし。
application/json
{"Opt-out Device count":0}
この API は、オプトアウト デバイスを削除します。
DELETE
/api/configuration/v1/optout/devices/date
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
validFrom |
N |
— |
文字列 |
query |
日付範囲の開始日。有効な値/形式は yyyy-mm-dd hh:mm:ss です。 |
|
validTo |
N |
— |
文字列 |
query |
日付範囲の終了日。有効な値/形式は yyyy-mm-dd hh:mm:ss です。 |
application/json
このコールは、多頭的階層要素の子スーパーゾーン ID と、それらの子スーパーゾーンの下にネストされている子フロアの AES ID を取得します。対象の要素は API コールのパス（フル パスまたは要素 ID。要素 ID の取得方法についての詳細は、「Add/Update zones or tags」を参照）で識別されます。
GET
/api/config/v1/heterarchy/:pathSegments/childrenfloors
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
pathSegments |
N |
— |
文字列 |
pathReplace |
対象とする要素のフル パスまたは要素 ID。 |
|
validDate |
N |
— |
文字列 |
query |
指定した日付（yyyy-mm-dd HH:mm:ss）において有効な要素を表示します。有効な値/形式は yyyy-mm-dd HH:mm:ss です。 |
|
level |
N |
— |
文字列 |
query |
レベルの名前（SUPERZONE、FLOOR、AP、POI、または ZONE）。有効な値/形式は SUPERZONE FLOOR AP ZONE POI です。 |
application/json
このコールは、多頭的階層要素の子スーパーゾーン ID と、それらの子スーパーゾーンの下にネストされている子要素の合計数を取得します。対象の要素は API コールのパス（フル パスまたは要素 ID。要素 ID の取得方法についての詳細は、「Add/Update zones or tags」を参照）で識別されます。レベルを指定すると、そのレベルの子要素だけが取得されます。
GET
/api/config/v1/heterarchy/:pathSegments/childrencounts
N
|
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
|---|---|---|---|---|---|
|
pathSegments |
N |
— |
文字列 |
pathReplace |
対象とする要素のフル パスまたは要素 ID。 |
|
validDate |
N |
— |
文字列 |
query |
指定した日付（yyyy-mm-dd HH:mm:ss）から有効な要素を表示します。有効な値/形式は yyyy-mm-dd HH:mm:ss です。 |
|
level |
N |
— |
文字列 |
query |
レベルの名前（SUPERZONE、FLOOR、AP、POI、または ZONE）。有効な値/形式は SUPERZONE FLOOR AP ZONE POI です。 |
application/json
フィードバック