Organization
    Cookie Security Configuration
    Organization - Declarative APIs
    Organization - Entity APIs
    Options
    CSP Directives
    JWKS
    Notification Channels
      Test notification channel.postTest existing notification channel.postGet latest notifications.getMark all notifications as read.postMark notification as read.post/api/v1/entities/notificationChannelIdentifiersget/api/v1/entities/notificationChannelIdentifiers/{id}getGet all Notification Channel entitiesgetPost Notification Channel entitiespostGet Notification Channel entitygetPut Notification Channel entityputDelete Notification Channel entitydeletePatch Notification Channel entitypatchGet all export templates layoutgetSet all export templatesputGet all notification channels layoutgetSet all notification channelsput
    Identity Providers
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Notification Channels (3.50)

Endpoint:/

Test notification channel.

POST
/api/v1/actions/notificationChannels/test

Tests the notification channel by sending a test notification.

Test notification channel. › Request Body

  • destinationrequired
  • externalRecipientsarray | null · maxItems: 1 · unique

    External recipients of the test result.

Test notification channel. › Responses

The result of the test of a notification channel connection.

  • successfulboolean · required

    A flag indicating whether test passed or not.

    Example: true
  • errorstring

    Field containing more details in case of a failure. Details are available to a privileged user only.

    Example: Connection exception: Failed to initialize pool: FATAL: password authentication failed for user "user"
  • queryDurationMillisobject

    A structure containing duration of the test queries run on a data source. It is omitted if an error happens.

POST /api/v1/actions/notificationChannels/test

Test existing notification channel.

POST
/api/v1/actions/notificationChannels/{notificationChannelId}/test

Tests the existing notification channel by sending a test notification.

Test existing notification channel. › path Parameters

  • notificationChannelIdstring · required

Test existing notification channel. › Request Body

  • destinationrequired
  • externalRecipientsarray | null · maxItems: 1 · unique

    External recipients of the test result.

Test existing notification channel. › Responses

The result of the test of a notification channel connection.

  • successfulboolean · required

    A flag indicating whether test passed or not.

    Example: true
  • errorstring

    Field containing more details in case of a failure. Details are available to a privileged user only.

    Example: Connection exception: Failed to initialize pool: FATAL: password authentication failed for user "user"
  • queryDurationMillisobject

    A structure containing duration of the test queries run on a data source. It is omitted if an error happens.

POST /api/v1/actions/notificationChannels/{notificationChannelId}/test

Get latest notifications.

GET
/api/v1/actions/notifications

Get latest in-platform notifications for the current user.

Get latest notifications. › query Parameters

  • workspaceIdstring · style: form

    Workspace ID to filter notifications by.

  • isReadboolean · style: form

    Filter notifications by read status.

  • pagestring · min: 0 · style: form

    Zero-based page index (0..N)

    Default: 0
  • sizestring · min: 1 · style: form

    The size of the page to be returned.

    Default: 20
  • metaIncludestring[] · unique · style: form · explode: true

    Additional meta information to include in the response.

    Enum values:
    total
    ALL

Get latest notifications. › Responses

OK

  • dataobject[] · required
  • metaobject · required
GET /api/v1/actions/notifications

Mark all notifications as read.

POST
/api/v1/actions/notifications/markAsRead

Mark all user in-platform notifications as read.

Mark all notifications as read. › query Parameters

  • workspaceIdstring · style: form

    Workspace ID where to mark notifications as read.

Mark all notifications as read. › Responses

No Content

No data returned
POST /api/v1/actions/notifications/markAsRead

Mark notification as read.

POST
/api/v1/actions/notifications/{notificationId}/markAsRead

Mark in-platform notification by its ID as read.

Mark notification as read. › path Parameters

  • notificationIdstring · required

    Notification ID to mark as read.

Mark notification as read. › Responses

No Content

No data returned
POST /api/v1/actions/notifications/{notificationId}/markAsRead

GET
/api/v1/entities/notificationChannelIdentifiers

query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • pageinteger

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger

    The size of the page to be returned

    Default: 20
  • sortstring[]

    Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    page
    all
    ALL

Responses

Request successfully processed

  • dataobject[] · unique · required
  • linksobject
  • metaobject
GET /api/v1/entities/notificationChannelIdentifiers

GET
/api/v1/entities/notificationChannelIdentifiers/{id}

path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of notificationChannelIdentifier entity.

  • linksobject
GET /api/v1/entities/notificationChannelIdentifiers/{id}

Get all Notification Channel entities

GET
/api/v1/entities/notificationChannels

Get all Notification Channel entities › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • pageinteger

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger

    The size of the page to be returned

    Default: 20
  • sortstring[]

    Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    page
    all
    ALL

Get all Notification Channel entities › Responses

Request successfully processed

  • dataobject[] · unique · required
  • linksobject
  • metaobject
GET /api/v1/entities/notificationChannels

Post Notification Channel entities

POST
/api/v1/entities/notificationChannels

Post Notification Channel entities › Request Body

  • dataobject · required

    JSON:API representation of notificationChannel entity.

Post Notification Channel entities › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of notificationChannel entity.

  • linksobject
POST /api/v1/entities/notificationChannels

Get Notification Channel entity

GET
/api/v1/entities/notificationChannels/{id}

Get Notification Channel entity › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Get Notification Channel entity › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Get Notification Channel entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of notificationChannel entity.

  • linksobject
GET /api/v1/entities/notificationChannels/{id}

Put Notification Channel entity

PUT
/api/v1/entities/notificationChannels/{id}

Put Notification Channel entity › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Put Notification Channel entity › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Put Notification Channel entity › Request Body

  • dataobject · required

    JSON:API representation of notificationChannel entity.

Put Notification Channel entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of notificationChannel entity.

  • linksobject
PUT /api/v1/entities/notificationChannels/{id}

Delete Notification Channel entity

DELETE
/api/v1/entities/notificationChannels/{id}

Delete Notification Channel entity › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Delete Notification Channel entity › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Delete Notification Channel entity › Responses

Successfully deleted

No data returned
DELETE /api/v1/entities/notificationChannels/{id}

Patch Notification Channel entity

PATCH
/api/v1/entities/notificationChannels/{id}

Patch Notification Channel entity › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Patch Notification Channel entity › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Patch Notification Channel entity › Request Body

  • dataobject · required

    JSON:API representation of patching notificationChannel entity.

Patch Notification Channel entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of notificationChannel entity.

  • linksobject
PATCH /api/v1/entities/notificationChannels/{id}

Get all export templates layout

GET
/api/v1/layout/exportTemplates

Gets complete layout of export templates.

Get all export templates layout › Responses

Retrieved layout of all export templates.

  • exportTemplatesobject[] · required
GET /api/v1/layout/exportTemplates

Set all export templates

PUT
/api/v1/layout/exportTemplates

Sets export templates in organization.

Set all export templates › Request Body

  • exportTemplatesobject[] · required

Set all export templates › Responses

All export templates set.

No data returned
PUT /api/v1/layout/exportTemplates

Get all notification channels layout

GET
/api/v1/layout/notificationChannels

Gets complete layout of notification channels.

Get all notification channels layout › Responses

Retrieved layout of all notification channels.

  • notificationChannelsobject[] · required
GET /api/v1/layout/notificationChannels

Set all notification channels

PUT
/api/v1/layout/notificationChannels

Sets notification channels in organization.

Set all notification channels › Request Body

  • notificationChannelsobject[] · required

Set all notification channels › Responses

All notification channels set.

No data returned
PUT /api/v1/layout/notificationChannels
JWKSIdentity Providers