Manage Alert Streaming Configuration

Manages an on-demand Streaming Configuration.

Note: To use this API, you must enable the Stream Exports Add-on and have the REPORTS_MANAGE permission assigned.

Get Steaming Details.

Path Parameters

  • idstringrequired

    Streaming uuid

  • partnerIdstringrequired

    Describes the unique identifier of the provider (mspId)

Responses

  • idstring

  • namestring

  • clientsarray

  • categoryTypestring

  • exportIntegrationobject

  • rawEventsboolean

  • allClientsboolean

Loading Examples...

Note: To use this API, you must enable the Stream Exports Add-on. You also need to have the REPORTS_MANAGE and INTEGRATION_EDIT permissions assigned.

Update Streaming Configuration attributes.

Path Parameters

  • idstringrequired

    Streaming uuid

  • partnerIdstringrequired

    Describes the unique identifier of the provider (mspId)

Request Body

application/json

Loading Examples...

Responses

  • idstring

  • namestring

Loading Examples...

Note: To use this API, you need to have the REPORTS_MANAGE and INTEGRATION_MANAGE permissions assigned.

Delete a Streaming Configuration.

Path Parameters

  • idstringrequired

    Streaming uuid

  • partnerIdstringrequired

    Describes the unique identifier of the provider (mspId)

Responses

  • resultstring

Loading Examples...