List Integration devices

GET 
/organizations/:organizationId/integrations/:serviceId/devices

List Integration Devices

Request

Path Parameters

organizationId stringrequired

The ID of organization.

integrationServiceId stringrequired

The ID of integration service.

Query Parameters

maxResults number

Possible values: >= 10 and <= 25

The maximum number of results to return.

nextToken string

To retrieve the next set of results.

Responses

200

application/json

Schema

Schema

data object[]required
Array of data for the service devices.
Array [
id stringrequired
organizationId stringrequired
integrationServiceId stringrequired
name stringrequired
description stringrequired
devEui stringrequired
assetTypeId stringrequired
locationId stringrequired
createdAtDateString stringrequired
createdAt numberrequired
updatedAtDateString stringrequired
updatedAt numberrequired
]

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "organizationId": "string",
      "integrationServiceId": "string",
      "name": "string",
      "description": "string",
      "devEui": "string",
      "assetTypeId": "string",
      "locationId": "string",
      "createdAtDateString": "string",
      "createdAt": 0,
      "updatedAtDateString": "string",
      "updatedAt": 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",
      "createdAtDateString": "2024-01-01T00:00:00.000Z",
      "createdAt": 1704067200000,
      "updatedAtDateString": "2024-01-31T00:00:00.000Z",
      "updatedAt": 1706659200000
    }
  ]
}

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...