Content-Length: 232100 | pFad | http://dqops.com/docs/client/operations/data_domains/

DQOps REST API data_domains operations
Skip to content

Last updated: January 14, 2025

DQOps REST API data_domains operations

Data domain management API to create different data domains.


create_data_domain

Creates a new data domain given a data domain display name.

Follow the link to see the source code on GitHub.

POST

http://localhost:8888/api/domains/{dataDomainDisplayName}

Return value

 Property name   Description                       Data type 
local_data_domain_model LocalDataDomainModel

Parameters of this method are described below

 Property name   Description                       Data type   Required 
data_domain_display_name Data domain display name string

Usage examples

Execution

curl -X POST http://localhost:8888/api/domains/Sales^
    -H "Accept: application/json"
Expand to see the returned result
{
  "domain_name" : "sales",
  "display_name" : "Sales data domain",
  "created_at" : "2024-09-14T18:33:00Z",
  "enable_scheduler" : true
}

Execution

from dqops import client
from dqops.client.api.data_domains import create_data_domain

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

call_result = create_data_domain.sync(
    'Sales',
    client=dqops_client
)
Expand to see the returned result
LocalDataDomainModel(
    domain_name='sales',
    display_name='Sales data domain',
    created_at='2024-09-14T18:33:00Z',
    enable_scheduler=True
)

Execution

from dqops import client
from dqops.client.api.data_domains import create_data_domain

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

call_result = await create_data_domain.asyncio(
    'Sales',
    client=dqops_client
)
Expand to see the returned result
LocalDataDomainModel(
    domain_name='sales',
    display_name='Sales data domain',
    created_at='2024-09-14T18:33:00Z',
    enable_scheduler=True
)

Execution

from dqops import client
from dqops.client.api.data_domains import create_data_domain

token = 's4mp13_4u7h_70k3n'

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

call_result = create_data_domain.sync(
    'Sales',
    client=dqops_client
)
Expand to see the returned result
LocalDataDomainModel(
    domain_name='sales',
    display_name='Sales data domain',
    created_at='2024-09-14T18:33:00Z',
    enable_scheduler=True
)

Execution

from dqops import client
from dqops.client.api.data_domains import create_data_domain

token = 's4mp13_4u7h_70k3n'

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

call_result = await create_data_domain.asyncio(
    'Sales',
    client=dqops_client
)
Expand to see the returned result
LocalDataDomainModel(
    domain_name='sales',
    display_name='Sales data domain',
    created_at='2024-09-14T18:33:00Z',
    enable_scheduler=True
)

delete_data_domain

Deletes a data domain. The domain is deleted in the DQOps SaaS cloud and locally.

Follow the link to see the source code on GitHub.

DELETE

http://localhost:8888/api/domains/{dataDomainName}

Parameters of this method are described below

 Property name   Description                       Data type   Required 
data_domain_name Data domain name string

Usage examples

Execution

curl -X DELETE http://localhost:8888/api/domains/crm^
    -H "Accept: application/json"

Execution

from dqops import client
from dqops.client.api.data_domains import delete_data_domain

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

call_result = delete_data_domain.sync(
    'crm',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.data_domains import delete_data_domain

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

call_result = await delete_data_domain.asyncio(
    'crm',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.data_domains import delete_data_domain

token = 's4mp13_4u7h_70k3n'

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

call_result = delete_data_domain.sync(
    'crm',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.data_domains import delete_data_domain

token = 's4mp13_4u7h_70k3n'

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

call_result = await delete_data_domain.asyncio(
    'crm',
    client=dqops_client
)

get_local_data_domains

Returns a list of local data domains that this instance is maintaining. Data domains are supported only in an ENTERPRISE versions of DQOps.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/domains/

Return value

 Property name   Description                       Data type 
local_data_domain_model List[LocalDataDomainModel]

Usage examples

Execution

curl http://localhost:8888/api/domains/^
    -H "Accept: application/json"
Expand to see the returned result
[ {
  "domain_name" : "sales",
  "display_name" : "Sales data domain",
  "created_at" : "2024-09-14T18:33:00Z",
  "enable_scheduler" : true
}, {
  "domain_name" : "sales",
  "display_name" : "Sales data domain",
  "created_at" : "2024-09-14T18:33:00Z",
  "enable_scheduler" : true
}, {
  "domain_name" : "sales",
  "display_name" : "Sales data domain",
  "created_at" : "2024-09-14T18:33:00Z",
  "enable_scheduler" : true
} ]

Execution

from dqops import client
from dqops.client.api.data_domains import get_local_data_domains

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

call_result = get_local_data_domains.sync(
    client=dqops_client
)
Expand to see the returned result
[
    LocalDataDomainModel(
        domain_name='sales',
        display_name='Sales data domain',
        created_at='2024-09-14T18:33:00Z',
        enable_scheduler=True
    ),
    LocalDataDomainModel(
        domain_name='sales',
        display_name='Sales data domain',
        created_at='2024-09-14T18:33:00Z',
        enable_scheduler=True
    ),
    LocalDataDomainModel(
        domain_name='sales',
        display_name='Sales data domain',
        created_at='2024-09-14T18:33:00Z',
        enable_scheduler=True
    )
]

Execution

from dqops import client
from dqops.client.api.data_domains import get_local_data_domains

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

call_result = await get_local_data_domains.asyncio(
    client=dqops_client
)
Expand to see the returned result
[
    LocalDataDomainModel(
        domain_name='sales',
        display_name='Sales data domain',
        created_at='2024-09-14T18:33:00Z',
        enable_scheduler=True
    ),
    LocalDataDomainModel(
        domain_name='sales',
        display_name='Sales data domain',
        created_at='2024-09-14T18:33:00Z',
        enable_scheduler=True
    ),
    LocalDataDomainModel(
        domain_name='sales',
        display_name='Sales data domain',
        created_at='2024-09-14T18:33:00Z',
        enable_scheduler=True
    )
]

Execution

from dqops import client
from dqops.client.api.data_domains import get_local_data_domains

token = 's4mp13_4u7h_70k3n'

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

call_result = get_local_data_domains.sync(
    client=dqops_client
)
Expand to see the returned result
[
    LocalDataDomainModel(
        domain_name='sales',
        display_name='Sales data domain',
        created_at='2024-09-14T18:33:00Z',
        enable_scheduler=True
    ),
    LocalDataDomainModel(
        domain_name='sales',
        display_name='Sales data domain',
        created_at='2024-09-14T18:33:00Z',
        enable_scheduler=True
    ),
    LocalDataDomainModel(
        domain_name='sales',
        display_name='Sales data domain',
        created_at='2024-09-14T18:33:00Z',
        enable_scheduler=True
    )
]

Execution

from dqops import client
from dqops.client.api.data_domains import get_local_data_domains

token = 's4mp13_4u7h_70k3n'

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

call_result = await get_local_data_domains.asyncio(
    client=dqops_client
)
Expand to see the returned result
[
    LocalDataDomainModel(
        domain_name='sales',
        display_name='Sales data domain',
        created_at='2024-09-14T18:33:00Z',
        enable_scheduler=True
    ),
    LocalDataDomainModel(
        domain_name='sales',
        display_name='Sales data domain',
        created_at='2024-09-14T18:33:00Z',
        enable_scheduler=True
    ),
    LocalDataDomainModel(
        domain_name='sales',
        display_name='Sales data domain',
        created_at='2024-09-14T18:33:00Z',
        enable_scheduler=True
    )
]

switch_to_data_domain

Switches to a different data domain. This operation sends a special cookie and redirects the user to the home screen.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/domains/{dataDomainName}/switch

Parameters of this method are described below

 Property name   Description                       Data type   Required 
data_domain_name Data domain name string

Usage examples

Execution

curl http://localhost:8888/api/domains/crm/switch^
    -H "Accept: application/json"

Execution

from dqops import client
from dqops.client.api.data_domains import switch_to_data_domain

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

call_result = switch_to_data_domain.sync(
    'crm',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.data_domains import switch_to_data_domain

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

call_result = await switch_to_data_domain.asyncio(
    'crm',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.data_domains import switch_to_data_domain

token = 's4mp13_4u7h_70k3n'

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

call_result = switch_to_data_domain.sync(
    'crm',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.data_domains import switch_to_data_domain

token = 's4mp13_4u7h_70k3n'

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

call_result = await switch_to_data_domain.asyncio(
    'crm',
    client=dqops_client
)

synchronize_data_domains

Synchronizes the data domains in the SaaS DQOps Cloud to this instance. All data domains will be created locally.

Follow the link to see the source code on GitHub.

PATCH

http://localhost:8888/api/domains/

Usage examples

Execution

curl -X PATCH http://localhost:8888/api/domains/^
    -H "Accept: application/json"

Execution

from dqops import client
from dqops.client.api.data_domains import synchronize_data_domains

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

call_result = synchronize_data_domains.sync(
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.data_domains import synchronize_data_domains

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

call_result = await synchronize_data_domains.asyncio(
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.data_domains import synchronize_data_domains

token = 's4mp13_4u7h_70k3n'

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

call_result = synchronize_data_domains.sync(
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.data_domains import synchronize_data_domains

token = 's4mp13_4u7h_70k3n'

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

call_result = await synchronize_data_domains.asyncio(
    client=dqops_client
)








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: http://dqops.com/docs/client/operations/data_domains/

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy