Add a dashboard for the authenticated principal
Add a dashboard for the authenticated principal
Dashboard to add
|
name
string
requiredThe dashboard's name |
|||||||||||||||||||||
|
charts
array of objects (Chart)
required
The dashboard's list of charts |
|||||||||||||||||||||
|
Array [
] |
|||||||||||||||||||||
|
type
string
requiredThe type of objects the dashboard displays
Enum
certificate
request
|
|||||||||||||||||||||
|
description
string | null
The dashboard's description |
|||||||||||||||||||||
-
200 Dashboard successfully added
application/jsonnamestring requiredThe dashboard's name
chartsarray of objects (Chart) requiredThe dashboard's list of charts
Array [
titlestring requiredTitle of the chart
typestring (ChartType) requiredThe type of the chart
Enumtabledonutbar-horizontalbar-verticalbar-horizontal-stackedbar-vertical-stackedmetricarealineheatmappietreemapradarpolarpyramidfieldsarray of string requiredThe field that will be used to group data
colorsarray of string requiredThe colors of the chart
logboolean requiredWhether the logarithm scale is enabled or not
descriptionstring | nullThe description of the chart
limitinteger | nullThe maximum number of results to display
havingobject | null (Having)A condition to apply to the results of the aggregate. Only the aggregates results with more than 5 items in them can be kept for example
operatorstring requiredAn operator for comparison
Enumgteltegteqneltvalueinteger requiredAn integer for the right hand side of the condition
sortOrderstring | nullHow to sort the results in the chart (if applicable)
EnumAscDescKeyAscKeyDesclocalQuerystring | nullThe HCQL/HRQL query to build the chart from
directionstring | nullThe sort direction applied to the chart values
Enumascdescistring | nullThe index of the chart on the dashboard
xinteger | nullThe horizontal position of the chart on the grid
yinteger | nullThe vertical position of the chart on the grid
winteger | nullThe width of the chart
hinteger | nullThe height of the chart
]
typestring requiredThe type of objects the dashboard displays
Enumcertificaterequestdescriptionstring | nullThe dashboard's description
-
400 Bad Request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSEC-PI-008messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Principal Info dashboardtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Principal Info dashboarddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
401 Unauthorized request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid credentials or principal does not existtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid credentials or principal does not existdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-003messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is not trustedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is not trusteddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-004messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-005messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is revokedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is revokeddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-006messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticatedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticateddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-007messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Identity Providertitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Identity Providerdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-008messagestring requiredA short, human-readable summary of the problem type
ValueInvalid redirect pathtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid redirect pathdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-009messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticated or authentication expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticated or authentication expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
403 Forbidden action
application/problem+jsonerrorstring requiredThe error code of the problem
ValueLIC-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Licensedetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-004messagestring requiredA short, human-readable summary of the problem type
ValueExpired Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueExpired Licensedetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
500 Internal Server error
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSEC-PI-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807