gooddata_api_client.ExportDefinitionsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
create_entity_export_definitions	POST /api/v1/entities/workspaces/{workspaceId}/exportDefinitions	Post Export Definitions
delete_entity_export_definitions	DELETE /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}	Delete an Export Definition
get_all_entities_export_definitions	GET /api/v1/entities/workspaces/{workspaceId}/exportDefinitions	Get all Export Definitions
get_entity_export_definitions	GET /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}	Get an Export Definition
patch_entity_export_definitions	PATCH /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}	Patch an Export Definition
update_entity_export_definitions	PUT /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}	Put an Export Definition

create_entity_export_definitions

JsonApiExportDefinitionOutDocument create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document)

Post Export Definitions

Example

import time
import gooddata_api_client
from gooddata_api_client.api import export_definitions_api
from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument
from gooddata_api_client.model.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument
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 = export_definitions_api.ExportDefinitionsApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    json_api_export_definition_post_optional_id_document = JsonApiExportDefinitionPostOptionalIdDocument(
        data=JsonApiExportDefinitionPostOptionalId(
            attributes=JsonApiExportDefinitionInAttributes(
                are_relations_valid=True,
                description="description_example",
                request_payload=JsonApiExportDefinitionInAttributesRequestPayload(),
                tags=[
                    "tags_example",
                ],
                title="title_example",
            ),
            id="id1",
            relationships=JsonApiExportDefinitionInRelationships(
                analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard(
                    data=JsonApiAnalyticalDashboardToOneLinkage(None),
                ),
                visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject(
                    data=JsonApiVisualizationObjectToOneLinkage(None),
                ),
            ),
            type="exportDefinition",
        ),
    ) # JsonApiExportDefinitionPostOptionalIdDocument | 
    include = [
        "include=visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy",
    ] # [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 Export Definitions
        api_response = api_instance.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ExportDefinitionsApi->create_entity_export_definitions: %s\n" % e)

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

Parameters

Name	Type	Description	Notes
workspace_id	str
json_api_export_definition_post_optional_id_document	JsonApiExportDefinitionPostOptionalIdDocument
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

JsonApiExportDefinitionOutDocument

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_export_definitions

delete_entity_export_definitions(workspace_id, object_id)

Delete an Export Definition

Example

import time
import gooddata_api_client
from gooddata_api_client.api import export_definitions_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 = export_definitions_api.ExportDefinitionsApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    object_id = "objectId_example" # str | 
    filter = "filter=title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # 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 an Export Definition
        api_instance.delete_entity_export_definitions(workspace_id, object_id)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ExportDefinitionsApi->delete_entity_export_definitions: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Delete an Export Definition
        api_instance.delete_entity_export_definitions(workspace_id, object_id, filter=filter)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ExportDefinitionsApi->delete_entity_export_definitions: %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_export_definitions

JsonApiExportDefinitionOutList get_all_entities_export_definitions(workspace_id)

Get all Export Definitions

Example

import time
import gooddata_api_client
from gooddata_api_client.api import export_definitions_api
from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList
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 = export_definitions_api.ExportDefinitionsApi(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;visualizationObject.id==321;analyticalDashboard.id==321" # 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=visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy",
    ] # [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 Export Definitions
        api_response = api_instance.get_all_entities_export_definitions(workspace_id)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ExportDefinitionsApi->get_all_entities_export_definitions: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all Export Definitions
        api_response = api_instance.get_all_entities_export_definitions(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 ExportDefinitionsApi->get_all_entities_export_definitions: %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

JsonApiExportDefinitionOutList

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_export_definitions

JsonApiExportDefinitionOutDocument get_entity_export_definitions(workspace_id, object_id)

Get an Export Definition

Example

import time
import gooddata_api_client
from gooddata_api_client.api import export_definitions_api
from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument
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 = export_definitions_api.ExportDefinitionsApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    object_id = "objectId_example" # str | 
    filter = "filter=title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # 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=visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy",
    ] # [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 an Export Definition
        api_response = api_instance.get_entity_export_definitions(workspace_id, object_id)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ExportDefinitionsApi->get_entity_export_definitions: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get an Export Definition
        api_response = api_instance.get_entity_export_definitions(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 ExportDefinitionsApi->get_entity_export_definitions: %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

JsonApiExportDefinitionOutDocument

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_export_definitions

JsonApiExportDefinitionOutDocument patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document)

Patch an Export Definition

Example

import time
import gooddata_api_client
from gooddata_api_client.api import export_definitions_api
from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument
from gooddata_api_client.model.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument
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 = export_definitions_api.ExportDefinitionsApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    object_id = "objectId_example" # str | 
    json_api_export_definition_patch_document = JsonApiExportDefinitionPatchDocument(
        data=JsonApiExportDefinitionPatch(
            attributes=JsonApiExportDefinitionInAttributes(
                are_relations_valid=True,
                description="description_example",
                request_payload=JsonApiExportDefinitionInAttributesRequestPayload(),
                tags=[
                    "tags_example",
                ],
                title="title_example",
            ),
            id="id1",
            relationships=JsonApiExportDefinitionInRelationships(
                analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard(
                    data=JsonApiAnalyticalDashboardToOneLinkage(None),
                ),
                visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject(
                    data=JsonApiVisualizationObjectToOneLinkage(None),
                ),
            ),
            type="exportDefinition",
        ),
    ) # JsonApiExportDefinitionPatchDocument | 
    filter = "filter=title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # 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=visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy",
    ] # [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 an Export Definition
        api_response = api_instance.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ExportDefinitionsApi->patch_entity_export_definitions: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Patch an Export Definition
        api_response = api_instance.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document, filter=filter, include=include)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ExportDefinitionsApi->patch_entity_export_definitions: %s\n" % e)

Parameters

Name	Type	Description	Notes
workspace_id	str
object_id	str
json_api_export_definition_patch_document	JsonApiExportDefinitionPatchDocument
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

JsonApiExportDefinitionOutDocument

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_export_definitions

JsonApiExportDefinitionOutDocument update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document)

Put an Export Definition

Example

import time
import gooddata_api_client
from gooddata_api_client.api import export_definitions_api
from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument
from gooddata_api_client.model.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument
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 = export_definitions_api.ExportDefinitionsApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    object_id = "objectId_example" # str | 
    json_api_export_definition_in_document = JsonApiExportDefinitionInDocument(
        data=JsonApiExportDefinitionIn(
            attributes=JsonApiExportDefinitionInAttributes(
                are_relations_valid=True,
                description="description_example",
                request_payload=JsonApiExportDefinitionInAttributesRequestPayload(),
                tags=[
                    "tags_example",
                ],
                title="title_example",
            ),
            id="id1",
            relationships=JsonApiExportDefinitionInRelationships(
                analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard(
                    data=JsonApiAnalyticalDashboardToOneLinkage(None),
                ),
                visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject(
                    data=JsonApiVisualizationObjectToOneLinkage(None),
                ),
            ),
            type="exportDefinition",
        ),
    ) # JsonApiExportDefinitionInDocument | 
    filter = "filter=title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # 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=visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy",
    ] # [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 an Export Definition
        api_response = api_instance.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ExportDefinitionsApi->update_entity_export_definitions: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Put an Export Definition
        api_response = api_instance.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, filter=filter, include=include)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ExportDefinitionsApi->update_entity_export_definitions: %s\n" % e)

Parameters

Name	Type	Description	Notes
workspace_id	str
object_id	str
json_api_export_definition_in_document	JsonApiExportDefinitionInDocument
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

JsonApiExportDefinitionOutDocument

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

ExportDefinitionsApi.md

Latest commit

History

ExportDefinitionsApi.md

File metadata and controls

gooddata_api_client.ExportDefinitionsApi

create_entity_export_definitions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_entity_export_definitions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_all_entities_export_definitions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_entity_export_definitions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_entity_export_definitions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_entity_export_definitions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details