diff --git a/open-api.md b/open-api.md index a76073227..c397702b2 100644 --- a/open-api.md +++ b/open-api.md @@ -104,8 +104,10 @@ None "isConnected": true, "isEnabled": true, "statusUpdatedTime": "2019-08-24T14:15:22Z", - "locationCode": "string", - "assetId": "string" + "customTags": { + "property1": "string", + "property2": "string" + } } ``` @@ -147,8 +149,10 @@ None "isConnected": true, "isEnabled": true, "statusUpdatedTime": "2019-08-24T14:15:22Z", - "locationCode": "string", - "assetId": "string" + "customTags": { + "property1": "string", + "property2": "string" + } } ``` @@ -190,7 +194,7 @@ None > 200 Response ``` -{"deviceID":"string","deviceName":"string","modelId":"string","imageUrl":"string","isConnected":true,"isEnabled":true,"statusUpdatedTime":"2019-08-24T14:15:22Z","locationCode":"string","assetId":"string"} +{"deviceID":"string","deviceName":"string","modelId":"string","imageUrl":"string","isConnected":true,"isEnabled":true,"statusUpdatedTime":"2019-08-24T14:15:22Z","customTags":{"property1":"string","property2":"string"}} ``` ```json @@ -202,8 +206,10 @@ None "isConnected": true, "isEnabled": true, "statusUpdatedTime": "2019-08-24T14:15:22Z", - "locationCode": "string", - "assetId": "string" + "customTags": { + "property1": "string", + "property2": "string" + } } ``` @@ -1371,8 +1377,10 @@ None "isConnected": true, "isEnabled": true, "statusUpdatedTime": "2019-08-24T14:15:22Z", - "locationCode": "string", - "assetId": "string", + "customTags": { + "property1": "string", + "property2": "string" + }, "appEUI": "string", "appKey": "string", "sensorDecoder": "string", @@ -1418,8 +1426,10 @@ None "isConnected": true, "isEnabled": true, "statusUpdatedTime": "2019-08-24T14:15:22Z", - "locationCode": "string", - "assetId": "string", + "customTags": { + "property1": "string", + "property2": "string" + }, "appEUI": "string", "appKey": "string", "sensorDecoder": "string", @@ -1465,7 +1475,7 @@ None > 200 Response ``` -{"deviceID":"string","deviceName":"string","modelId":"string","imageUrl":"string","isConnected":true,"isEnabled":true,"statusUpdatedTime":"2019-08-24T14:15:22Z","locationCode":"string","assetId":"string","appEUI":"string","appKey":"string","sensorDecoder":"string","alreadyLoggedInOnce":true} +{"deviceID":"string","deviceName":"string","modelId":"string","imageUrl":"string","isConnected":true,"isEnabled":true,"statusUpdatedTime":"2019-08-24T14:15:22Z","customTags":{"property1":"string","property2":"string"},"appEUI":"string","appKey":"string","sensorDecoder":"string","alreadyLoggedInOnce":true} ``` ```json @@ -1477,8 +1487,10 @@ None "isConnected": true, "isEnabled": true, "statusUpdatedTime": "2019-08-24T14:15:22Z", - "locationCode": "string", - "assetId": "string", + "customTags": { + "property1": "string", + "property2": "string" + }, "appEUI": "string", "appKey": "string", "sensorDecoder": "string", @@ -2509,9 +2521,9 @@ None

Portal Settings

-## POST a set of device tag settings +## POST Update the Device tags settings - + > Code samples @@ -2532,13 +2544,13 @@ None ] ``` -

Parameters

+

Parameters

|Name|In|Type|Required|Description| |---|---|---|---|---| |body|body|[DeviceTag](#schemadevicetag)|false|List of tags.| -

Responses

+

Responses

|Status|Meaning|Description|Schema| |---|---|---|---| @@ -2549,9 +2561,9 @@ To perform this operation, you must be authenticated by means of one of the foll None -## GET a set of device settings +## GET Device tags settings - + > Code samples @@ -2574,13 +2586,13 @@ None ] ``` -

Responses

+

Responses

|Status|Meaning|Description|Schema| |---|---|---|---| |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline| -

Response Schema

+

Response Schema

Status Code **200** @@ -2863,8 +2875,10 @@ None "isConnected": true, "isEnabled": true, "statusUpdatedTime": "2019-08-24T14:15:22Z", - "locationCode": "string", - "assetId": "string" + "customTags": { + "property1": "string", + "property2": "string" + } } ``` @@ -2880,8 +2894,8 @@ None |isConnected|boolean|false|none|{true} if this instance is connected; otherwise, {false}.| |isEnabled|boolean|false|none|{true} if this instance is enabled; otherwise, {false}.| |statusUpdatedTime|string(date-time)|false|none|The status updated time.| -|locationCode|string¦null|false|none|The location code.| -|assetId|string¦null|false|none|The asset identifier.| +|customTags|object¦null|false|none|List of custom device tags and their values.| +|» **additionalProperties**|string|false|none|none|

DeviceListItem

@@ -3159,8 +3173,10 @@ None "isConnected": true, "isEnabled": true, "statusUpdatedTime": "2019-08-24T14:15:22Z", - "locationCode": "string", - "assetId": "string", + "customTags": { + "property1": "string", + "property2": "string" + }, "appEUI": "string", "appKey": "string", "sensorDecoder": "string", @@ -3180,8 +3196,8 @@ None |isConnected|boolean|false|none|{true} if this instance is connected; otherwise, {false}.| |isEnabled|boolean|false|none|{true} if this instance is enabled; otherwise, {false}.| |statusUpdatedTime|string(date-time)|false|none|The status updated time.| -|locationCode|string¦null|false|none|The location code.| -|assetId|string¦null|false|none|The asset identifier.| +|customTags|object¦null|false|none|List of custom device tags and their values.| +|» **additionalProperties**|string|false|none|none| |appEUI|string|true|none|The OTAA App EUI.| |appKey|string|true|none|The OTAA App Key.| |sensorDecoder|string¦null|false|none|The sensor decoder API Url.| diff --git a/swagger.json b/swagger.json index 51ef323f0..36a03c2ca 100644 --- a/swagger.json +++ b/swagger.json @@ -2138,7 +2138,7 @@ "Portal Settings" ], "summary": "Updates the device tag settings to be used in the application.", - "operationId": "POST a set of device tag settings", + "operationId": "POST Update the Device tags settings", "requestBody": { "description": "List of tags.", "content": { @@ -2179,7 +2179,7 @@ "Portal Settings" ], "summary": "Gets the device tag settings to be used in the application", - "operationId": "GET a set of device settings", + "operationId": "GET Device tags settings", "responses": { "200": { "description": "Success", @@ -2450,14 +2450,12 @@ "description": "The status updated time.", "format": "date-time" }, - "locationCode": { - "type": "string", - "description": "The location code.", - "nullable": true - }, - "assetId": { - "type": "string", - "description": "The asset identifier.", + "customTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "List of custom device tags and their values.", "nullable": true } }, @@ -2787,14 +2785,12 @@ "description": "The status updated time.", "format": "date-time" }, - "locationCode": { - "type": "string", - "description": "The location code.", - "nullable": true - }, - "assetId": { - "type": "string", - "description": "The asset identifier.", + "customTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "List of custom device tags and their values.", "nullable": true }, "appEUI": {