Devices API Doc

Devices

@CreateDevice

POST https://devices-api.xiot.cloud/v1/devices

This endpoint allows you to create a new device.

Headers

Name	Type	Description
authorization	string	Bearer Token

Request Body

Name	Type	Description
name	string	Device Name

200 Device successfully created.

{
	"name": "Device name"
}

400 Validation error

@GetAllDevices

GET https://devices-api.xiot.cloud/v1/devices

Get all devices listed under a specific user

Headers

Name	Type	Description
authorization	string	Bearer Token

200

[
  {
    "id": "77620319-8401-41de-b833-aa368947091e",
    "name": "xyz",
    "mqttId": "_uTqSYbJ",
    "mqttPassword": "fawiyasowi",
    "createdBy": "1a594c25-9bdc-4aec-95bb-66e69c929c70",
    "createdAt": "2020-02-05T18:30:02.079Z",
    "updatedAt": "2020-02-05T18:30:02.079Z"
  },
  {
    "id": "9c05d519-2d26-4f78-a078-acb475636d6e",
    "name": "Device name",
    "mqttId": "lK67clr4",
    "mqttPassword": "jehasareqo",
    "createdBy": "1a594c25-9bdc-4aec-95bb-66e69c929c70",
    "createdAt": "2020-02-05T18:58:16.811Z",
    "updatedAt": "2020-02-05T18:58:16.811Z"
  }
]

Assets

@CreateAsset

POST https://devices-api.xiot.cloud/v1/assets

Headers

Name	Type	Description
authorization	string	Bearer token

Request Body

Name	Type	Description
icon	string	image url/or comes from the server later
deviceId	string	UUID4 FORMAT - d6ffe69b-77bb-4be2-9a44-c7c296a7ea69
status	string
topic	string
name	string	Asset name - Unique under a device scope.

200

{
  "id": "d6ffe69b-77bb-4be2-9a44-c7c296a7ea69",
  "name": "asset",
  "createdBy": "1a594c25-9bdc-4aec-95bb-66e69c929c70",
  "status": "off",
  "updatedAt": "2020-02-05T18:23:17.880Z",
  "createdAt": "2020-02-05T18:23:17.880Z",
  "icon": null,
  "topic": null,
  "deviceId": null
}

@UpdateAsset

PUT https://devices-api.xiot.cloud/v1/assets/<assetId>

Path Parameters

Name	Type	Description
assetId	string	asset id

Request Body

Name	Type	Description
icon	string
deviceId	string	UUID4 FORMAT - d6ffe69b-77bb-4be2-9a44-c7c296a7ea69
status	string
topic	string
name	string	Asset name - Unique under a device scope.

200

{
  "id": "d6ffe69b-77bb-4be2-9a44-c7c296a7ea69",
  "name": "asset",
  "createdBy": "1a594c25-9bdc-4aec-95bb-66e69c929c70",
  "status": "off",
  "updatedAt": "2020-02-05T18:23:17.880Z",
  "createdAt": "2020-02-05T18:23:17.880Z",
  "icon": null,
  "topic": null,
  "deviceId": null
}

400

@GetAllAssets

GET https://devices-api.xiot.cloud/v1/assets

Get all assets listed under a specific

Headers

Name	Type	Description
authorization	string	Bearer Token

200

[
  {
    "id": "d6ffe69b-77bb-4be2-9a44-c7c296a7ea69",
    "name": "asset",
    "icon": null,
    "createdBy": "1a594c25-9bdc-4aec-95bb-66e69c929c70",
    "topic": null,
    "status": "off",
    "deviceId": "77620319-8401-41de-b833-aa368947091e",
    "createdAt": "2020-02-05T18:23:17.880Z",
    "updatedAt": "2020-02-05T18:43:19.047Z"
  },
  {
    "id": "8f4eca1b-c513-41c1-8d35-e8e7719ec42c",
    "name": "asset",
    "icon": null,
    "createdBy": "1a594c25-9bdc-4aec-95bb-66e69c929c70",
    "topic": null,
    "status": "off",
    "deviceId": null,
    "createdAt": "2020-02-05T19:06:42.253Z",
    "updatedAt": "2020-02-05T19:06:42.253Z"
  }
]

Places

@CreatePlace

POST https://devices-api.xiot.cloud/v1/places

Headers

Name	Type	Description
authorization	string	Bearer Token

Request Body

Name	Type	Description
parentId	string	UUID4 format - place id
name	string

200

{
  "id": "cb1a1493-992e-4f18-a3da-d2365ec3af0b",
  "createdBy": "1a594c25-9bdc-4aec-95bb-66e69c929c70",
  "name": "place name",
  "updatedAt": "2020-02-05T19:15:36.563Z",
  "createdAt": "2020-02-05T19:15:36.563Z",
  "icon": null,
  "parentId": null
}

400

GET https://devices-api.xiot.cloud/v1/places

Headers

Name	Type	Description
authorization	string	Bearer Token

200

[
  {
    "id": "383695ec-a6f1-4424-b6db-feca53f77204",
    "name": "placse one",
    "icon": null,
    "parentId": null,
    "createdBy": "1a594c25-9bdc-4aec-95bb-66e69c929c70",
    "createdAt": "2020-02-05T19:15:27.557Z",
    "updatedAt": "2020-02-05T19:15:27.557Z"
  },
  {
    "id": "cb1a1493-992e-4f18-a3da-d2365ec3af0b",
    "name": "place name",
    "icon": null,
    "parentId": null,
    "createdBy": "1a594c25-9bdc-4aec-95bb-66e69c929c70",
    "createdAt": "2020-02-05T19:15:36.563Z",
    "updatedAt": "2020-02-05T19:15:36.563Z"
  }
]