Hub

A hub.

Create a hub

Create a new hub.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing hub information.

name
required
string <= 1000 characters

The name of the new hub.

Responses
201

Successful operation

422

Unprocessable Content

post/hub
Request samples
application/json
{
  • "name": "Nordantech"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "a4330eabcfa39d7318eed2db6292c73da2bc302d",
  • "data": {
    },
  • "timestamp": 1662385325391
}

Get all hubs

Get all hubs of the authenticated user.

SecurityJWT
Responses
200

Successful operation

404

Not Found

get/hub
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "88edf5a107033a8bc38a5020b9b377d44c3514e1",
  • "data": [
    ],
  • "timestamp": 1662388450027
}

Get current hub

Get the current hub.

SecurityJWT
Request
path Parameters
hub
required
string or integer

The id/hash of the hub.

Responses
200

Successful operation

404

Not Found

get/hub/{hub}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "b0393b97aa5acd983ee5a7f47796bb6ffcd766a5",
  • "data": {
    },
  • "timestamp": 1662389256356
}

Update current hub

Update the current hub.

SecurityJWT
Request
path Parameters
hub
required
string or integer

The id/hash of the hub.

Request Body schema: application/json

A JSON object containing hub information.

name
string <= 1000 characters

The name of the hub.

program_level
boolean

The program level flag indicates whether the program level is visible to users.

login_confirmation
boolean

The login confirmation flag indicates whether the user needs to secure his login via multi factor authentication to access the hub.

login_confirmation_channel
integer

The login confirmation channel defines the minimum multi factor channel of the hub.

  • 1 - Email
  • 2 - SMS
  • 3 - Authenticator

The additional factor is only requested with each login if the login confirmation flag is "true". Otherwise it is only used for logins from new devices.

Enum: 1 2 3
report_gradient_color_cover_start
string or null^[A-Za-z0-9]{6}$

The gradient cover start color for a reporting of the hub.

report_gradient_color_cover_end
string or null^[A-Za-z0-9]{6}$

The gradient cover end color for a reporting of the hub.

report_gradient_alpha_cover_start
integer or null [ 0 .. 100 ]

The gradient cover start alpha for a reporting of the hub.

report_gradient_alpha_cover_end
integer or null [ 0 .. 100 ]

The gradient cover end alpha for a reporting of the hub.

report_font_color
string or null^[A-Za-z0-9]{6}$

The font color for a reporting of the hub.

report_font_color_heading
string or null^[A-Za-z0-9]{6}$

The heading font color for a reporting of the hub.

report_font_color_cover
string or null^[A-Za-z0-9]{6}$

The cover font color for a reporting of the hub.

report_font_color_title
string or null^[A-Za-z0-9]{6}$

The title font color for a reporting of the hub.

report_font_color_subtitle
string or null^[A-Za-z0-9]{6}$

The subtitle font color for a reporting of the hub.

report_font_color_placeholder
string or null^[A-Za-z0-9]{6}$

The placeholder font color for a reporting of the hub.

report_font_color_footer
string or null^[A-Za-z0-9]{6}$

The footer font color for a reporting of the hub.

report_background_color
string or null^[A-Za-z0-9]{6}$

The background color for a reporting of the hub.

report_background_color_heading
string or null^[A-Za-z0-9]{6}$

The background heading color for a reporting of the hub.

report_border_color
string or null^[A-Za-z0-9]{6}$

The border color for a reporting of the hub.

report_border_color_heading
string or null^[A-Za-z0-9]{6}$

The border heading color for a reporting of the hub.

report_chart_series_color_plan
string or null^[A-Za-z0-9]{6}$

The chart color plan for a reporting of the hub.

report_chart_series_color_actual
string or null^[A-Za-z0-9]{6}$

The chart color actual for a reporting of the hub.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

put/hub/{hub}
Request samples
application/json
{
  • "login_confirmation": true,
  • "login_confirmation_channel": 3,
  • "report_font_color": "#FE2EF7"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "b2977ca770f59bd15dbca10569fa842a7871700a",
  • "data": {
    },
  • "timestamp": 1662394536910
}

Upload a thumbnail

Upload a thumbnail.

SecurityJWT
Request
path Parameters
hub
required
string or integer

The id/hash of the hub.

Request Body schema: multipart/form-data

A JSON object containing thumbnail information.

image
required
string <binary>

The upload image.

The image must be a usable file with the mime types jpg or png. The maximum file size is 10MB. The minimum width and height of the image is 400 pixel.

Responses
200

Successful operation

422

Unprocessable Content

post/hub/{hub}/image
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "d29c3265b895448a86391286eba69ac57d02c346",
  • "data": {
    },
  • "timestamp": 1662134097451
}

Delete a thumbnail

Delete a thumbnail.

SecurityJWT
Request
path Parameters
hub
required
string or integer

The id/hash of the hub.

Responses
200

Successful operation

404

Not Found

delete/hub/{hub}/image
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": [ ],
  • "timestamp": 1662134390827
}