This documentation is for the unstable version of GoodData, currrently in development.
For stable version, go to the latest stable version of this article.
For stable version, go to the latest stable version of this article.
CatalogWorkspaceContentService.
get_label_elements
get_label_elements(workspace_id: str, label_id: str, depends_on: Optional[list[DependsOnItem]], validate_by: Optional[list[CatalogValidateByItem]], exact_filter: Optional[list[str]], filter_by: Optional[CatalogFilterBy], pattern_filter: Optional[str], complement_filter: Optional[bool], sort_order: Optional[Literal["ASC", "DESC"]], offset: Optional[int], limit: Optional[int]) ->
list[str]
Get existing values for a label.
Under-the-hood, it basically executes SELECT DISTINCT
Parameters
name | type | description |
---|---|---|
workspace_id | str | Workspace identification string e.g. "demo". |
label_id | str | Label ID. We support string or ObjId types. String may not contain "label/" prefix, we append it if necessary. |
depends_on | Optional[list[DependsOnItem]] | Optional parameter specifying dependencies on other labels or date filters. |
validate_by | Optional[list[CatalogValidateByItem]] | Optional parameter specifying validation metrics, attributes, labels or facts. |
exact_filter | Optional[list[str]] | Optional parameter specifying exact filter values. |
filter_by | Optional[CatalogFilterBy] | Optional parameter specifying which label is used for filtering - primary or requested. If omitted the server will use the default value of "REQUESTED" |
pattern_filter | Optional[str] | Optional parameter specifying pattern filter: matching the elements using case-insensitive substring match. |
complement_filter | Optional[bool] | Optional parameter specifying whether to negate the filter in exact_filter and pattern_filter. |
sort_order | Optional[Literal["ASC", "DESC"]] | Optional parameter specifying the sort order for the returned values. |
offset | Optional[int] | Optional parameter specifying the offset for the returned values. |
limit | Optional[int] | Optional parameter specifying the limit for the returned values. |
Returns
type | description |
---|---|
list of label values |