Last updated: January 14, 2025

DQOps REST API filtered_notifications_configurations operations

Operations for managing the configuration of filtered notifications on a connection level in DQOps.

---

create_connection_filtered_notification_configuration

Creates a new filtered notification configuration on a connection level

Follow the link to see the source code on GitHub.

POST

http://localhost:8888/api/connections/{connectionName}/filterednotifications

Parameters of this method are described below

Property name	Description	Data type	Required
connection_name	Connection name	string

Request body

Description	Data type	Required
Filtered notification model	FilteredNotificationModel

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl -X POST http://localhost:8888/api/connections/sample_connection/filterednotifications^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{}"

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import create_connection_filtered_notification_configuration
from dqops.client.models import FilteredNotificationModel

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = FilteredNotificationModel()

call_result = create_connection_filtered_notification_configuration.sync(
    'sample_connection',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import create_connection_filtered_notification_configuration
from dqops.client.models import FilteredNotificationModel

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = FilteredNotificationModel()

call_result = await create_connection_filtered_notification_configuration.asyncio(
    'sample_connection',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import create_connection_filtered_notification_configuration
from dqops.client.models import FilteredNotificationModel

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = FilteredNotificationModel()

call_result = create_connection_filtered_notification_configuration.sync(
    'sample_connection',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import create_connection_filtered_notification_configuration
from dqops.client.models import FilteredNotificationModel

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = FilteredNotificationModel()

call_result = await create_connection_filtered_notification_configuration.asyncio(
    'sample_connection',
    client=dqops_client,
    json_body=request_body
)

---

create_default_filtered_notification_configuration

Creates a new filtered notification configuration at default notifications

Follow the link to see the source code on GitHub.

POST

http://localhost:8888/api/default/filterednotifications

Request body

Description	Data type	Required
Filtered notification model	FilteredNotificationModel

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl -X POST http://localhost:8888/api/default/filterednotifications^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{}"

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import create_default_filtered_notification_configuration
from dqops.client.models import FilteredNotificationModel

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = FilteredNotificationModel()

call_result = create_default_filtered_notification_configuration.sync(
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import create_default_filtered_notification_configuration
from dqops.client.models import FilteredNotificationModel

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = FilteredNotificationModel()

call_result = await create_default_filtered_notification_configuration.asyncio(
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import create_default_filtered_notification_configuration
from dqops.client.models import FilteredNotificationModel

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = FilteredNotificationModel()

call_result = create_default_filtered_notification_configuration.sync(
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import create_default_filtered_notification_configuration
from dqops.client.models import FilteredNotificationModel

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = FilteredNotificationModel()

call_result = await create_default_filtered_notification_configuration.asyncio(
    client=dqops_client,
    json_body=request_body
)

---

delete_connection_filtered_notification_configuration

Deletes a filtered notification configuration from a connection

Follow the link to see the source code on GitHub.

DELETE

http://localhost:8888/api/connections/{connectionName}/filterednotifications/{filteredNotificationName}

Parameters of this method are described below

Property name	Description	Data type	Required
connection_name	Connection name	string
filtered_notification_name	Filtered notification name	string

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl -X DELETE http://localhost:8888/api/connections/sample_connection/filterednotifications/fact*^
    -H "Accept: application/json"

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import delete_connection_filtered_notification_configuration

dqops_client = client.Client(
    'http://localhost:8888/'
)

call_result = delete_connection_filtered_notification_configuration.sync(
    'sample_connection',
    'fact*',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import delete_connection_filtered_notification_configuration

dqops_client = client.Client(
    'http://localhost:8888/'
)

call_result = await delete_connection_filtered_notification_configuration.asyncio(
    'sample_connection',
    'fact*',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import delete_connection_filtered_notification_configuration

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

call_result = delete_connection_filtered_notification_configuration.sync(
    'sample_connection',
    'fact*',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import delete_connection_filtered_notification_configuration

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

call_result = await delete_connection_filtered_notification_configuration.asyncio(
    'sample_connection',
    'fact*',
    client=dqops_client
)

---

delete_default_filtered_notification_configuration

Deletes a filtered notification configuration from default notifications

Follow the link to see the source code on GitHub.

DELETE

http://localhost:8888/api/default/filterednotifications/{filteredNotificationName}

Parameters of this method are described below

Property name	Description	Data type	Required
filtered_notification_name	Filtered notification name	string

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl -X DELETE http://localhost:8888/api/default/filterednotifications/fact*^
    -H "Accept: application/json"

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import delete_default_filtered_notification_configuration

dqops_client = client.Client(
    'http://localhost:8888/'
)

call_result = delete_default_filtered_notification_configuration.sync(
    'fact*',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import delete_default_filtered_notification_configuration

dqops_client = client.Client(
    'http://localhost:8888/'
)

call_result = await delete_default_filtered_notification_configuration.asyncio(
    'fact*',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import delete_default_filtered_notification_configuration

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

call_result = delete_default_filtered_notification_configuration.sync(
    'fact*',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import delete_default_filtered_notification_configuration

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

call_result = await delete_default_filtered_notification_configuration.asyncio(
    'fact*',
    client=dqops_client
)

---

get_connection_filtered_notification_configuration

Returns a model of the filtered notification configuration

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/filterednotifications/{filteredNotificationName}

Return value

Property name	Description	Data type
filtered_notification_model		FilteredNotificationModel

Parameters of this method are described below

Property name	Description	Data type	Required
connection_name	Connection name	string
filtered_notification_name	Filtered notification name	string

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl http://localhost:8888/api/connections/sample_connection/filterednotifications/fact*^
    -H "Accept: application/json"

Expand to see the returned result

{ }

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import get_connection_filtered_notification_configuration

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_connection_filtered_notification_configuration.sync(
    'sample_connection',
    'fact*',
    client=dqops_client
)

Expand to see the returned result

FilteredNotificationModel()

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import get_connection_filtered_notification_configuration

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_connection_filtered_notification_configuration.asyncio(
    'sample_connection',
    'fact*',
    client=dqops_client
)

Expand to see the returned result

FilteredNotificationModel()

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import get_connection_filtered_notification_configuration

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_connection_filtered_notification_configuration.sync(
    'sample_connection',
    'fact*',
    client=dqops_client
)

Expand to see the returned result

FilteredNotificationModel()

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import get_connection_filtered_notification_configuration

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_connection_filtered_notification_configuration.asyncio(
    'sample_connection',
    'fact*',
    client=dqops_client
)

Expand to see the returned result

FilteredNotificationModel()

---

get_connection_filtered_notifications_configurations

Returns the list of filtered notification configurations on a connection

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/filterednotifications

Return value

Property name	Description	Data type
filtered_notification_model		List[FilteredNotificationModel]

Parameters of this method are described below

Property name	Description	Data type	Required
connection_name	Connection name	string

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl http://localhost:8888/api/connections/sample_connection/filterednotifications^
    -H "Accept: application/json"

Expand to see the returned result

[ { }, { }, { } ]

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import get_connection_filtered_notifications_configurations

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_connection_filtered_notifications_configurations.sync(
    'sample_connection',
    client=dqops_client
)

Expand to see the returned result

[
    FilteredNotificationModel(),
    FilteredNotificationModel(),
    FilteredNotificationModel()
]

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import get_connection_filtered_notifications_configurations

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_connection_filtered_notifications_configurations.asyncio(
    'sample_connection',
    client=dqops_client
)

Expand to see the returned result

[
    FilteredNotificationModel(),
    FilteredNotificationModel(),
    FilteredNotificationModel()
]

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import get_connection_filtered_notifications_configurations

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_connection_filtered_notifications_configurations.sync(
    'sample_connection',
    client=dqops_client
)

Expand to see the returned result

[
    FilteredNotificationModel(),
    FilteredNotificationModel(),
    FilteredNotificationModel()
]

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import get_connection_filtered_notifications_configurations

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_connection_filtered_notifications_configurations.asyncio(
    'sample_connection',
    client=dqops_client
)

Expand to see the returned result

[
    FilteredNotificationModel(),
    FilteredNotificationModel(),
    FilteredNotificationModel()
]

---

get_default_filtered_notification_configuration

Returns a model of the filtered notification from default notifications

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/default/filterednotifications/{filteredNotificationName}

Return value

Property name	Description	Data type
filtered_notification_model		FilteredNotificationModel

Parameters of this method are described below

Property name	Description	Data type	Required
filtered_notification_name	Filtered notification name	string

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl http://localhost:8888/api/default/filterednotifications/fact*^
    -H "Accept: application/json"

Expand to see the returned result

{ }

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import get_default_filtered_notification_configuration

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_default_filtered_notification_configuration.sync(
    'fact*',
    client=dqops_client
)

Expand to see the returned result

FilteredNotificationModel()

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import get_default_filtered_notification_configuration

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_default_filtered_notification_configuration.asyncio(
    'fact*',
    client=dqops_client
)

Expand to see the returned result

FilteredNotificationModel()

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import get_default_filtered_notification_configuration

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_default_filtered_notification_configuration.sync(
    'fact*',
    client=dqops_client
)

Expand to see the returned result

FilteredNotificationModel()

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import get_default_filtered_notification_configuration

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_default_filtered_notification_configuration.asyncio(
    'fact*',
    client=dqops_client
)

Expand to see the returned result

FilteredNotificationModel()

---

get_default_filtered_notifications_configurations

Returns the list of filtered notification configurations on default notifications

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/default/filterednotifications

Return value

Property name	Description	Data type
filtered_notification_model		List[FilteredNotificationModel]

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl http://localhost:8888/api/default/filterednotifications^
    -H "Accept: application/json"

Expand to see the returned result

[ { }, { }, { } ]

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import get_default_filtered_notifications_configurations

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_default_filtered_notifications_configurations.sync(
    client=dqops_client
)

Expand to see the returned result

[
    FilteredNotificationModel(),
    FilteredNotificationModel(),
    FilteredNotificationModel()
]

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import get_default_filtered_notifications_configurations

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_default_filtered_notifications_configurations.asyncio(
    client=dqops_client
)

Expand to see the returned result

[
    FilteredNotificationModel(),
    FilteredNotificationModel(),
    FilteredNotificationModel()
]

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import get_default_filtered_notifications_configurations

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_default_filtered_notifications_configurations.sync(
    client=dqops_client
)

Expand to see the returned result

[
    FilteredNotificationModel(),
    FilteredNotificationModel(),
    FilteredNotificationModel()
]

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import get_default_filtered_notifications_configurations

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_default_filtered_notifications_configurations.asyncio(
    client=dqops_client
)

Expand to see the returned result

[
    FilteredNotificationModel(),
    FilteredNotificationModel(),
    FilteredNotificationModel()
]

---

update_connection_filtered_notification_configuration

Updates a filtered notification configuration according to the provided model

Follow the link to see the source code on GitHub.

PUT

http://localhost:8888/api/connections/{connectionName}/filterednotifications/{filteredNotificationName}

Parameters of this method are described below

Property name	Description	Data type	Required
connection_name	Connection name	string
filtered_notification_name	Filtered notification name	string

Request body

Description	Data type	Required
Filtered notification model	FilteredNotificationModel

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl -X PUT http://localhost:8888/api/connections/sample_connection/filterednotifications/fact*^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{}"

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import update_connection_filtered_notification_configuration
from dqops.client.models import FilteredNotificationModel

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = FilteredNotificationModel()

call_result = update_connection_filtered_notification_configuration.sync(
    'sample_connection',
    'fact*',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import update_connection_filtered_notification_configuration
from dqops.client.models import FilteredNotificationModel

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = FilteredNotificationModel()

call_result = await update_connection_filtered_notification_configuration.asyncio(
    'sample_connection',
    'fact*',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import update_connection_filtered_notification_configuration
from dqops.client.models import FilteredNotificationModel

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = FilteredNotificationModel()

call_result = update_connection_filtered_notification_configuration.sync(
    'sample_connection',
    'fact*',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import update_connection_filtered_notification_configuration
from dqops.client.models import FilteredNotificationModel

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = FilteredNotificationModel()

call_result = await update_connection_filtered_notification_configuration.asyncio(
    'sample_connection',
    'fact*',
    client=dqops_client,
    json_body=request_body
)

---

update_default_filtered_notification_configuration

Updates a filtered notification configuration on default notifications according to the provided model

Follow the link to see the source code on GitHub.

PUT

http://localhost:8888/api/default/filterednotifications/{filteredNotificationName}

Parameters of this method are described below

Property name	Description	Data type	Required
filtered_notification_name	Filtered notification name	string

Request body

Description	Data type	Required
Filtered notification model	FilteredNotificationModel

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl -X PUT http://localhost:8888/api/default/filterednotifications/fact*^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{}"

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import update_default_filtered_notification_configuration
from dqops.client.models import FilteredNotificationModel

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = FilteredNotificationModel()

call_result = update_default_filtered_notification_configuration.sync(
    'fact*',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import update_default_filtered_notification_configuration
from dqops.client.models import FilteredNotificationModel

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = FilteredNotificationModel()

call_result = await update_default_filtered_notification_configuration.asyncio(
    'fact*',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import update_default_filtered_notification_configuration
from dqops.client.models import FilteredNotificationModel

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = FilteredNotificationModel()

call_result = update_default_filtered_notification_configuration.sync(
    'fact*',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.filtered_notifications_configurations import update_default_filtered_notification_configuration
from dqops.client.models import FilteredNotificationModel

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = FilteredNotificationModel()

call_result = await update_default_filtered_notification_configuration.asyncio(
    'fact*',
    client=dqops_client,
    json_body=request_body
)