List Decks

GET 
/organizations/:organizationId/decks

List Decks

Request

Path Parameters

organizationId stringrequired

The ID of organization.

Query Parameters

maxResults number

Possible values: >= 10 and <= 100

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
Data of the deck.
Array [
title stringrequired
description stringrequired
weight stringrequired
widgets object[]required
Array [
id stringrequired
configuration objectrequired
assetId stringrequired
modeKey stringrequired
description stringrequired
gridLayout objectrequired
h numberrequired
i stringrequired
w numberrequired
x numberrequired
y numberrequired
title stringrequired
type stringrequired
]
autoRefreshInterval stringrequired
createdAtDateString stringrequired
createdAt numberrequired
updatedAtDateString stringrequired
updatedAt numberrequired
]

Example (from schema)

{
  "data": [
    {
      "title": "string",
      "description": "string",
      "weight": "string",
      "widgets": [
        {
          "id": "string",
          "configuration": {
            "assetId": "string",
            "modeKey": "string"
          },
          "description": "string",
          "gridLayout": {
            "h": 0,
            "i": "string",
            "w": 0,
            "x": 0,
            "y": 0
          },
          "title": "string",
          "type": "string"
        }
      ],
      "autoRefreshInterval": "string",
      "createdAtDateString": "string",
      "createdAt": 0,
      "updatedAtDateString": "string",
      "updatedAt": 0
    }
  ]
}

Example

{
  "data": [
    {
      "title": "IDT-Deck",
      "description": "IDT-Deck-Description",
      "weight": "1",
      "widgets": [
        {
          "id": "1710000000000",
          "configuration": {
            "assetId": "a-assetId",
            "modeKey": "default"
          },
          "description": "Display a device status",
          "gridLayout": {
            "h": 15,
            "i": 1700000000000,
            "w": 6,
            "x": 6,
            "y": 0
          },
          "title": "Data Combination",
          "type": "UtdDc"
        }
      ],
      "autoRefreshInterval": 0,
      "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...