gooddata_api_client.ContextFiltersApi

All URIs are relative to http://localhost

Method	HTTP request	Description
create_entity_filter_contexts	POST /api/v1/entities/workspaces/{workspaceId}/filterContexts	Post Context Filters
delete_entity_filter_contexts	DELETE /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}	Delete a Context Filter
get_all_entities_filter_contexts	GET /api/v1/entities/workspaces/{workspaceId}/filterContexts	Get all Context Filters
get_entity_filter_contexts	GET /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}	Get a Context Filter
patch_entity_filter_contexts	PATCH /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}	Patch a Context Filter
update_entity_filter_contexts	PUT /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}	Put a Context Filter

create_entity_filter_contexts

JsonApiFilterContextOutDocument create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document)

Post Context Filters

Example

import time
import gooddata_api_client
from gooddata_api_client.api import context_filters_api
from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument
from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = context_filters_api.ContextFiltersApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    json_api_filter_context_post_optional_id_document = JsonApiFilterContextPostOptionalIdDocument(
        data=JsonApiFilterContextPostOptionalId(
            attributes=JsonApiAnalyticalDashboardInAttributes(
                are_relations_valid=True,
                content={},
                description="description_example",
                tags=[
                    "tags_example",
                ],
                title="title_example",
            ),
            id="id1",
            type="filterContext",
        ),
    ) # JsonApiFilterContextPostOptionalIdDocument | 
    include = [
        "include=attributes,datasets,labels",
    ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).  __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional)
    meta_include = [
        "metaInclude=origin,all",
    ] # [str] | Include Meta objects. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Post Context Filters
        api_response = api_instance.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ContextFiltersApi->create_entity_filter_contexts: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Post Context Filters
        api_response = api_instance.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, include=include, meta_include=meta_include)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ContextFiltersApi->create_entity_filter_contexts: %s\n" % e)

Parameters

Name	Type	Description	Notes
workspace_id	str
json_api_filter_context_post_optional_id_document	JsonApiFilterContextPostOptionalIdDocument
include	[str]	Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL). WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.	[optional]
meta_include	[str]	Include Meta objects.	[optional]

Return type

JsonApiFilterContextOutDocument

Authorization

No authorization required

HTTP request headers

Content-Type: application/vnd.gooddata.api+json
Accept: application/vnd.gooddata.api+json

HTTP response details

Status code	Description	Response headers
201	Request successfully processed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_entity_filter_contexts

delete_entity_filter_contexts(workspace_id, object_id)

Delete a Context Filter

Example

import time
import gooddata_api_client
from gooddata_api_client.api import context_filters_api
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = context_filters_api.ContextFiltersApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    object_id = "objectId_example" # str | 
    filter = "filter=title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional)

    # example passing only required values which don't have defaults set
    try:
        # Delete a Context Filter
        api_instance.delete_entity_filter_contexts(workspace_id, object_id)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ContextFiltersApi->delete_entity_filter_contexts: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Delete a Context Filter
        api_instance.delete_entity_filter_contexts(workspace_id, object_id, filter=filter)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ContextFiltersApi->delete_entity_filter_contexts: %s\n" % e)

Parameters

Name	Type	Description	Notes
workspace_id	str
object_id	str
filter	str	Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Successfully deleted	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_entities_filter_contexts

JsonApiFilterContextOutList get_all_entities_filter_contexts(workspace_id)

Get all Context Filters

Example

import time
import gooddata_api_client
from gooddata_api_client.api import context_filters_api
from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = context_filters_api.ContextFiltersApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    origin = "ALL" # str |  (optional) if omitted the server will use the default value of "ALL"
    filter = "filter=title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional)
    include = [
        "include=attributes,datasets,labels",
    ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).  __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional)
    page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0
    size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20
    sort = [
        "sort_example",
    ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional)
    x_gdc_validate_relations = False # bool |  (optional) if omitted the server will use the default value of False
    meta_include = [
        "metaInclude=origin,page,all",
    ] # [str] | Include Meta objects. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all Context Filters
        api_response = api_instance.get_all_entities_filter_contexts(workspace_id)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ContextFiltersApi->get_all_entities_filter_contexts: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all Context Filters
        api_response = api_instance.get_all_entities_filter_contexts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ContextFiltersApi->get_all_entities_filter_contexts: %s\n" % e)

Parameters

Name	Type	Description	Notes
workspace_id	str
origin	str		[optional] if omitted the server will use the default value of "ALL"
filter	str	Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').	[optional]
include	[str]	Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL). WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.	[optional]
page	int	Zero-based page index (0..N)	[optional] if omitted the server will use the default value of 0
size	int	The size of the page to be returned	[optional] if omitted the server will use the default value of 20
sort	[str]	Sorting criteria in the format: property,(asc	desc). Default sort order is ascending. Multiple sort criteria are supported.
x_gdc_validate_relations	bool		[optional] if omitted the server will use the default value of False
meta_include	[str]	Include Meta objects.	[optional]

Return type

JsonApiFilterContextOutList

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.gooddata.api+json

HTTP response details

Status code	Description	Response headers
200	Request successfully processed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_entity_filter_contexts

JsonApiFilterContextOutDocument get_entity_filter_contexts(workspace_id, object_id)

Get a Context Filter

Example

import time
import gooddata_api_client
from gooddata_api_client.api import context_filters_api
from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = context_filters_api.ContextFiltersApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    object_id = "objectId_example" # str | 
    filter = "filter=title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional)
    include = [
        "include=attributes,datasets,labels",
    ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).  __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional)
    x_gdc_validate_relations = False # bool |  (optional) if omitted the server will use the default value of False
    meta_include = [
        "metaInclude=origin,all",
    ] # [str] | Include Meta objects. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get a Context Filter
        api_response = api_instance.get_entity_filter_contexts(workspace_id, object_id)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ContextFiltersApi->get_entity_filter_contexts: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get a Context Filter
        api_response = api_instance.get_entity_filter_contexts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ContextFiltersApi->get_entity_filter_contexts: %s\n" % e)

Parameters

Name	Type	Description	Notes
workspace_id	str
object_id	str
filter	str	Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').	[optional]
include	[str]	Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL). WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.	[optional]
x_gdc_validate_relations	bool		[optional] if omitted the server will use the default value of False
meta_include	[str]	Include Meta objects.	[optional]

Return type

JsonApiFilterContextOutDocument

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.gooddata.api+json

HTTP response details

Status code	Description	Response headers
200	Request successfully processed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patch_entity_filter_contexts

JsonApiFilterContextOutDocument patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document)

Patch a Context Filter

Example

import time
import gooddata_api_client
from gooddata_api_client.api import context_filters_api
from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument
from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = context_filters_api.ContextFiltersApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    object_id = "objectId_example" # str | 
    json_api_filter_context_patch_document = JsonApiFilterContextPatchDocument(
        data=JsonApiFilterContextPatch(
            attributes=JsonApiAnalyticalDashboardPatchAttributes(
                are_relations_valid=True,
                content={},
                description="description_example",
                tags=[
                    "tags_example",
                ],
                title="title_example",
            ),
            id="id1",
            type="filterContext",
        ),
    ) # JsonApiFilterContextPatchDocument | 
    filter = "filter=title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional)
    include = [
        "include=attributes,datasets,labels",
    ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).  __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Patch a Context Filter
        api_response = api_instance.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ContextFiltersApi->patch_entity_filter_contexts: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Patch a Context Filter
        api_response = api_instance.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, filter=filter, include=include)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ContextFiltersApi->patch_entity_filter_contexts: %s\n" % e)

Parameters

Name	Type	Description	Notes
workspace_id	str
object_id	str
json_api_filter_context_patch_document	JsonApiFilterContextPatchDocument
filter	str	Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').	[optional]
include	[str]	Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL). WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.	[optional]

Return type

JsonApiFilterContextOutDocument

Authorization

No authorization required

HTTP request headers

Content-Type: application/vnd.gooddata.api+json
Accept: application/vnd.gooddata.api+json

HTTP response details

Status code	Description	Response headers
200	Request successfully processed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_entity_filter_contexts

JsonApiFilterContextOutDocument update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document)

Put a Context Filter

Example

import time
import gooddata_api_client
from gooddata_api_client.api import context_filters_api
from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument
from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = context_filters_api.ContextFiltersApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    object_id = "objectId_example" # str | 
    json_api_filter_context_in_document = JsonApiFilterContextInDocument(
        data=JsonApiFilterContextIn(
            attributes=JsonApiAnalyticalDashboardInAttributes(
                are_relations_valid=True,
                content={},
                description="description_example",
                tags=[
                    "tags_example",
                ],
                title="title_example",
            ),
            id="id1",
            type="filterContext",
        ),
    ) # JsonApiFilterContextInDocument | 
    filter = "filter=title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional)
    include = [
        "include=attributes,datasets,labels",
    ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).  __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Put a Context Filter
        api_response = api_instance.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ContextFiltersApi->update_entity_filter_contexts: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Put a Context Filter
        api_response = api_instance.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, filter=filter, include=include)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ContextFiltersApi->update_entity_filter_contexts: %s\n" % e)

Parameters

Name	Type	Description	Notes
workspace_id	str
object_id	str
json_api_filter_context_in_document	JsonApiFilterContextInDocument
filter	str	Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').	[optional]
include	[str]	Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL). WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.	[optional]

Return type

JsonApiFilterContextOutDocument

Authorization

No authorization required

HTTP request headers

Content-Type: application/vnd.gooddata.api+json
Accept: application/vnd.gooddata.api+json

HTTP response details

Status code	Description	Response headers
200	Request successfully processed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ContextFiltersApi.md

Latest commit

History

ContextFiltersApi.md

File metadata and controls

gooddata_api_client.ContextFiltersApi

create_entity_filter_contexts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_entity_filter_contexts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_all_entities_filter_contexts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_entity_filter_contexts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_entity_filter_contexts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_entity_filter_contexts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details