Link Integration Device

POST 
/organizations/:organizationId/integrations/:serviceId/devices

Link Integration Device

Request

Path Parameters

organizationId stringrequired

The ID of organization.

integrationServiceId stringrequired

The ID of integration.

application/json

Body

required

devEui stringrequired

The devEui of integration device.

name stringrequired

The name of integration device.

description string

The description of device.

assetTypeId stringrequired

The ID of asset type.

locationId stringrequired

The ID of location.

attributes object[]required
The custom attributes of device.
Array [
]

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the linked service device.
id stringrequired
organizationId stringrequired
integrationServiceId stringrequired
name stringrequired
description stringrequired
devEui stringrequired
assetTypeId stringrequired
locationId stringrequired
location objectrequired
id stringrequired
organizationId stringrequired
name stringrequired
description stringrequired
address stringrequired
chatRoomId stringrequired
entities object[]required
Array [
]
createdAtDateString stringrequired
createdAt numberrequired

Example (from schema)

{
  "data": {
    "id": "string",
    "organizationId": "string",
    "integrationServiceId": "string",
    "name": "string",
    "description": "string",
    "devEui": "string",
    "assetTypeId": "string",
    "locationId": "string",
    "location": {
      "id": "string",
      "organizationId": "string",
      "name": "string",
      "description": "string",
      "address": "string",
      "chatRoomId": "string",
      "entities": [
        {}
      ]
    },
    "createdAtDateString": "string",
    "createdAt": 0
  }
}

Example

{
  "data": {
    "id": "a-24e124535b312345",
    "organizationId": "o-organizationId",
    "integrationServiceId": "is-integrationServiceId",
    "name": "IDT-Bot",
    "description": "IDT-Bot-Description",
    "devEui": "24e124535b312345",
    "assetTypeId": "at-assetTypeId",
    "locationId": "l-locationId",
    "location": {
      "id": "l-locationId",
      "organizationId": "o-organizationId",
      "name": "office",
      "description": "location-description",
      "address": "address",
      "chatRoomId": "ABCDE",
      "entities": []
    },
    "createdAtDateString": "2024-01-01T00:00:00.000Z",
    "created": 1700000000000
  }
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...