Last updated: January 14, 2025

DQOps REST API labels operations

Operations that returns all labels that are assigned to data assets. Labels serve the purpose of a lazy business glossary.

---

get_all_labels_for_columns

Returns a list of all labels applied to columns, including the count of assignments to these data assets.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/labels/columns

Return value

Property name	Description	Data type
label_model		List[LabelModel]

Parameters of this method are described below

Property name	Description	Data type	Required
page	Page number, the first page is 1	long
limit	Page size, the default is 100 rows, but paging is disabled is neither page and limit parameters are provided	long
prefix	Optional filter for the prefix of labels. For example, when the prefix is "address", this operation will return labels "address/city" and "address/country", but not "address".	string
filter	Optional table name filter	string

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl http://localhost:8888/api/labels/columns^
    -H "Accept: application/json"

Expand to see the returned result

[ {
  "label" : "address/city",
  "labels_count" : 10,
  "nested_labels_count" : 2
}, {
  "label" : "address/city",
  "labels_count" : 10,
  "nested_labels_count" : 2
}, {
  "label" : "address/city",
  "labels_count" : 10,
  "nested_labels_count" : 2
} ]

Execution

from dqops import client
from dqops.client.api.labels import get_all_labels_for_columns

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

call_result = get_all_labels_for_columns.sync(
    client=dqops_client
)

Expand to see the returned result

[
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    )
]

Execution

from dqops import client
from dqops.client.api.labels import get_all_labels_for_columns

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

call_result = await get_all_labels_for_columns.asyncio(
    client=dqops_client
)

Expand to see the returned result

[
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    )
]

Execution

from dqops import client
from dqops.client.api.labels import get_all_labels_for_columns

token = 's4mp13_4u7h_70k3n'

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

call_result = get_all_labels_for_columns.sync(
    client=dqops_client
)

Expand to see the returned result

[
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    )
]

Execution

from dqops import client
from dqops.client.api.labels import get_all_labels_for_columns

token = 's4mp13_4u7h_70k3n'

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

call_result = await get_all_labels_for_columns.asyncio(
    client=dqops_client
)

Expand to see the returned result

[
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    )
]

---

get_all_labels_for_connections

Returns a list of all labels applied to the connections to data sources, including the count of assignments to these data assets.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/labels/connections

Return value

Property name	Description	Data type
label_model		List[LabelModel]

Parameters of this method are described below

Property name	Description	Data type	Required
page	Page number, the first page is 1	long
limit	Page size, the default is 100 rows, but paging is disabled is neither page and limit parameters are provided	long
prefix	Optional filter for the prefix of labels. For example, when the prefix is "address", this operation will return labels "address/city" and "address/country", but not "address".	string
filter	Optional table name filter	string

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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

Expand to see the returned result

[ {
  "label" : "address/city",
  "labels_count" : 10,
  "nested_labels_count" : 2
}, {
  "label" : "address/city",
  "labels_count" : 10,
  "nested_labels_count" : 2
}, {
  "label" : "address/city",
  "labels_count" : 10,
  "nested_labels_count" : 2
} ]

Execution

from dqops import client
from dqops.client.api.labels import get_all_labels_for_connections

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

call_result = get_all_labels_for_connections.sync(
    client=dqops_client
)

Expand to see the returned result

[
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    )
]

Execution

from dqops import client
from dqops.client.api.labels import get_all_labels_for_connections

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

call_result = await get_all_labels_for_connections.asyncio(
    client=dqops_client
)

Expand to see the returned result

[
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    )
]

Execution

from dqops import client
from dqops.client.api.labels import get_all_labels_for_connections

token = 's4mp13_4u7h_70k3n'

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

call_result = get_all_labels_for_connections.sync(
    client=dqops_client
)

Expand to see the returned result

[
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    )
]

Execution

from dqops import client
from dqops.client.api.labels import get_all_labels_for_connections

token = 's4mp13_4u7h_70k3n'

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

call_result = await get_all_labels_for_connections.asyncio(
    client=dqops_client
)

Expand to see the returned result

[
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    )
]

---

get_all_labels_for_tables

Returns a list of all labels applied to tables, including the count of assignments to these data assets.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/labels/tables

Return value

Property name	Description	Data type
label_model		List[LabelModel]

Parameters of this method are described below

Property name	Description	Data type	Required
page	Page number, the first page is 1	long
limit	Page size, the default is 100 rows, but paging is disabled is neither page and limit parameters are provided	long
prefix	Optional filter for the prefix of labels. For example, when the prefix is "address", this operation will return labels "address/city" and "address/country", but not "address".	string
filter	Optional table name filter	string

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl http://localhost:8888/api/labels/tables^
    -H "Accept: application/json"

Expand to see the returned result

[ {
  "label" : "address/city",
  "labels_count" : 10,
  "nested_labels_count" : 2
}, {
  "label" : "address/city",
  "labels_count" : 10,
  "nested_labels_count" : 2
}, {
  "label" : "address/city",
  "labels_count" : 10,
  "nested_labels_count" : 2
} ]

Execution

from dqops import client
from dqops.client.api.labels import get_all_labels_for_tables

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

call_result = get_all_labels_for_tables.sync(
    client=dqops_client
)

Expand to see the returned result

[
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    )
]

Execution

from dqops import client
from dqops.client.api.labels import get_all_labels_for_tables

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

call_result = await get_all_labels_for_tables.asyncio(
    client=dqops_client
)

Expand to see the returned result

[
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    )
]

Execution

from dqops import client
from dqops.client.api.labels import get_all_labels_for_tables

token = 's4mp13_4u7h_70k3n'

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

call_result = get_all_labels_for_tables.sync(
    client=dqops_client
)

Expand to see the returned result

[
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    )
]

Execution

from dqops import client
from dqops.client.api.labels import get_all_labels_for_tables

token = 's4mp13_4u7h_70k3n'

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

call_result = await get_all_labels_for_tables.asyncio(
    client=dqops_client
)

Expand to see the returned result

[
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    ),
    LabelModel(
        label='address/city',
        labels_count=10,
        nested_labels_count=2
    )
]