From acb6ace3cfd383f7e2bd36cdb015851c7d542e42 Mon Sep 17 00:00:00 2001 From: XIQ Service Account Date: Mon, 28 Aug 2023 10:17:34 -0700 Subject: [PATCH] Publishing new release --- xcloudiq-openapi.yaml | 141 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 140 insertions(+), 1 deletion(-) diff --git a/xcloudiq-openapi.yaml b/xcloudiq-openapi.yaml index aa3b70c..8355ea9 100644 --- a/xcloudiq-openapi.yaml +++ b/xcloudiq-openapi.yaml @@ -21,7 +21,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 23.4.1.4 + version: 23.5.0.41 servers: - url: https://api.extremecloudiq.com description: ExtremeCloud IQ REST API Server @@ -1098,6 +1098,44 @@ paths: $ref: '#/components/responses/ErrorResponse' security: - BearerAuth: [] + /locations/export: + get: + tags: + - Location + summary: Export of devices and maps on location + description: The export of devices and maps on the location and/or its descendants. + externalDocs: + description: API Reference + url: https://extremecloudiq.com/api-docs/api-reference.html#_export_locations + operationId: exportLocations + parameters: + - name: locationId + in: query + description: The location ID, or null for all locations. + required: false + schema: + type: integer + format: int64 + - name: expandChildren + in: query + description: |- + Whether to return the child locations recursively, default is true. + Set it to false to improve performance when there are a lot of child locations. + required: false + schema: + type: boolean + default: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/XiqLocationExport' + default: + $ref: '#/components/responses/ErrorResponse' + security: + - BearerAuth: [] /locations/floorplan: post: tags: @@ -8043,6 +8081,103 @@ components: description: The child locations items: $ref: '#/components/schemas/XiqLocation' + XiqLocationExportDevice: + type: object + description: The device export on the location. + required: + - device_name + - serial_number + - mac_address + - device_function + - product_type + - ip_address + - location_id + - x + - y + - scale_x + - scale_y + properties: + device_name: + type: string + description: The name of the device. + serial_number: + type: string + description: The device serial number. + mac_address: + type: string + description: The device MAC address. + device_function: + type: string + description: The device function, such as AP, Router, Switch, etc. + product_type: + type: string + description: 'The product type, such as: AP_230, BR_100, NX9600, etc.' + ip_address: + type: string + description: The device IPv4 address. + location_id: + type: integer + description: The location ID of the device on the location hierarchy. + format: int64 + map_name: + type: string + description: The background map for the device overlay. + x: + type: number + description: The x-position of the device relative to the horizontal scale in meter. + format: double + y: + type: number + description: The y-position of the device relative to the vertical scale in meter. + format: double + scale_x: + type: number + description: The horizontal scale for the background map in meter. + format: double + scale_y: + type: number + description: The vertical scale for the background map in meter. + format: double + XiqLocationExportMap: + type: object + description: The map export on the location. + required: + - map_name + - width + - height + - data + properties: + map_name: + type: string + description: The background map name. + width: + type: number + description: The x-dimension of the map in pixels. + format: double + height: + type: number + description: The y-dimension of the map in pixels. + format: double + data: + type: string + description: The base-64 encoded string of the map. + XiqLocationExport: + type: object + description: The export of devices and maps on the location hierarchy + required: + - devices + - maps + properties: + devices: + type: array + description: The associated devices on the location hierarchy. + items: + $ref: '#/components/schemas/XiqLocationExportDevice' + maps: + type: array + description: The associated background map metadata. + items: + $ref: '#/components/schemas/XiqLocationExportMap' XiqUpdateLocationRequest: type: object properties: @@ -9675,6 +9810,7 @@ components: - DESCRIPTION - DEVICE_MAC_ADDRESS - ALIAS + - PRODUCT_TYPE XiqClientView: type: string description: The logic collections of client fields

BASIC: ID, ORG_ID, HOSTNAME, MAC_ADDRESS, IP_ADDRESS, IPV6_ADDRESS, OS_TYPE, DEVICE_ID,CONNECTED, ONLINE_TIME, OFFLINE_TIME, CONNECTION_TYPE, SSID, PORT
FULL: All fields
STATUS: ID, CONNECTED, ONLINE_TIME, OFFLINE_TIME
DETAIL: ID, CREATE_TIME, UPDATE_TIME, ORG_ID, ORG_NAME, LOCATION_ID, HOSTNAME, MAC_ADDRESS, IP_ADDRESS, IPV6_ADDRESS, OS_TYPE, DEVICE_ID, DEVICE_FUNCTION, DEVICE_NAME, DEVICE_MAC_ADDRESS, USERNAME, USER_PROFILE_NAME, CONNECTED, ONLINE_TIME, OFFLINE_TIME, VLAN, CONNECTION_TYPE, SSID, PORT, BSSID, PORT_TYPE_NAME, INTERFACE_NAME, AUTH, ENCRYPTION_METHOD, CHANNEL, RSSI, SNR, WING_AP, VENDOR, RADIO_TYPE, ALIAS
LOCATION: ID, LOCATION_ID, LOCATIONS
METRICS: ID, CLIENT_HEALTH, APPLICATION_HEALTH, NETWORK_HEALTH, RADIO_HEALTH
IOT: ID, MOBILITY, CATEGORY, DESCRIPTION @@ -9830,6 +9966,9 @@ components: description: The detailed location items: $ref: '#/components/schemas/XiqLocationLegend' + productType: + type: string + description: The Category which describes the Extreme device types(For example:SR_2208P, AP_4000, AP_5010) alias: type: string maxLength: 255