{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"open-api","parameters":{"macroParams":{"__bodyContent":{"value":"openapi: 3.0.0\ninfo:\n title: Amino Engage APIs\n description: >-\n # Disclaimer\n\n\n This document contains information on a product under development. Amino\n Communications Ltd reserves the right to change or discontinue this product\n without notice.\n\n\n # Trademarks and copyright\n\n\n Amino Communications and the Amino logo are trademarks of Amino\n Communications Limited.\n\n\n All other trademarks are the property of their respective owners.\n\n\n © Amino Communications Ltd, 2021\n\n\n Confidential\n\n\n # Amino contact details\n\n\n | Method | Contact
|\n\n | --- | --- |\n\n | Telephone | From UK: (01954) 234100
International: +44 1954 234100 |\n\n | Fax | From UK: (01954) 234101
International: +44 1954 234101 |\n\n | E-mail | [info@aminocom.com](mailto:info@aminocom.com) |\n\n | Web | [www.aminocom.com](http://www.aminocom.com) |\n\n\n Comments about the documentation are welcome. Please submit feedback to\n [docs@aminocom.com](mailto:docs@aminocom.com).\n\n\n For further information about Amino or Amino products, please e-mail\n [info@aminocom.com](mailto:info@aminocom.com).\n\n\n # Time Zone and Date Time Format\n\n\n Unless it is specified, the time is in UTC time zone and the format is in\n yyyy-MM-dd HH:mm:ss in the document.\n\n\n # Authentication\n\n\n For integration purposes, the following APIs are accessible from the public\n domain and require SSL mutual authentication. Client must pass their private\n key (domain.key) and the x509 certificate (domain.crt) which is signed by\n Amino.\n\n\n ## How to request a x509 certificate\n\n\n In order to access the API, customers need a private key and a x509\n certificate from Amino, which are used for authentication.\n\n\n Following steps use the `openssl` command. If you use another tool, please\n refer to its manual accordingly.\n\n\n First, customers need to generate their own private key (domain.key). This\n file is just like a password, so it should **NOT** be exposed to others.\n\n\n ```\n\n openssl genrsa -out domain.key 2048 \n\n\n ```\n\n\n Then, customers can use the private key to create a CSR file. You will be\n asked to input the information of the certificate. Just make sure that you\n enter your ENGAGE’s domain name for the **Common Name**. Other information\n can be arbitrary or enter '.' for blank.\n\n\n ```\n\n openssl req -new -key domain.key -out domain.csr \n\n\n ```\n\n\n Later, customers give the CSR file (domain.csr) to Amino’s support. Our\n support will generate the x509 certificate (domain.crt) for you.\n\n\n Finally, customers can use their own private key (domain.key) and the x509\n certificate (domain.crt) to access the integration API.\n\n\n **Important Note** - The APIs will work against the top level domain only\n and not any sub domains.\n version: Rev29\ntags:\n - name: System Integration APIs\n description: 'Note that system APIs are called from server: engage.aminoengage.com:2443'\n - name: APIs to operate the device directly\n description: >-\n Note that the APIs are called from server: engage.aminoengage.com:2443.\n\n\n Only for devices supporting webengine (protocol version >= 3.2) and\n connecting to Resolve can use these APIs.\n - name: Manage Integration APIs\n description: 'Note that manage APIs are called from server: ensure.aminoengage.com:2443'\n - name: Resolve Integration APIs\n description: >-\n Note that resolve APIs are called from server:\n ensight.aminoengage.com:2443\npaths:\n /engage/sapi/device/register:\n post:\n tags:\n - System Integration APIs\n summary: Register device\n description: >-\n # **Description**\n\n\n Register a new device.\n\n\n If registration is successful, a device json will be returned.\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key --data\n \"sn=26-9999999&mac=0003e6999999&productClass=26&deviceType=1&operator=SampleDomain\"\n https://engage.aminoengage.com:2443/engage/sapi/device/register\n\n\n ```\n servers:\n - url: https://engage.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n sn:\n type: string\n description: 'Serial number '\n example: 11-1111110\n mac:\n type: string\n description: >-\n MAC address. You must specify either the OUI or MAC for this\n api \n oui:\n type: string\n description: >-\n OUI identifies the manufacturer. You must specify either the\n OUI or MAC for this api \n example: '0003E6'\n deviceType:\n type: integer\n description: |-\n 1 for Enable \\\n 3 for Aminet \\\n 5 for PCCW with ENABLE \\\n 7 for Android \\\n 8 for Enable Enterprise \\\n 9 for Enable (R Series) \n example: '1'\n productClass:\n type: integer\n description: 'Product class '\n example: '11'\n subscriber:\n type: string\n description: 'Optional, set the subscriber field if specified '\n example: test-subscriber\n referenceId:\n type: string\n description: 'Optional, set the referenceId field if specified '\n example: test-reference\n operator:\n type: string\n description: >-\n Optional, the domain of the registering device. Set the\n certificated domain if not specified. \n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RegisterDeviceResponse'\n example:\n id: 8855904\n sn: 11-1111111\n oui: '0003E6'\n productClass: '11'\n mac: null\n deviceTypeId: 1\n subscriber: test-subscriber\n referenceId: test-reference\n others: null\n dateCreated: '2023-03-28 06:59:10'\n lastUpdated: '2023-03-28 06:59:10'\n operator: Amino Communications\n '400':\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RegisterDeviceErrorResponse'\n example:\n error: >-\n Failed to proceed as device 11-1111110 already exists. Please\n check the input.\n /engage/sapi/device/delete:\n post:\n tags:\n - System Integration APIs\n summary: Delete device\n description: >-\n # **Description**\n\n\n Delete a device.\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key --data\n \"sn=26-9999999\" https://engage.aminoengage.com:2443/engage/sapi/device/delete\n\n\n ```\n servers:\n - url: https://engage.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n id:\n type: string\n description: >-\n The identifier returning from the register API, the api will\n look up the device record by ID. You must specify either the\n id, sn, or mac for this api. \n sn:\n type: string\n description: >-\n Serial number, the api will look up the device record by\n serial number. You must specify either the id, sn, or mac\n for this api. \n example: 11-1111110\n deviceType:\n type: string\n description: |-\n 1 for Enable \\\n 3 for Aminet \\\n 5 for PCCW with ENABLE \\\n 7 for Android \\\n 8 for Enable Enterprise \\\n 9 for Enable (R Series) \\\n ***if not specified, default set to 1\n mac:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n oui:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n productClass:\n type: string\n description: >-\n Optional, this an additional field to search the device\n record. \n responses:\n '200':\n description: OK\n '400':\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DeleteDeviceErrorResponse'\n example:\n error: Device Not Found\n /engage/sapi/device/get:\n post:\n tags:\n - System Integration APIs\n summary: Get device\n description: >-\n # **Description**\n\n\n Get the details of device(s).\n\n\n The maximum number of devices can be return is 1000.\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key --data\n \"matchType=exact&sn=26-9999999\" https://engage.aminoengage.com:2443/engage/sapi/device/get\n\n\n ```\n servers:\n - url: https://engage.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n id:\n type: string\n description: >-\n The identifier returning from the register API, the api will\n look up the device records by ID. \n sn:\n type: string\n description: >-\n Serial number, the api will look up the device records by\n serial number. \n example: 105-6594764\n deviceType:\n type: integer\n description: |-\n 1 for Enable \\\n 3 for Aminet \\\n 5 for PCCW with ENABLE \\\n 7 for Android \\\n 8 for Enable Enterprise \\\n 9 for Enable (R Series) \\\n ***if not specified, default set to 1\n example: '7'\n mac:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n oui:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n productClass:\n type: string\n description: >-\n Optional, the api will look up the device records by product\n class. \n subscriber:\n type: string\n description: >-\n Optional, the api will look up the device records by\n subscriber field. \n referenceId:\n type: string\n description: >-\n Optional, the api will look up the device records by\n referenceId field. \n matchType:\n type: string\n description: >-\n Optional, the match type of the lookup filter. By default,\n it is exact match if not specified. \\\n\n Allowed value: [ exact | partial ]\n example: exact\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/GetDeviceResponseElement'\n example:\n - id: 4341782\n sn: 105-6594764\n oui: '0003E6'\n productClass: '105'\n mac: 0003E6C94198\n deviceTypeId: 7\n subscriber: ''\n referenceId: ''\n others: ''\n dateCreated: '2021-03-11 04:55:16'\n lastUpdated: '2023-03-17 07:39:34'\n operator: Amino Communications\n ip: 118.140.253.98\n lanIp: 10.0.35.251\n /engage/sapi/device/update:\n post:\n tags:\n - System Integration APIs\n summary: Update device\n description: >-\n # **Description**\n\n\n Update the details of a device.\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key --data\n \"sn=26-9999999&subscriber=zzHome&referenceId=Z1234\"\n https://engage.aminoengage.com:2443/engage/sapi/device/update\n\n\n ```\n servers:\n - url: https://engage.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n id:\n type: string\n description: >-\n The identifier returning from the register API, the api will\n look up the device record by ID. You must specify either the\n id, sn, or mac for this api. \n sn:\n type: string\n description: >-\n Serial number, the api will look up the device record by\n serial number. You must specify either the id, sn, or mac\n for this api. \n example: 11-1111110\n deviceType:\n type: string\n description: |-\n 1 for Enable \\\n 3 for Aminet \\\n 5 for PCCW with ENABLE \\\n 7 for Android \\\n 8 for Enable Enterprise \\\n 9 for Enable (R Series) \\\n ***if not specified, default set to 1\n mac:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n oui:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n productClass:\n type: string\n description: >-\n Optional, this an additional filter to lookup the device\n record. \n subscriber:\n type: integer\n description: 'Optional, update the subscriber field if specified '\n example: '1112604'\n referenceId:\n type: string\n description: 'Optional, update the referenceId field if specified '\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UpdateDeviceResponse'\n example:\n id: 8855917\n sn: 11-1111110\n oui: '0003E6'\n productClass: '11'\n mac: null\n deviceTypeId: 1\n subscriber: '1112604'\n referenceId: null\n others: null\n dateCreated: '2023-03-28 09:44:58'\n lastUpdated: '2023-03-28 09:45:13'\n operator: Amino Communications\n '400':\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UpdateDeviceErrorResponse'\n example:\n error: Device Not Found\n /engage/sapi/device/rebootViaEnsight:\n post:\n tags:\n - System Integration APIs\n summary: Reboot devices via Resolve\n description: >-\n # Description\n\n\n Reboot the device(s) via RESOLVE channel. This api is asynchronized. It\n will response a `batch_id`, which can be used in API, **Check Resolve's\n Batch Command Status**, to check the command status.\n\n\n ## Request example\n\n\n Example using `sns` parameter:\n\n\n ```\n\n curl --cert domain.crt --key domain.key --data\n \"sns=26-9999999&sns=26-9999998&sns=26-9999997&ts=1514764800\"\n https://engage.aminoengage.com:2443/engage/sapi/device/rebootViaEnsight\n\n\n ```\n\n\n Example using a file with content of sn list:\n\n\n ```\n\n curl --cert domain.crt --key domain.key --data-binary \"@path/to/sn list\n file\" --data \"ts=1514764800\"\n https://engage.aminoengage.com:2443/engage/sapi/device/rebootViaEnsight\n\n\n ```\n\n\n where the content of the file is:\n\n\n ```\n\n sns=26-9999999&sns=26-9999998&sns=26-9999997 \n\n\n ```\n servers:\n - url: https://engage.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n sns:\n type: string\n description: >-\n Array of Serial number. You must specify either sns or macs\n for this api. Max. size of the array is 1000 \n example: 11-1111110\n macs:\n type: string\n description: >-\n Array of MAC address. You must specify either sns, or macs\n for this api. Max. size of the array is 1000 \n ts:\n type: string\n description: 'Unix Timestamp '\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RebootDevicesViaResolveResponse'\n example:\n batch_id: 7542\n '400':\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RebootDevicesViaResolveErrorResponse'\n example:\n error: Device[11-1111110] Not Found\n /engage/sapi/ensight/batch-command/status:\n post:\n tags:\n - System Integration APIs\n summary: Check Resolve's batch command status\n description: >-\n # Description\n\n\n Check the command status. Followings are the possible status:\n\n\n | Status Value | Description |\n\n | --- | --- |\n\n | queued | The command has been not delivered to the device yet. |\n\n | SENT | The command has been delivered to the device, but the device\n has not responded. |\n\n | NA | The device has responded that the command is not available. |\n\n | NE | The device has responded that the command has not been executed\n yet. |\n\n | S | The device has responded that the command has been executed\n successfully. |\n\n\n ## Request example\n\n\n ```\n\n curl --cert domain.crt --key domain.key --data \"batch_id=1000\"\n https://engage.aminoengage.com:2443/engage/sapi/ensight/batch-command/status\n\n\n ```\n servers:\n - url: https://engage.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n batch_id:\n type: integer\n description: 'The batch_id responsed from batch API '\n example: '7544'\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: >-\n #/components/schemas/CheckResolveSBatchCommandStatusResponseElement\n example:\n - esn: 11-1111110\n status: queued\n '404':\n description: Not Found\n content:\n application/json:\n schema:\n $ref: >-\n #/components/schemas/CheckResolveSBatchCommandStatusErrorResponse\n example:\n msg: No matching batch command.\n /engage/sapi/device/uploadViaEnsight:\n post:\n tags:\n - System Integration APIs\n summary: Upload data via Resolve\n description: >-\n # **Description**\n\n\n Upload data via Resolve channel. See **Download data via Resolve** API\n for downloading data.\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key --data\n \"sns=26-9999999&sns=26-9999998&sns=26-9999997&type=diagnostic_menu\"\n https://engage.aminoengage.com:2443/engage/sapi/device/uploadViaEnsight\n\n\n ```\n servers:\n - url: https://engage.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n sns:\n type: string\n description: >-\n Array of Serial number. You must specify either sns, macs,\n subscribers or referenceIds for this api. Max. size of the\n array is 1000 \n example: 105-6594764\n macs:\n type: string\n description: >-\n Array of MAC address. You must specify either sns, macs,\n subscribers or referenceIds for this api. Max. size of the\n array is 1000 \n type:\n type: string\n description: 'Data type. Current only supports \"diagnostic_menu\" '\n example: diagnostic_menu\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UploadDataViaResolveResponse'\n example:\n batch_id: 7543\n '400':\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UploadDataViaResolveErrorResponse'\n example:\n error: Device[11-1111110] Not Found\n /engage/sapi/device/downloadDataViaEnsight:\n post:\n tags:\n - System Integration APIs\n summary: Download data via Resolve\n description: >-\n # **Description**\n\n\n Download data via Resolve channel. See **Upload data via Resolve** API\n for uploading data.\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key --data\n \"sns=26-9999999&sns=26-9999998&sns=26-9999997&type=diagnostic_menu\"\n https://engage.aminoengage.com:2443/engage/sapi/device/downloadDataViaEnsight\n\n\n ```\n servers:\n - url: https://engage.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n sns:\n type: string\n description: >-\n Array of Serial number. You must specify either sns, macs,\n subscribers or referenceIds for this api. Max. size of the\n array is 1000 \n example: 105-6594764\n macs:\n type: string\n description: >-\n Array of MAC address. You must specify either sns, macs,\n subscribers or referenceIds for this api. Max. size of the\n array is 1000 \n subscribers:\n type: string\n description: >-\n Array of subscriber. You must specify either sns, macs,\n subscribers or referenceIds for this api. Max. size of the\n array is 1000 \n referenceIds:\n type: string\n description: >-\n Array of reference ID. You must specify either sns, macs,\n subscribers or referenceIds for this api. Max. size of the\n array is 1000 \n type:\n type: string\n description: 'Data type. Current only supports \"diagnostic_menu\" '\n example: diagnostic_menu\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/DownloadDataViaResolveResponseElement'\n example:\n - id: 5689\n commandId: 313871\n oui: '0003E6'\n productClass: '105'\n esn: 105-6594764\n macAddress: 0003E6C94198\n type: diagnostic_menu\n contentType: text/plain; charset=utf-8\n data: >-\n {\"General\":\"{\\\"Android Version\\\":\\\"10\\\",\\\"Board\n Version\\\":\\\"B1-100\\\",\\\"Build Date\\\":\\\"Tue Sep 20 01:37:38\n UTC 2022\\\",\\\"Build\n Fingerprint\\\":\\\"Amino\\/Amigo7xcCN\\/Amigo7xcCN:10\\/QTT8.201201.002\\/24.3.x:userdebug\\/release-keys\\\",\\\"Build\n Version\\\":\\\"24.3.x\\\",\\\"CPU\n Temperature\\\":\\\"39.300003℃\\\",\\\"Model\n Name\\\":\\\"Amigo7xcCN\\\",\\\"Power Status\\\":\\\"Sleep\\\",\\\"Serial\n Number\\\":\\\"105-6594764\\\",\\\"System Uptime\\\":\\\"2h\n 29m\\\"}\",\"Interface\":\"{\\\"\\\":[\\\"Enabled\\\",\\\"Active\\\"],\\\"Ethernet\\\":[\\\"Yes\\\",\\\"Yes\\\"],\\\"HDMI\\\":[\\\"Yes\\\",\\\"No\\\"],\\\"USB\\\":[\\\"Yes\\\",\\\"No\\\"]}\",\"Network\":\"{\\\"Bridge\n Mode\\\":\\\"--\\\",\\\"Interface\\\":\\\"eth0\\\",\\\"IP Address\n v4\\\":\\\"10.0.35.251\\\",\\\"IP Address\n v6\\\":\\\"FE80::F2D6:115E:1EC5:CF65\\\",\\\"Mac\n Addr\\\":\\\"00:03:E6:C9:41:98\\\",\\\"Network\n Type\\\":\\\"eth\\\"}\",\"WiFi\":\"{\\\"Connection\n Quality\\\":\\\"--\\\",\\\"Signal\n Level\\\":\\\"--\\\",\\\"SSID\\\":\\\"--\\\",\\\"PHY\n Mode\\\":\\\"--\\\",\\\"Status\\\":\\\"DISABLED\\\"}\",\"Launcher\":\"{\\\"App\n Name\\\":\\\"Android TV 首頁\\\",\\\"Package\n ID\\\":\\\"com.google.android.tvlauncher\\\",\\\"Version\n Code\\\":1010910649,\\\"Version\n Name\\\":\\\"5.1.7-508304777-f\\\"}\",\"Zero Screen App\":\"{\\\"There\n is no configured zero screen app.\\\":\\\" \\\"}\",\"RCU\n Info\":\"{}\",\"Storage\n Info\":\"{\\\"\\\":[\\\"Total\\\",\\\"Used\\\"],\\\"內部共用儲存空間\\\":[\\\"4.36\n GB\\\",\\\"72.2%\\\"]}\",\"User Installed Apps\":\"{\\\"\\\":[\\\"Version\n Name\\\",\\\"Version Code\\\"],\\\"Apollo Sample App\n (com.aminocom.apollosdk.sample)\\\":[\\\"Amino-Apollo-2022\\\",20221207],\\\"Apollo\n Internal App\n (com.aminocom.apollo.demo)\\\":[\\\"apollosdk_2022Q1.2-dirty\\\",20221206],\\\"ES檔案瀏覽器\n (com.estrongs.android.pop)\\\":[\\\"4.1.9.7.4\\\",788],\\\"あ$:Aaλη啊\n (com.di.instrumentationtest)\\\":[\\\"1.0\\\",1]}\",\"Audio\":\"{\\\"Volume\\\":\\\"100%\\\",\\\"Muted\\\":\\\"false\\\"}\",\"Surround\n Sound\":\"{\\\"Surround Sound\n Mode\\\":\\\"Auto\\\",\\\"\\\":[\\\"Enabled\\\",\\\"HDMI Display\\\"],\\\"Dolby\n Atmos in Dolby Digital Plus\\\":[\\\"No\\\",\\\"Not\n Supported\\\"],\\\"AAC\\\":[\\\"No\\\",\\\"Not Supported\\\"],\\\"Dolby\n Digital\\\":[\\\"No\\\",\\\"Not Supported\\\"],\\\"Dolby Digital\n Plus\\\":[\\\"No\\\",\\\"Not Supported\\\"],\\\"DTS\\\":[\\\"No\\\",\\\"Not\n Supported\\\"]}\",\"Tuner Stat\":\"{\\\"No tuner or the tuner stat\n unavailable.\\\":\\\" \\\"}\"}\n dateCreated: '2023-03-28 07:21:30'\n '400':\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DownloadDataViaResolveErrorResponse'\n example:\n error: Device Not Found\n /engage/sapi/operator/auditLog/download:\n post:\n tags:\n - System Integration APIs\n summary: Download operator audit log\n description: >-\n # **Description**\n\n\n Download audit logs from an operator in CSV format.\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key --url\n https://engage.aminoengage.com:2443/engage/sapi/operator/auditLog/download\n -o auditLog.csv\n\n\n ```\n\n\n The content of audit logs will be saved into auditLog.csv.\n servers:\n - url: https://engage.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n operator:\n type: string\n description: >-\n Optional, the domain of the audit log. Set the certificated\n domain if not specified. \n example: Amino Automation Test\n responses:\n '200':\n description: OK\n content:\n text/plain:\n schema:\n type: string\n example: \"8851179,Device,Device [99-9999991] is deleted,api(Amino Communications),18 Feb 2023 08:34:49 UTC\\r\\n8851177,Device,Device [107-19999999] is deleted,api(Amino Communications),18 Feb 2023 08:34:47 UTC\\r\\n\"\n '400':\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DownloadOperatorAuditLogErrorResponse'\n example:\n error: Invalid Operator\n /engage/sapi/device/webengine/system:\n get:\n tags:\n - APIs to operate the device directly\n summary: Get system parameters\n description: >-\n # **Description**\n\n\n Get the system paraemters of a device.\n\n\n ## Request example \n\n\n ```\n\n curl -XGET --cert domain.crt --key domain.key --url\n 'https://engage.aminoengage.com:2443/engage/sapi/device/webengine/system?sn=26-9999999'\n\n\n ```\n parameters:\n - name: sn\n in: query\n schema:\n type: string\n description: >-\n Serial number, the api will look up the device records by serial\n number. \n example: 105-6594764\n servers:\n - url: https://engage.aminoengage.com:2443\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetSystemParametersResponse'\n example:\n uptime: 9340343\n id: 4341782\n oui: '0003E6'\n productClass: '105'\n sn: 105-6594764\n mac: 0003E6C94198\n deviceType: 7\n subscriber: ''\n referenceId: ''\n group: Derek_AndroidQ_Amigo7XV2_Dev\n operator: Amino Communications\n '404':\n description: Not Found\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetSystemParametersErrorResponse'\n example:\n errno: APIWC0001\n message: Device not found\n /engage/sapi/device/webengine/system/spacemgr:\n get:\n tags:\n - APIs to operate the device directly\n summary: Get space manager\n description: >-\n # **Description**\n\n\n Get the space manager of a device.\n\n\n ## Request example \n\n\n ```\n\n curl -XGET --cert domain.crt --key domain.key --url\n 'https://engage.aminoengage.com:2443/engage/engage/sapi/device/webengine/system/spacemgr?sn=26-9999999'\n\n\n ```\n parameters:\n - name: sn\n in: query\n schema:\n type: string\n description: >-\n Serial number, the api will look up the device records by serial\n number. \n example: 105-6594764\n servers:\n - url: https://engage.aminoengage.com:2443\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetSpaceManagerResponse'\n example:\n free: '1163419648'\n total: '4363599872'\n '404':\n description: Not Found\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetSpaceManagerErrorResponse'\n example:\n errno: APIWC0001\n message: Device not found\n /engage/sapi/device/webengine/system/hdmi:\n get:\n tags:\n - APIs to operate the device directly\n summary: Get HDMI output status\n description: >-\n # **Description**\n\n\n Get the HDMI output status of a device.\n\n\n ## Request example \n\n\n ```\n\n curl -XGET --cert domain.crt --key domain.key --url\n 'https://engage.aminoengage.com:2443/engage/engage/sapi/device/webengine/system/hdmi?sn=26-9999999'\n\n\n ```\n parameters:\n - name: sn\n in: query\n schema:\n type: string\n description: >-\n Serial number, the api will look up the device records by serial\n number. \n example: 105-6594764\n servers:\n - url: https://engage.aminoengage.com:2443\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetHDMIOutputStatusResponse'\n example:\n connected: true\n rx_powered: true\n hdmi_device: true\n monitor_name: SAMSUNG\n current_resolution: 1080i60\n hotplug_mode: default\n '404':\n description: Not Found\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetHDMIOutputStatusErrorResponse'\n example:\n errno: APIWC0001\n message: Device not found\n put:\n tags:\n - APIs to operate the device directly\n summary: Change HDMI output setting\n description: >-\n # Description\n\n\n Change a device's HDMI output setting.\n\n\n ## JSON property in request body:\n\n\n | **Property** | Description |\n\n | --- | --- |\n\n | id | The identifier returning from the register API, the api will look\n up the device records by ID. |\n\n | sn | Serial number, the api will look up the device records by serial\n number. |\n\n | mac | \\[Optional\\] MAC address, the api will look up the device\n records by MAC address. |\n\n | deviceType | \\[Optional\\]
1 for Enable
3 for Aminet
4\n for unsecure Enable
5 for PCCW with ENABLE
7 for Android \n
8 for Enable Enterprise
9 for Enable (R Series) |\n\n | oui | \\[Optional\\] this is an additional filter to search the device\n record. |\n\n | productClass | \\[Optional\\] the api looks up the device records by\n product class. |\n\n | subscriber | \\[Optional\\] the api looks up the device records by\n subscriber field. |\n\n | referenceId | \\[Optional\\] the api looks up the device records by\n referenceId field. |\n\n | timeout | \\[Optional\\] In milliseconds, how long to wait for the\n respond from device. Default is 10000 (10 seconds) |\n\n | params | \\[Compulsory\\] Object of hdmi. Only \"hotplug_mode\" can be\n modified, which value can be \"default\", \"mode1\", \"mode2\". |\n\n\n ## Request example\n\n\n ```\n\n curl -XPUT --cert domain.crt --key domain.key -H 'Content-Type:\n application/json' --data\n '{\"sn\":\"26-9999999\",\"params\":{\"hotplug_mode\":\"mode1\"}}' --url\n 'https://engage.aminoengage.com:2443/engage/sapi/device/webengine/system/hdmi'\n\n\n ```\n servers:\n - url: https://engage.aminoengage.com:2443\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ChangeHDMIOutputSettingRequest'\n example:\n sn: 105-6594764\n params:\n hotplug_mode: default\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ChangeHDMIOutputSettingResponse'\n example:\n connected: true\n rx_powered: true\n hdmi_device: true\n monitor_name: SAMSUNG\n current_resolution: 1080i60\n hotplug_mode: default\n '404':\n description: Not Found\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ChangeHDMIOutputSettingErrorResponse'\n example:\n errno: APIWC0001\n message: Device not found\n /engage/sapi/device/webengine/system/audio:\n get:\n tags:\n - APIs to operate the device directly\n summary: Get system audio settings\n description: >-\n # **Description**\n\n\n Get the system audio settings of a device.\n\n\n ## Request example \n\n\n ```\n\n curl -XGET --cert domain.crt --key domain.key --url\n 'https://engage.aminoengage.com:2443/engage/sapi/device/webengine/system/audio?sn=26-9999999' \n\n\n ```\n parameters:\n - name: sn\n in: query\n schema:\n type: string\n description: >-\n Serial number, the api will look up the device records by serial\n number. \n example: 105-6594764\n servers:\n - url: https://engage.aminoengage.com:2443\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetSystemAudioSettingsResponse'\n example:\n mute: false\n volume:\n left: 100\n right: 100\n '404':\n description: Not Found\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetSystemAudioSettingsErrorResponse'\n example:\n errno: APIWC0001\n message: Device not found\n put:\n tags:\n - APIs to operate the device directly\n summary: Set system audio settings\n description: >-\n # Description\n\n\n Change a device's HDMI output setting.\n\n\n ## JSON property in request body:\n\n\n | **Property** | Description |\n\n | --- | --- |\n\n | id | The identifier returning from the register API, the api will look\n up the device records by ID. |\n\n | sn | Serial number, the api will look up the device records by serial\n number. |\n\n | mac | \\[Optional\\] MAC address, the api will look up the device\n records by MAC address. |\n\n | deviceType | \\[Optional\\]
1 for Enable
3 for Aminet
4\n for unsecure Enable
5 for PCCW with ENABLE
7 for Android \n
8 for Enable Enterprise
9 for Enable (R Series) |\n\n | oui | \\[Optional\\] this is an additional filter to search the device\n record. |\n\n | productClass | \\[Optional\\] the api looks up the device records by\n product class. |\n\n | subscriber | \\[Optional\\] the api looks up the device records by\n subscriber field. |\n\n | referenceId | \\[Optional\\] the api looks up the device records by\n referenceId field. |\n\n | timeout | \\[Optional\\] In milliseconds, how long to wait for the\n respond from device. Default is 10000 (10 seconds) |\n\n | params | \\[Compulsory\\] Object of audio. \"mute\" and \"volume\" can be\n modified |\n\n\n ## Request example\n\n\n ```\n\n curl -XPUT --cert domain.crt --key domain.key -H 'Content-Type:\n application/json' --data '{\"sn\":\"26-9999999\",\"params\":{\"mute\":\"false\"}}'\n --url\n 'https://engage.aminoengage.com:2443/engage/sapi/device/webengine/system/audio' \n\n\n ```\n servers:\n - url: https://engage.aminoengage.com:2443\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/SetSystemAudioSettingsRequest'\n example:\n sn: 105-6594764\n params:\n mute: false\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/SetSystemAudioSettingsResponse'\n example:\n mute: false\n volume:\n left: 100\n right: 100\n '404':\n description: Not Found\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/SetSystemAudioSettingsErrorResponse'\n example:\n errno: APIWC0001\n message: Device not found\n /engage/sapi/device/reboot:\n post:\n tags:\n - APIs to operate the device directly\n summary: Reboot device\n description: >-\n # **Description**\n\n\n Reboot a device.\n\n\n ## Request example \n\n\n ```\n\n curl -XPOST --cert domain.crt --key domain.key --url\n 'https://engage.aminoengage.com:2443/engage/sapi/device/reboot?sn=26-9999999'\n\n\n ```\n servers:\n - url: https://engage.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n id:\n type: string\n description: >-\n The identifier returning from the register API, the api will\n look up the device records by ID. \n sn:\n type: string\n description: >-\n Serial number, the api will look up the device records by\n serial number. \n example: 105-6594764\n mac:\n type: string\n description: >-\n [Optional] MAC address, the api will look up the device\n records by MAC address. \n deviceType:\n type: string\n description: |-\n [Optional] \\\n 1 for Enable \\\n 3 for Aminet \\\n 4 for unsecure Enable \\\n 5 for PCCW with ENABLE \\\n 7 for Android \\\n 8 for Enable Enterprise \\\n 9 for Enable (R Series) \\\n oui:\n type: string\n description: >-\n [Optional] this is an additional filter to search the device\n record. \n productClass:\n type: string\n description: >-\n [Optional] the api looks up the device records by product\n class. \n subscriber:\n type: string\n description: >-\n [Optional] the api looks up the device records by subscriber\n field. \n referenceId:\n type: string\n description: >-\n [Optional] the api looks up the device records by\n referenceId field. \n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RebootDeviceResponse'\n example:\n msg: >-\n The device is READY and the command [restart] is set\n immediately.\n '404':\n description: Not Found\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RebootDeviceErrorResponse'\n example:\n errno: APIWC0001\n message: Device not found\n /ensure/sapi/device/register:\n post:\n tags:\n - Manage Integration APIs\n summary: Register device\n description: >-\n # **Description**\n\n\n Register a new device.\n\n\n If registration is successful, a device json will be returned.\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key --data\n \"sn=26-9999999&oui=0003E6&productClass=26&deviceType=1&group=Group01&operator=SampleDomain\"\n https://ensure.aminoengage.com:2443/ensure/sapi/device/register\n\n\n ```\n servers:\n - url: https://ensure.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n sn:\n type: string\n description: 'Serial number '\n example: 11-1111110\n mac:\n type: string\n description: >-\n MAC address. You must specify either the OUI or MAC for this\n api \n oui:\n type: string\n description: >-\n OUI identifies the manufacturer. You must specify either the\n OUI or MAC for this api\n example: '0003E6'\n deviceType:\n type: integer\n description: |-\n 1 for Enable \\\n 3 for Aminet \\\n 5 for PCCW with ENABLE \\\n 7 for Android \\\n 8 for Enable Enterprise \\\n 9 for Enable (R Series)\n example: '1'\n productClass:\n type: integer\n description: 'Product class '\n example: '11'\n subscriber:\n type: string\n description: 'Optional, set the subscriber field if specified '\n referenceId:\n type: string\n description: 'Optional, set the referenceId field if specified '\n group:\n type: string\n description: 'Optional, joining the registering device to a group. '\n operator:\n type: string\n description: >-\n Optional, the domain of the registering device. Set the\n certificated domain if not specified. \n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RegisterDeviceResponse'\n example:\n id: 8855917\n sn: 11-1111110\n oui: '0003E6'\n productClass: '11'\n mac: null\n deviceTypeId: 1\n subscriber: null\n referenceId: null\n others: null\n dateCreated: '2023-03-28 09:44:58'\n lastUpdated: '2023-03-28 09:44:58'\n group: null\n operator: Amino Communications\n '400':\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RegisterDeviceErrorResponse'\n example:\n error: device is already registered\n /ensure/sapi/device/delete:\n post:\n tags:\n - Manage Integration APIs\n summary: Delete device\n description: >-\n # **Description**\n\n\n Delete a device.\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key --data\n \"sn=26-9999999\" https://ensure.aminoengage.com:2443/ensure/sapi/device/delete\n\n\n ```\n servers:\n - url: https://ensure.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n id:\n type: string\n description: >-\n The identifier returning from the register API, the api will\n look up the device record by ID. You must specify either the\n id, sn, or mac for this api. \n sn:\n type: string\n description: >-\n Serial number, the api will look up the device record by\n serial number. You must specify either the id, sn, or mac\n for this api. \n example: 11-1111110\n deviceType:\n type: string\n description: |-\n 1 for Enable \\\n 3 for Aminet \\\n 5 for PCCW with ENABLE \\\n 7 for Android \\\n 8 for Enable Enterprise \\\n 9 for Enable (R Series) \\\n ***if not specified, default set to 1\n mac:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n oui:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n productClass:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n responses:\n '200':\n description: OK\n '400':\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DeleteDeviceErrorResponse'\n example:\n error: Device Not Found\n /ensure/sapi/device/reboot:\n post:\n tags:\n - Manage Integration APIs\n summary: Reboot device (Deprecated)\n description: >-\n # Description\n\n\n **This API is deprecated. Please use the \"Reboot device\" from System API\n instead.** \n\n Reboot the device via MANAGE channel. If the device is not kickable, the\n command will be valid for 1 day.\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key --data\n \"sn=26-9999999\" https://ensure.aminoengage.com:2443/ensure/sapi/device/reboot\n\n\n ```\n servers:\n - url: https://ensure.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n id:\n type: string\n description: >-\n The identifier returning from the register API, the api will\n look up the device record by ID. You must specify either the\n id, sn, or mac for this api. \n sn:\n type: string\n description: >-\n Serial number, the api will look up the device record by\n serial number. You must specify either the id, sn, or mac\n for this api. \n example: 105-6594764\n deviceType:\n type: integer\n description: |-\n 1 for Enable \\\n 3 for Aminet \\\n 5 for PCCW with ENABLE \\\n 7 for Android \\\n 8 for Enable Enterprise \\\n 9 for Enable (R Series) \\\n ***if not specified, default set to 1\n example: '7'\n mac:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n oui:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n productClass:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n responses:\n '200':\n description: OK\n '400':\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RebootDeviceDeprecatedErrorResponse'\n example:\n error: Device Not Found\n /ensure/sapi/device/update:\n post:\n tags:\n - Manage Integration APIs\n summary: Update device\n description: >-\n # **Description**\n\n\n Update the details of a device.\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key --data\n \"sn=26-9999999&referenceId=Z1234&subcriber=zzHome&group=Group02\" https://ensure.aminoengage.com:2443/ensure/sapi/device/update\n\n\n ```\n servers:\n - url: https://ensure.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n id:\n type: string\n description: >-\n The identifier returning from the register API, the api will\n look up the device record by ID. You must specify either the\n id, sn, or mac for this api. \n sn:\n type: string\n description: >-\n Serial number, the api will look up the device record by\n serial number. You must specify either the id, sn, or mac\n for this api. \n example: 11-1111110\n deviceType:\n type: string\n description: |-\n 1 for Enable \\\n 3 for Aminet \\\n 5 for PCCW with ENABLE \\\n 7 for Android \\\n 8 for Enable Enterprise \\\n 9 for Enable (R Series) \\\n ***if not specified, default set to 1\n mac:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n oui:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n productClass:\n type: string\n description: >-\n Optional, this an additional field to search the device\n record. \n subscriber:\n type: integer\n description: 'Optional, update the subscriber field if specified '\n example: '1112604'\n referenceId:\n type: string\n description: 'Optional, update the referenceId field if specified '\n group:\n type: string\n description: 'Optional, add the device to a group if specified '\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UpdateDeviceResponse'\n example:\n id: 8855917\n sn: 11-1111110\n oui: '0003E6'\n productClass: '11'\n mac: null\n deviceTypeId: 1\n subscriber: '1112604'\n referenceId: null\n others: null\n dateCreated: '2023-03-28 09:44:58'\n lastUpdated: '2023-03-28 09:45:13'\n group: null\n operator: Amino Communications\n '400':\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UpdateDeviceErrorResponse'\n example:\n error: Device Not Found\n /ensure/sapi/device/get:\n post:\n tags:\n - Manage Integration APIs\n summary: Get device\n description: >-\n # **Description**\n\n\n Get the details of device(s).\n\n\n The maximum number of devices can be return is 1000.\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key --data\n \"matchType=exact&sn=26-9999999\" https://ensure.aminoengage.com:2443/ensure/sapi/device/get\n\n\n ```\n servers:\n - url: https://ensure.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n id:\n type: string\n description: >-\n The identifier returning from the register API, the api will\n look up the device records by ID. \n sn:\n type: string\n description: >-\n Serial number, the api will look up the device records by\n serial number.\n example: 105-6594764\n deviceType:\n type: integer\n description: |-\n 1 for Enable \\\n 3 for Aminet \\\n 5 for PCCW with ENABLE \\\n 7 for Android \\\n 8 for Enable Enterprise \\\n 9 for Enable (R Series) \\\n ***if not specified, default set to 1\n example: '7'\n mac:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n oui:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n productClass:\n type: string\n description: >-\n Optional, the api will look up the device records by product\n class.\n subscriber:\n type: string\n description: >-\n Optional, the api will look up the device records by\n subscriber field. \n referenceId:\n type: string\n description: >-\n Optional, the api will look up the device records by\n referenceId field. \n matchType:\n type: string\n description: >-\n Optional, the match type of the lookup filter. By default,\n it is exact match if not specified. \\\n\n Allowed value: [ exact | partial ]\n example: exact\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/GetDeviceResponseElement'\n example:\n - id: 4341782\n sn: 105-6594764\n oui: '0003E6'\n productClass: '105'\n mac: 0003E6C94198\n deviceTypeId: 7\n subscriber: ''\n referenceId: ''\n others: ''\n dateCreated: '2021-03-11 04:55:16'\n lastUpdated: '2023-03-17 07:39:34'\n group: Derek_AndroidQ_Amigo7XV2_Dev\n operator: Amino Communications\n ip: 118.140.253.98\n lanIp: 10.0.35.251\n lastConnected: '2023-03-28 04:53:25'\n softwareVersion: 24.3.x\n bblVersion: ''\n /ensure/sapi/device/factoryReset:\n post:\n tags:\n - Manage Integration APIs\n summary: Factory reset device\n description: >-\n # **Description**\n\n\n Factory reset the device.\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key --data \"sn=26-9999999\"\n https://ensure.aminoengage.com:2443/ensure/sapi/device/factoryReset\n\n\n ```\n servers:\n - url: https://ensure.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n Id:\n type: string\n description: >-\n The identifier returning from the register API, the api will\n look up the device records by ID. \n sn:\n type: string\n description: >-\n Serial number, the api will look up the device records by\n serial number. \n example: 105-6594764\n deviceType:\n type: integer\n description: |-\n 1 for Enable \\\n 3 for Aminet \\\n 5 for PCCW with ENABLE \\\n 7 for Android \\\n 8 for Enable Enterprise \\\n 9 for Enable (R Series) \\\n ***if not specified, default set to 1\n example: '7'\n mac:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n oui:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n productClass:\n type: string\n description: >-\n Optional, this an additional field to search the device\n record. \n responses:\n '200':\n description: OK\n '400':\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/FactoryResetDeviceErrorResponse'\n example:\n error: Device Not Found\n /ensure/sapi/device/batchRegister:\n post:\n tags:\n - Manage Integration APIs\n summary: Batch register device\n description: >-\n # Description\n\n\n Register multiple devices with **deviceFile** in CSV format.\n\n\n ## Format of deviceFile\n\n\n **deviceFile** can be with or without CSV header.\n\n\n Content of **deviceFile** **without** CSV header should be in the\n following format: \n\n sn, oui, productClass\n\n\n Example:\n\n\n ```\n\n 26-0000001,0003E6,26 \n\n 26-0000002,003E6,26 \n\n 26-0000003,003E6,26 \n\n\n ```\n\n\n Content of **deviceFile** **with** CSV header should be in the following\n format:\n\n\n | CSV Column | Description |\n\n | --- | --- |\n\n | sn | Serial number |\n\n | mac | MAC address. You must specify either the OUI or MAC in the CSV |\n\n | oui | OUI identifies the manufacturer. You must specify either the OUI\n or MAC in the CSV |\n\n | productClass | Product class |\n\n | subscriber | Optional, set the subscriber field if specified |\n\n | referenceId | Optional, set the referenceId field if specified |\n\n\n Example:\n\n\n ```\n\n sn,oui,productClass \n\n 26-0000001,0003E6,26 \n\n 26-0000002,0030E6,26\n\n 26-0000003,0003E6,26\n\n\n ```\n\n\n ```\n\n sn,mac,productClass \n\n 26-0000001,0003E6000001,26 \n\n 26-0000002, 0003E6000002,26 \n\n 26-0000003, 0003E6000003,26\n\n\n ```\n\n\n ```\n\n sn,oui,productClass,subscriber,referenceId \n\n 26-0000001,0003E6,26,, \n\n 26-0000002,0003E6,26,, \n\n 26-0000003,0003E6,26,, \n\n\n ```\n\n\n ## Request example\n\n\n ```\n\n curl --cert domain.crt --key domain.key -F \"deviceFile=@devices.csv\" -F\n \"deviceType=1\" -F \"group=Group01\" -F \"operator=SampleDomain\"\n \"https://ensure.aminoengage.com:2443/ensure/sapi/device/batchRegister\"\n\n\n ```\n servers:\n - url: https://ensure.aminoengage.com:2443\n requestBody:\n content:\n multipart/form-data:\n schema:\n type: object\n properties:\n deviceFile:\n type: string\n description: >-\n The file in CSV format containing devices’ data for batch\n registration\n format: binary\n deviceType:\n type: integer\n description: |-\n 1 for Enable \\\n 3 for Aminet \\\n 5 for PCCW with ENABLE \\\n 7 for Android \\\n 8 for Enable Enterprise \\\n 9 for Enable (R Series)\n example: '1'\n group:\n type: string\n description: Optional, joining the registering device to a group\n operator:\n type: string\n description: >-\n Optional, the domain of the registering device. Set the\n certificated domain if not specified.\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n type: array\n items:\n type: integer\n example:\n - 8855922\n - 8855923\n '400':\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/BatchRegisterDeviceErrorResponse'\n example:\n error: Data validation failed\n /ensure/sapi/device/download:\n post:\n tags:\n - Manage Integration APIs\n summary: Download device report\n description: >-\n # **Description**\n\n\n Download a report of devices.\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key --data\n \"q[group.name]=Group01&fields=*\"  --url\n https://ensure.aminoengage.com:2443/ensure/sapi/device/download -o\n report.csv\n\n\n ```\n servers:\n - url: https://ensure.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n q[oui]:\n type: string\n description: Optional, search parameter for OUI\n q[productClass]:\n type: string\n description: Optional, search parameter for product class\n q[sn]:\n type: string\n description: Optional, search parameter for sn\n example: 105-6594764\n q[mac]:\n type: string\n description: Optional, search parameter for MAC address\n q[deviceTypeId]:\n type: string\n description: Optional, search parameter for device type ID\n q[referenceId]:\n type: string\n description: Optional, search parameter for reference ID\n q[subscriber]:\n type: string\n description: Optional, search parameter for subscriber\n q[ext.app]:\n type: string\n description: Optional, search parameter for current application version\n q[ext.bbl]:\n type: string\n description: Optional, search parameter for current bootloader version\n q[ext.connected_ge]:\n type: string\n description: >-\n Optional, search parameter for a timestamp after a\n particular connected time in milliseconds\n q[ext.connected_le]:\n type: string\n description: >-\n Optional, search parameter for a timestamp before a\n particular connected time in milliseconds\n q[ext.connected_isnull]:\n type: string\n description: Optional, search parameter for device has never connected\n q[ext.connected_isnotnull]:\n type: string\n description: Optional, search parameter for device has ever connected\n q[group.id]:\n type: string\n description: Optional, search parameter for group ID\n q[group.name]:\n type: string\n description: Optional, search parameter for group name\n q[group.id_isnull]:\n type: string\n description: Optional, search parameter for device without a group\n q[group.id_isnotnull]:\n type: string\n description: Optional, search parameter for device with a group\n q[dateCreated_ge]:\n type: string\n description: >-\n Optional, search parameter for a timestamp after a\n particular created time in milliseconds\n q[dateCreated_le]:\n type: string\n description: >-\n Optional, search parameter for a timestamp before a\n particular created time in milliseconds\n 'o[oui] ':\n type: string\n description: Optional, ordering parameter for OUI\n o[productClass]:\n type: string\n description: Optional, ordering parameter for product class\n o[sn]:\n type: string\n description: Optional, ordering parameter for serial number\n o[mac]:\n type: string\n description: Optional, ordering parameter for MAC address\n o[deviceTypeId]:\n type: string\n description: Optional, ordering parameter for device type ID\n o[referenceId]:\n type: string\n description: Optional, ordering parameter for reference ID\n o[ext.app]:\n type: string\n description: Optional, ordering parameter for current application version\n o[ext.bbl]:\n type: string\n description: Optional, ordering parameter for current bootloader version\n o[ext.connected]:\n type: string\n description: Optional, ordering parameter for last connected time\n o[dateCreated]:\n type: string\n description: Optional, ordering parameter for creation time\n fields:\n type: string\n description: >-\n Fields output to the csv file. \\\n\n Multiple fields value can be set, e.g.\n fields=mac&fields=group. \\\n\n By default, oui, product_class, serial_number are always\n included. \\\n\n If set to *, it will return all the available columns. \\\n\n Accepted values: \\\n\n mac: MAC address \\\n\n deviceTypeId: device type ID \\\n\n group: group name \\\n\n referenceId: reference ID \\\n\n subscriber: subscriber \\\n\n ext.app: current application version \\\n\n ext.bbl: current bootloader version \\\n\n ext.connected: last connected time \\\n\n dateCreated: creation time \\\n\n *: for all \n operator:\n type: string\n description: >-\n Optional, the domain of the registering device. Set the\n certificated domain if not specified. \n responses:\n '200':\n description: OK\n content:\n text/plain:\n schema:\n type: string\n example: \"oui,product_class,serial_number\\r\\n0003E6,105,105-6594764\\r\\n\"\n '400':\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DownloadDeviceReportErrorResponse'\n example:\n error: Group[ACBE] Not Found\n /ensure/sapi/device/lock:\n post:\n tags:\n - Manage Integration APIs\n summary: Lock device\n description: >-\n # **Description**\n\n\n Lock a device.\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key -H 'Content-Type:\n application/json' --data '{\"sn\":\"26-9999999\",\"lockMessage\":\"Your device\n is locked\"}' https://ensure.aminoengage.com:2443/ensure/sapi/device/lock\n\n\n ```\n servers:\n - url: https://ensure.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n id:\n type: string\n description: >-\n The identifier returning from the register API, the api will\n look up the device records by ID. \n sn:\n type: string\n description: >-\n Serial number, the api will look up the device records by\n serial number. \n example: 105-6594764\n deviceType:\n type: integer\n description: >-\n Optional, this is an additional filter to search the device\n record. \\\n\n 1 for Enable \\\n\n 3 for Aminet \\\n\n 5 for PCCW with ENABLE \\\n\n 7 for Android \\\n\n 8 for Enable Enterprise \\\n\n 9 for Enable (R Series) \\\n\n ***if not specified, default set to 1\n example: '7'\n mac:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n oui:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n productClass:\n type: string\n description: >-\n Optional, this an additional field to search the device\n record. \n lockMessage:\n type: string\n description: 'Optional, message to be displayed on the device '\n lockImage:\n type: string\n description: >-\n Optional, image path of the image to be displayed on the\n device \n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/LockDeviceResponse'\n example:\n currentLockStatus: true\n '400':\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/LockDeviceErrorResponse'\n example:\n error: Device Not Found\n /ensure/sapi/device/unlock:\n post:\n tags:\n - Manage Integration APIs\n summary: Unlock device\n description: >-\n # **Description**\n\n\n Unlock a device.\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key -H 'Content-Type:\n application/json' --data '{\"sn\":\"126-9999999\"}'\n https://ensure.aminoengage.com:2443/ensure/sapi/device/unlock\n\n\n ```\n servers:\n - url: https://ensure.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n id:\n type: string\n description: >-\n The identifier returning from the register API, the api will\n look up the device records by ID. \n sn:\n type: string\n description: >-\n Serial number, the api will look up the device records by\n serial number. \n example: 105-6594764\n deviceType:\n type: integer\n description: >-\n Optional, this is an additional filter to search the device\n record. \\\n\n 1 for Enable \\\n\n 3 for Aminet \\\n\n 5 for PCCW with ENABLE \\\n\n 7 for Android \\\n\n 8 for Enable Enterprise \\\n\n 9 for Enable (R Series) \\\n\n ***if not specified, default set to 1\n example: '7'\n mac:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n oui:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n productClass:\n type: string\n description: >-\n Optional, this an additional field to search the device\n record. \n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UnlockDeviceResponse'\n example:\n currentLockStatus: false\n '400':\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UnlockDeviceErrorResponse'\n example:\n error: Device Not Found\n /ensure/sapi/device/getLockStatus:\n post:\n tags:\n - Manage Integration APIs\n summary: Get device lock status\n description: >-\n # **Description**\n\n\n Get lock status of a device.\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key -H 'Content-Type:\n application/json' --data '{\"sn\":\"26-9999999\"}'\n https://ensure.aminoengage.com:2443/ensure/sapi/device/getLockStatus\n\n\n ```\n servers:\n - url: https://ensure.aminoengage.com:2443\n requestBody:\n content:\n application/x-www-form-urlencoded:\n schema:\n type: object\n properties:\n id:\n type: string\n description: >-\n The identifier returning from the register API, the api will\n look up the device records by ID. \n sn:\n type: string\n description: >-\n Serial number, the api will look up the device records by\n serial number. \n example: 105-6594764\n deviceType:\n type: integer\n description: >-\n Optional, this is an additional filter to search the device\n record. \\\n\n 1 for Enable \\\n\n 3 for Aminet \\\n\n 5 for PCCW with ENABLE \\\n\n 7 for Android \\\n\n 8 for Enable Enterprise \\\n\n 9 for Enable (R Series) \\\n\n ***if not specified, default set to 1\n example: '7'\n mac:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n oui:\n type: string\n description: >-\n Optional, this is an additional filter to search the device\n record. \n productClass:\n type: string\n description: >-\n Optional, this an additional field to search the device\n record. \n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetDeviceLockStatusResponse'\n example:\n currentLockStatus: false\n targetLockStatus: false\n '400':\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetDeviceLockStatusErrorResponse'\n example:\n error: Device Not Found\n /ensight/sapi/device/getDeviceOnlineStatus:\n get:\n tags:\n - Resolve Integration APIs\n summary: Get device online status in Resolve\n description: >-\n # **Description**\n\n\n Get the online status of device.\n\n\n # JSON property in request body:\n\n\n | **Property** | **Description** |\n\n | --- | --- |\n\n | devices | Array of target devices id object. Maximum 10 devices’\n status can be obtained for each call. |\n\n | devices.id | The identifier returning from the register API, the api\n will look up the device records by ID. |\n\n | devices.sn | Serial number, the api will look up the device records by\n serial number. |\n\n | devices.oui | \\[Optional\\] this is an additional filter to search the\n device record. |\n\n | devices.productClass | \\[Optional\\] the api looks up the device\n records by product class. |\n\n | devices.deviceType | \\[Optional\\]
1 for Enable
3 for Aminet \n
5 for PCCW with ENABLE
7 for Android
8 for Enable\n Enterprise
9 for Enable (R Series) |\n\n\n ## Request example \n\n\n ```\n\n curl --cert domain.crt --key domain.key --data\n '{\"devices\":[{\"sn\":\"105-6594764\"}]}' https://ensight.aminoengage.com:2443/ensight/sapi/device/getDeviceOnlineStatus\n\n\n ```\n servers:\n - url: https://ensight.aminoengage.com:2443\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: >-\n #/components/schemas/GetDeviceOnlineStatusInResolveResponseElement\n example:\n - esn: 107-10588275\n status: Device is ON-LINE.\n '404':\n description: Not Found\n content:\n application/json:\n schema:\n $ref: >-\n #/components/schemas/GetDeviceOnlineStatusInResolveErrorResponse\n example:\n errno: APIWC0004\n message: Device not found\ncomponents:\n schemas:\n RegisterDeviceResponse:\n title: RegisterDeviceResponse\n properties:\n id:\n type: integer\n example: 8855917\n sn:\n type: string\n example: 11-1111110\n oui:\n type: string\n example: '0003E6'\n productClass:\n type: string\n example: '11'\n mac:\n example: null\n deviceTypeId:\n type: integer\n example: 1\n subscriber:\n example: null\n referenceId:\n example: null\n others:\n example: null\n dateCreated:\n type: string\n example: '2023-03-28 09:44:58'\n lastUpdated:\n type: string\n example: '2023-03-28 09:44:58'\n group:\n example: null\n operator:\n type: string\n example: Amino Communications\n type: object\n additionalProperties: false\n RegisterDeviceErrorResponse:\n title: RegisterDeviceErrorResponse\n properties:\n error:\n type: string\n example: device is already registered\n type: object\n additionalProperties: false\n DeleteDeviceErrorResponse:\n title: DeleteDeviceErrorResponse\n properties:\n error:\n type: string\n example: Device Not Found\n type: object\n additionalProperties: false\n GetDeviceResponseElement:\n title: GetDeviceResponseElement\n properties:\n id:\n type: integer\n example: 4341782\n sn:\n type: string\n example: 105-6594764\n oui:\n type: string\n example: '0003E6'\n productClass:\n type: string\n example: '105'\n mac:\n type: string\n example: 0003E6C94198\n deviceTypeId:\n type: integer\n example: 7\n subscriber:\n type: string\n example: ''\n referenceId:\n type: string\n example: ''\n others:\n type: string\n example: ''\n dateCreated:\n type: string\n example: '2021-03-11 04:55:16'\n lastUpdated:\n type: string\n example: '2023-03-17 07:39:34'\n group:\n type: string\n example: Derek_AndroidQ_Amigo7XV2_Dev\n operator:\n type: string\n example: Amino Communications\n ip:\n type: string\n example: 118.140.253.98\n lanIp:\n type: string\n example: 10.0.35.251\n lastConnected:\n type: string\n example: '2023-03-28 04:53:25'\n softwareVersion:\n type: string\n example: 24.3.x\n bblVersion:\n type: string\n example: ''\n type: object\n additionalProperties: false\n UpdateDeviceResponse:\n title: UpdateDeviceResponse\n properties:\n id:\n type: integer\n example: 8855917\n sn:\n type: string\n example: 11-1111110\n oui:\n type: string\n example: '0003E6'\n productClass:\n type: string\n example: '11'\n mac:\n example: null\n deviceTypeId:\n type: integer\n example: 1\n subscriber:\n type: string\n example: '1112604'\n referenceId:\n example: null\n others:\n example: null\n dateCreated:\n type: string\n example: '2023-03-28 09:44:58'\n lastUpdated:\n type: string\n example: '2023-03-28 09:45:13'\n group:\n example: null\n operator:\n type: string\n example: Amino Communications\n type: object\n additionalProperties: false\n UpdateDeviceErrorResponse:\n title: UpdateDeviceErrorResponse\n properties:\n error:\n type: string\n example: Device Not Found\n type: object\n additionalProperties: false\n RebootDevicesViaResolveResponse:\n title: RebootDevicesViaResolveResponse\n properties:\n batch_id:\n type: integer\n example: 7542\n type: object\n additionalProperties: false\n RebootDevicesViaResolveErrorResponse:\n title: RebootDevicesViaResolveErrorResponse\n properties:\n error:\n type: string\n example: Device[11-1111110] Not Found\n type: object\n additionalProperties: false\n CheckResolveSBatchCommandStatusResponseElement:\n title: CheckResolveSBatchCommandStatusResponseElement\n properties:\n esn:\n type: string\n example: 11-1111110\n status:\n type: string\n example: queued\n type: object\n additionalProperties: false\n CheckResolveSBatchCommandStatusErrorResponse:\n title: CheckResolveSBatchCommandStatusErrorResponse\n properties:\n msg:\n type: string\n example: No matching batch command.\n type: object\n additionalProperties: false\n UploadDataViaResolveResponse:\n title: UploadDataViaResolveResponse\n properties:\n batch_id:\n type: integer\n example: 7543\n type: object\n additionalProperties: false\n UploadDataViaResolveErrorResponse:\n title: UploadDataViaResolveErrorResponse\n properties:\n error:\n type: string\n example: Device[11-1111110] Not Found\n type: object\n additionalProperties: false\n DownloadDataViaResolveResponseElement:\n title: DownloadDataViaResolveResponseElement\n properties:\n id:\n type: integer\n example: 5689\n commandId:\n type: integer\n example: 313871\n oui:\n type: string\n example: '0003E6'\n productClass:\n type: string\n example: '105'\n esn:\n type: string\n example: 105-6594764\n macAddress:\n type: string\n example: 0003E6C94198\n type:\n type: string\n example: diagnostic_menu\n contentType:\n type: string\n example: text/plain; charset=utf-8\n data:\n type: string\n example: >-\n {\"General\":\"{\\\"Android Version\\\":\\\"10\\\",\\\"Board\n Version\\\":\\\"B1-100\\\",\\\"Build Date\\\":\\\"Tue Sep 20 01:37:38 UTC\n 2022\\\",\\\"Build\n Fingerprint\\\":\\\"Amino\\/Amigo7xcCN\\/Amigo7xcCN:10\\/QTT8.201201.002\\/24.3.x:userdebug\\/release-keys\\\",\\\"Build\n Version\\\":\\\"24.3.x\\\",\\\"CPU Temperature\\\":\\\"39.300003℃\\\",\\\"Model\n Name\\\":\\\"Amigo7xcCN\\\",\\\"Power Status\\\":\\\"Sleep\\\",\\\"Serial\n Number\\\":\\\"105-6594764\\\",\\\"System Uptime\\\":\\\"2h\n 29m\\\"}\",\"Interface\":\"{\\\"\\\":[\\\"Enabled\\\",\\\"Active\\\"],\\\"Ethernet\\\":[\\\"Yes\\\",\\\"Yes\\\"],\\\"HDMI\\\":[\\\"Yes\\\",\\\"No\\\"],\\\"USB\\\":[\\\"Yes\\\",\\\"No\\\"]}\",\"Network\":\"{\\\"Bridge\n Mode\\\":\\\"--\\\",\\\"Interface\\\":\\\"eth0\\\",\\\"IP Address\n v4\\\":\\\"10.0.35.251\\\",\\\"IP Address\n v6\\\":\\\"FE80::F2D6:115E:1EC5:CF65\\\",\\\"Mac\n Addr\\\":\\\"00:03:E6:C9:41:98\\\",\\\"Network\n Type\\\":\\\"eth\\\"}\",\"WiFi\":\"{\\\"Connection Quality\\\":\\\"--\\\",\\\"Signal\n Level\\\":\\\"--\\\",\\\"SSID\\\":\\\"--\\\",\\\"PHY\n Mode\\\":\\\"--\\\",\\\"Status\\\":\\\"DISABLED\\\"}\",\"Launcher\":\"{\\\"App\n Name\\\":\\\"Android TV 首頁\\\",\\\"Package\n ID\\\":\\\"com.google.android.tvlauncher\\\",\\\"Version\n Code\\\":1010910649,\\\"Version Name\\\":\\\"5.1.7-508304777-f\\\"}\",\"Zero\n Screen App\":\"{\\\"There is no configured zero screen app.\\\":\\\"\n \\\"}\",\"RCU Info\":\"{}\",\"Storage\n Info\":\"{\\\"\\\":[\\\"Total\\\",\\\"Used\\\"],\\\"內部共用儲存空間\\\":[\\\"4.36\n GB\\\",\\\"72.2%\\\"]}\",\"User Installed Apps\":\"{\\\"\\\":[\\\"Version\n Name\\\",\\\"Version Code\\\"],\\\"Apollo Sample App\n (com.aminocom.apollosdk.sample)\\\":[\\\"Amino-Apollo-2022\\\",20221207],\\\"Apollo\n Internal App\n (com.aminocom.apollo.demo)\\\":[\\\"apollosdk_2022Q1.2-dirty\\\",20221206],\\\"ES檔案瀏覽器\n (com.estrongs.android.pop)\\\":[\\\"4.1.9.7.4\\\",788],\\\"あ$:Aaλη啊\n (com.di.instrumentationtest)\\\":[\\\"1.0\\\",1]}\",\"Audio\":\"{\\\"Volume\\\":\\\"100%\\\",\\\"Muted\\\":\\\"false\\\"}\",\"Surround\n Sound\":\"{\\\"Surround Sound Mode\\\":\\\"Auto\\\",\\\"\\\":[\\\"Enabled\\\",\\\"HDMI\n Display\\\"],\\\"Dolby Atmos in Dolby Digital Plus\\\":[\\\"No\\\",\\\"Not\n Supported\\\"],\\\"AAC\\\":[\\\"No\\\",\\\"Not Supported\\\"],\\\"Dolby\n Digital\\\":[\\\"No\\\",\\\"Not Supported\\\"],\\\"Dolby Digital\n Plus\\\":[\\\"No\\\",\\\"Not Supported\\\"],\\\"DTS\\\":[\\\"No\\\",\\\"Not\n Supported\\\"]}\",\"Tuner Stat\":\"{\\\"No tuner or the tuner stat\n unavailable.\\\":\\\" \\\"}\"}\n dateCreated:\n type: string\n example: '2023-03-28 07:21:30'\n type: object\n additionalProperties: false\n DownloadDataViaResolveErrorResponse:\n title: DownloadDataViaResolveErrorResponse\n properties:\n error:\n type: string\n example: Device Not Found\n type: object\n additionalProperties: false\n DownloadOperatorAuditLogErrorResponse:\n title: DownloadOperatorAuditLogErrorResponse\n properties:\n error:\n type: string\n example: Invalid Operator\n type: object\n additionalProperties: false\n GetSystemParametersResponse:\n title: GetSystemParametersResponse\n properties:\n uptime:\n type: integer\n example: 9340343\n id:\n type: integer\n example: 4341782\n oui:\n type: string\n example: '0003E6'\n productClass:\n type: string\n example: '105'\n sn:\n type: string\n example: 105-6594764\n mac:\n type: string\n example: 0003E6C94198\n deviceType:\n type: integer\n example: 7\n subscriber:\n type: string\n example: ''\n referenceId:\n type: string\n example: ''\n group:\n type: string\n example: Derek_AndroidQ_Amigo7XV2_Dev\n operator:\n type: string\n example: Amino Communications\n type: object\n additionalProperties: false\n GetSystemParametersErrorResponse:\n title: GetSystemParametersErrorResponse\n properties:\n errno:\n type: string\n example: APIWC0001\n message:\n type: string\n example: Device not found\n type: object\n additionalProperties: false\n GetSpaceManagerResponse:\n title: GetSpaceManagerResponse\n properties:\n free:\n type: string\n example: '1163419648'\n total:\n type: string\n example: '4363599872'\n type: object\n additionalProperties: false\n GetSpaceManagerErrorResponse:\n title: GetSpaceManagerErrorResponse\n properties:\n errno:\n type: string\n example: APIWC0001\n message:\n type: string\n example: Device not found\n type: object\n additionalProperties: false\n GetHDMIOutputStatusResponse:\n title: GetHDMIOutputStatusResponse\n properties:\n connected:\n type: boolean\n example: true\n rx_powered:\n type: boolean\n example: true\n hdmi_device:\n type: boolean\n example: true\n monitor_name:\n type: string\n example: SAMSUNG\n current_resolution:\n type: string\n example: 1080i60\n hotplug_mode:\n type: string\n example: default\n type: object\n additionalProperties: false\n GetHDMIOutputStatusErrorResponse:\n title: GetHDMIOutputStatusErrorResponse\n properties:\n errno:\n type: string\n example: APIWC0001\n message:\n type: string\n example: Device not found\n type: object\n additionalProperties: false\n ChangeHDMIOutputSettingRequest:\n title: ChangeHDMIOutputSettingRequest\n properties:\n sn:\n type: string\n example: 105-6594764\n params:\n $ref: '#/components/schemas/ChangeHDMIOutputSettingRequestParams'\n type: object\n additionalProperties: false\n ChangeHDMIOutputSettingRequestParams:\n title: ChangeHDMIOutputSettingRequestParams\n properties:\n hotplug_mode:\n type: string\n type: object\n additionalProperties: false\n ChangeHDMIOutputSettingResponse:\n title: ChangeHDMIOutputSettingResponse\n properties:\n connected:\n type: boolean\n example: true\n rx_powered:\n type: boolean\n example: true\n hdmi_device:\n type: boolean\n example: true\n monitor_name:\n type: string\n example: SAMSUNG\n current_resolution:\n type: string\n example: 1080i60\n hotplug_mode:\n type: string\n example: default\n type: object\n additionalProperties: false\n ChangeHDMIOutputSettingErrorResponse:\n title: ChangeHDMIOutputSettingErrorResponse\n properties:\n errno:\n type: string\n example: APIWC0001\n message:\n type: string\n example: Device not found\n type: object\n additionalProperties: false\n GetSystemAudioSettingsResponse:\n title: GetSystemAudioSettingsResponse\n properties:\n mute:\n type: boolean\n example: false\n volume:\n $ref: '#/components/schemas/GetSystemAudioSettingsResponseVolume'\n type: object\n additionalProperties: false\n GetSystemAudioSettingsResponseVolume:\n title: GetSystemAudioSettingsResponseVolume\n properties:\n left:\n type: integer\n right:\n type: integer\n type: object\n additionalProperties: false\n GetSystemAudioSettingsErrorResponse:\n title: GetSystemAudioSettingsErrorResponse\n properties:\n errno:\n type: string\n example: APIWC0001\n message:\n type: string\n example: Device not found\n type: object\n additionalProperties: false\n SetSystemAudioSettingsRequest:\n title: SetSystemAudioSettingsRequest\n properties:\n sn:\n type: string\n example: 105-6594764\n params:\n $ref: '#/components/schemas/SetSystemAudioSettingsRequestParams'\n type: object\n additionalProperties: false\n SetSystemAudioSettingsRequestParams:\n title: SetSystemAudioSettingsRequestParams\n properties:\n mute:\n type: boolean\n type: object\n additionalProperties: false\n SetSystemAudioSettingsResponse:\n title: SetSystemAudioSettingsResponse\n properties:\n mute:\n type: boolean\n example: false\n volume:\n $ref: '#/components/schemas/SetSystemAudioSettingsResponseVolume'\n type: object\n additionalProperties: false\n SetSystemAudioSettingsResponseVolume:\n title: SetSystemAudioSettingsResponseVolume\n properties:\n left:\n type: integer\n right:\n type: integer\n type: object\n additionalProperties: false\n SetSystemAudioSettingsErrorResponse:\n title: SetSystemAudioSettingsErrorResponse\n properties:\n errno:\n type: string\n example: APIWC0001\n message:\n type: string\n example: Device not found\n type: object\n additionalProperties: false\n RebootDeviceResponse:\n title: RebootDeviceResponse\n properties:\n msg:\n type: string\n example: The device is READY and the command [restart] is set immediately.\n type: object\n additionalProperties: false\n RebootDeviceErrorResponse:\n title: RebootDeviceErrorResponse\n properties:\n errno:\n type: string\n example: APIWC0001\n message:\n type: string\n example: Device not found\n type: object\n additionalProperties: false\n RebootDeviceDeprecatedErrorResponse:\n title: RebootDeviceDeprecatedErrorResponse\n properties:\n error:\n type: string\n example: Device Not Found\n type: object\n additionalProperties: false\n FactoryResetDeviceErrorResponse:\n title: FactoryResetDeviceErrorResponse\n properties:\n error:\n type: string\n example: Device Not Found\n type: object\n additionalProperties: false\n BatchRegisterDeviceErrorResponse:\n title: BatchRegisterDeviceErrorResponse\n properties:\n error:\n type: string\n example: Data validation failed\n type: object\n additionalProperties: false\n DownloadDeviceReportErrorResponse:\n title: DownloadDeviceReportErrorResponse\n properties:\n error:\n type: string\n example: Group[ACBE] Not Found\n type: object\n additionalProperties: false\n LockDeviceResponse:\n title: LockDeviceResponse\n properties:\n currentLockStatus:\n type: boolean\n example: true\n type: object\n additionalProperties: false\n LockDeviceErrorResponse:\n title: LockDeviceErrorResponse\n properties:\n error:\n type: string\n example: Device Not Found\n type: object\n additionalProperties: false\n UnlockDeviceResponse:\n title: UnlockDeviceResponse\n properties:\n currentLockStatus:\n type: boolean\n example: false\n type: object\n additionalProperties: false\n UnlockDeviceErrorResponse:\n title: UnlockDeviceErrorResponse\n properties:\n error:\n type: string\n example: Device Not Found\n type: object\n additionalProperties: false\n GetDeviceLockStatusResponse:\n title: GetDeviceLockStatusResponse\n properties:\n currentLockStatus:\n type: boolean\n example: false\n targetLockStatus:\n type: boolean\n example: false\n type: object\n additionalProperties: false\n GetDeviceLockStatusErrorResponse:\n title: GetDeviceLockStatusErrorResponse\n properties:\n error:\n type: string\n example: Device Not Found\n type: object\n additionalProperties: false\n GetDeviceOnlineStatusInResolveResponseElement:\n title: GetDeviceOnlineStatusInResolveResponseElement\n properties:\n esn:\n type: string\n example: 107-10588275\n status:\n type: string\n example: Device is ON-LINE.\n type: object\n additionalProperties: false\n GetDeviceOnlineStatusInResolveErrorResponse:\n title: GetDeviceOnlineStatusInResolveErrorResponse\n properties:\n errno:\n type: string\n example: APIWC0004\n message:\n type: string\n example: Device not found\n type: object\n additionalProperties: false"}},"macroMetadata":{"macroId":{"value":"6145608a-9398-496f-a44e-7d91e1a52d45"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://confluence-open-api.herokuapp.com/images/open-api-icon.png"}}],"title":"Open API (Swagger) Documentation"}},"localId":"faf6fdec-9e17-4ce0-b520-04f2b36f30c8"}}],"version":1}