Dashboard Controller

get

Authorizations

Path parameters

boardGroupIdstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

GET /api/dashboard/{boardGroupId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-08-21T19:35:49.282Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-08-21T19:35:49.282Z",
  "id": "text",
  "color": "text",
  "boards": [
    {
      "creationDate": "2025-08-21T19:35:49.282Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-08-21T19:35:49.282Z",
      "id": "text",
      "y": 1,
      "header": true,
      "height": 1,
      "boardGroupId": "text",
      "width": 1,
      "x": 1,
      "config": "text",
      "type": "Animation"
    }
  ],
  "name": "text",
  "rank": 1
}

put

Authorizations

Path parameters

boardGroupIdstringRequired

Body

creationDatestring · date-timeRead-onlyOptional

lastModifiedBystringRead-onlyOptional

createdBystringRead-onlyOptional

lastModifiedDatestring · date-timeRead-onlyOptional

idstringOptional

colorstringOptional

namestring · max: 100Required

rankinteger · int32Optional

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

put

PUT /api/dashboard/{boardGroupId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "id": "text",
  "color": "text",
  "boards": [
    {
      "id": "text",
      "y": 1,
      "header": true,
      "height": 1,
      "boardGroupId": "text",
      "width": 1,
      "x": 1,
      "config": "text",
      "type": "Animation"
    }
  ],
  "name": "text",
  "rank": 1
}

No content

delete

Authorizations

Path parameters

boardGroupIdstringRequired

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

DELETE /api/dashboard/{boardGroupId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content

get

Authorizations

Path parameters

boardGroupIdstringRequired

boardIdstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

GET /api/dashboard/{boardGroupId}/boards/{boardId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-08-21T19:35:49.282Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-08-21T19:35:49.282Z",
  "id": "text",
  "y": 1,
  "header": true,
  "height": 1,
  "boardGroupId": "text",
  "width": 1,
  "x": 1,
  "config": "text",
  "type": "Animation"
}

put

Authorizations

Path parameters

boardGroupIdstringRequired

boardIdstringRequired

Body

creationDatestring · date-timeRead-onlyOptional

lastModifiedBystringRead-onlyOptional

createdBystringRead-onlyOptional

lastModifiedDatestring · date-timeRead-onlyOptional

idstringOptional

ynumber · floatOptional

headerbooleanOptional

heightnumber · floatOptional

boardGroupIdstringOptional

widthnumber · floatOptional

xnumber · floatOptional

configstringRequired

typestring · enumRequiredPossible values:

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

put

PUT /api/dashboard/{boardGroupId}/boards/{boardId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "id": "text",
  "y": 1,
  "header": true,
  "height": 1,
  "boardGroupId": "text",
  "width": 1,
  "x": 1,
  "config": "text",
  "type": "Animation"
}

No content

delete

Authorizations

Path parameters

boardGroupIdstringRequired

boardIdstringRequired

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

DELETE /api/dashboard/{boardGroupId}/boards/{boardId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content

get

Authorizations

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

GET /api/dashboard HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-08-21T19:35:49.282Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-08-21T19:35:49.282Z",
    "id": "text",
    "color": "text",
    "boards": [
      {
        "creationDate": "2025-08-21T19:35:49.282Z",
        "lastModifiedBy": "text",
        "createdBy": "text",
        "lastModifiedDate": "2025-08-21T19:35:49.282Z",
        "id": "text",
        "y": 1,
        "header": true,
        "height": 1,
        "boardGroupId": "text",
        "width": 1,
        "x": 1,
        "config": "text",
        "type": "Animation"
      }
    ],
    "name": "text",
    "rank": 1
  }
]

post

Authorizations

Body

creationDatestring · date-timeRead-onlyOptional

lastModifiedBystringRead-onlyOptional

createdBystringRead-onlyOptional

lastModifiedDatestring · date-timeRead-onlyOptional

idstringOptional

colorstringOptional

namestring · max: 100Required

rankinteger · int32Optional

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

POST /api/dashboard HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "id": "text",
  "color": "text",
  "boards": [
    {
      "id": "text",
      "y": 1,
      "header": true,
      "height": 1,
      "boardGroupId": "text",
      "width": 1,
      "x": 1,
      "config": "text",
      "type": "Animation"
    }
  ],
  "name": "text",
  "rank": 1
}

{
  "creationDate": "2025-08-21T19:35:49.282Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-08-21T19:35:49.282Z",
  "id": "text",
  "color": "text",
  "boards": [
    {
      "creationDate": "2025-08-21T19:35:49.282Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-08-21T19:35:49.282Z",
      "id": "text",
      "y": 1,
      "header": true,
      "height": 1,
      "boardGroupId": "text",
      "width": 1,
      "x": 1,
      "config": "text",
      "type": "Animation"
    }
  ],
  "name": "text",
  "rank": 1
}

get

Authorizations

Path parameters

boardGroupIdstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

GET /api/dashboard/{boardGroupId}/boards HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-08-21T19:35:49.282Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-08-21T19:35:49.282Z",
    "id": "text",
    "y": 1,
    "header": true,
    "height": 1,
    "boardGroupId": "text",
    "width": 1,
    "x": 1,
    "config": "text",
    "type": "Animation"
  }
]

post

Authorizations

Path parameters

boardGroupIdstringRequired

Body

creationDatestring · date-timeRead-onlyOptional

lastModifiedBystringRead-onlyOptional

createdBystringRead-onlyOptional

lastModifiedDatestring · date-timeRead-onlyOptional

idstringOptional

ynumber · floatOptional

headerbooleanOptional

heightnumber · floatOptional

boardGroupIdstringOptional

widthnumber · floatOptional

xnumber · floatOptional

configstringRequired

typestring · enumRequiredPossible values:

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

POST /api/dashboard/{boardGroupId}/boards HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "id": "text",
  "y": 1,
  "header": true,
  "height": 1,
  "boardGroupId": "text",
  "width": 1,
  "x": 1,
  "config": "text",
  "type": "Animation"
}

{
  "creationDate": "2025-08-21T19:35:49.282Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-08-21T19:35:49.282Z",
  "id": "text",
  "y": 1,
  "header": true,
  "height": 1,
  "boardGroupId": "text",
  "width": 1,
  "x": 1,
  "config": "text",
  "type": "Animation"
}

post

Authorizations

Query parameters

Body

filestring · binaryRequired

Responses

200

OK

*/*

Responseobject

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

POST /api/dashboard/import HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{}

get

Authorizations

Query parameters

projectIdstringOptional

includeIdsbooleanOptionalDefault: false

Responses

200

OK

*/*

Responseobject

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

GET /api/dashboard/export HTTP/1.1
Host: inscada.cloud
Accept: */*

{}