Create Deck

POST 
/organizations/:organizationId/decks

Create Deck

Request

Path Parameters

organizationId stringrequired

The ID of organization.

application/json

Body

required

title string

The title of deck.

description string

The description of deck.

weight numberrequired

The weight of deck.

widgets object[]
The widgets of deck.
Array [
]
deckType string

The type of deck: 'monitor' or 'report'. Defaults to 'monitor'.

timeRange object

Deck-level time range configuration (required for report type).

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the deck.
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
]
createdBy 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"
      }
    ],
    "createdBy": "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,
    "createdBy": "d6b0e137-xxxx-xxxx-xxxx-c944cc12a5f4",
    "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...