Platform API: Dashboard
get
Authorizations
BearerstringRequired
Responses
200
OK
get
/api/platform/dashboard200
OK
post
Authorizations
BearerstringRequired
Body
Titlestring · nullableOptional
OnlyVisibleOnDashboardbooleanOptional
Responses
200
OK
post
/api/platform/dashboard/notifications/search200
OK
get
Authorizations
BearerstringRequired
Path parameters
notificationIdstring · uuidRequired
Responses
200
OK
NotificationIdstring · uuidOptional
Typestring · enumOptionalPossible values:
Titlestring · nullableOptional
Detailsstring · nullableOptional
LinkTextstring · nullableOptional
LinkUrlstring · nullableOptional
StartDatestring · date-time · nullableOptional
EndDatestring · date-time · nullableOptional
IsActivebooleanOptional
Createdstring · date-timeOptional
CreatedBystring · uuidOptional
Modifiedstring · date-timeOptional
ModifiedBystring · uuidOptional
get
/api/platform/dashboard/notifications/{notificationId}200
OK
delete
Authorizations
BearerstringRequired
Path parameters
notificationIdstring · uuidRequired
Responses
200
OK
No content
delete
/api/platform/dashboard/notifications/{notificationId}200
OK
No content
post
Authorizations
BearerstringRequired
Body
NotificationIdstring · uuidOptional
Typestring · enumOptionalPossible values:
Titlestring · nullableOptional
Detailsstring · nullableOptional
LinkTextstring · nullableOptional
LinkUrlstring · nullableOptional
StartDatestring · date-time · nullableOptional
EndDatestring · date-time · nullableOptional
IsActivebooleanOptional
Createdstring · date-timeOptional
CreatedBystring · uuidOptional
Modifiedstring · date-timeOptional
ModifiedBystring · uuidOptional
Responses
200
OK
NotificationIdstring · uuidOptional
Typestring · enumOptionalPossible values:
Titlestring · nullableOptional
Detailsstring · nullableOptional
LinkTextstring · nullableOptional
LinkUrlstring · nullableOptional
StartDatestring · date-time · nullableOptional
EndDatestring · date-time · nullableOptional
IsActivebooleanOptional
Createdstring · date-timeOptional
CreatedBystring · uuidOptional
Modifiedstring · date-timeOptional
ModifiedBystring · uuidOptional
post
/api/platform/dashboard/notifications200
OK
Last updated
Was this helpful?