All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| create_entity_automations | POST /api/v1/entities/workspaces/{workspaceId}/automations | Post Automations |
| delete_entity_automations | DELETE /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Delete an Automation |
| get_all_entities_automations | GET /api/v1/entities/workspaces/{workspaceId}/automations | Get all Automations |
| get_automations | GET /api/v1/layout/workspaces/{workspaceId}/automations | Get automations |
| get_entity_automations | GET /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Get an Automation |
| patch_entity_automations | PATCH /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation |
| set_automations | PUT /api/v1/layout/workspaces/{workspaceId}/automations | Set automations |
| trigger_automation | POST /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation. |
| trigger_existing_automation | POST /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation. |
| update_entity_automations | PUT /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Put an Automation |
JsonApiAutomationOutDocument create_entity_automations(workspace_id, json_api_automation_in_document)
Post Automations
import time
import gooddata_api_client
from gooddata_api_client.api import automations_api
from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument
from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument
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 = automations_api.AutomationsApi(api_client)
workspace_id = "workspaceId_example" # str |
json_api_automation_in_document = JsonApiAutomationInDocument(
data=JsonApiAutomationIn(
attributes=JsonApiAutomationInAttributes(
alert=JsonApiAutomationInAttributesAlert(
condition=AlertCondition(),
execution=AlertAfm(
attributes=[
AttributeItem(
label=AfmObjectIdentifierLabel(
identifier=AfmObjectIdentifierLabelIdentifier(
id="sample_item.price",
type="label",
),
),
local_identifier="attribute_1",
show_all_values=False,
),
],
aux_measures=[
MeasureItem(
definition=MeasureDefinition(),
local_identifier="metric_1",
),
],
filters=[
FilterDefinition(),
],
measures=[
MeasureItem(
definition=MeasureDefinition(),
local_identifier="metric_1",
),
],
),
trigger="ALWAYS",
),
are_relations_valid=True,
description="description_example",
details=None,
external_recipients=[
JsonApiAutomationInAttributesExternalRecipientsInner(
email="email_example",
),
],
metadata=JsonApiAutomationInAttributesMetadata(
visible_filters=[
VisibleFilter(
local_identifier="local_identifier_example",
title="title_example",
),
],
widget="widget_example",
),
schedule=JsonApiAutomationInAttributesSchedule(
cron="0 */30 9-17 ? * MON-FRI",
first_run=dateutil_parser('2025-01-01T12:00:00Z'),
timezone="Europe/Prague",
),
state="ACTIVE",
tabular_exports=[
JsonApiAutomationInAttributesTabularExportsInner(
request_payload=TabularExportRequest(
custom_override=CustomOverride(
labels={
"key": CustomLabel(
title="title_example",
),
},
metrics={
"key": CustomMetric(
format="format_example",
title="title_example",
),
},
),
execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4",
file_name="result",
format="CSV",
metadata=JsonNode(),
related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0",
settings=Settings(
merge_headers=True,
pdf_page_size="a4 landscape",
pdf_table_style=[
PdfTableStyle(
properties=[
PdfTableStyleProperty(
key="key_example",
value="value_example",
),
],
selector="selector_example",
),
],
pdf_top_left_content="Good",
pdf_top_right_content="Morning",
show_filters=False,
),
visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537",
visualization_object_custom_filters=[
{},
],
),
),
],
tags=[
"tags_example",
],
title="title_example",
visual_exports=[
JsonApiAutomationInAttributesVisualExportsInner(
request_payload=VisualExportRequest(
dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0",
file_name="filename",
metadata={},
),
),
],
),
id="id1",
relationships=JsonApiAutomationInRelationships(
analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard(
data=JsonApiAnalyticalDashboardToOneLinkage(None),
),
export_definitions=JsonApiAutomationInRelationshipsExportDefinitions(
data=JsonApiExportDefinitionToManyLinkage([
JsonApiExportDefinitionLinkage(
id="id_example",
type="exportDefinition",
),
]),
),
notification_channel=JsonApiAutomationInRelationshipsNotificationChannel(
data=JsonApiNotificationChannelToOneLinkage(None),
),
recipients=JsonApiAutomationInRelationshipsRecipients(
data=JsonApiUserToManyLinkage([
JsonApiUserLinkage(
id="id_example",
type="user",
),
]),
),
),
type="automation",
),
) # JsonApiAutomationInDocument |
include = [
"include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients",
] # [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 Automations
api_response = api_instance.create_entity_automations(workspace_id, json_api_automation_in_document)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling AutomationsApi->create_entity_automations: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Post Automations
api_response = api_instance.create_entity_automations(workspace_id, json_api_automation_in_document, include=include, meta_include=meta_include)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling AutomationsApi->create_entity_automations: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| workspace_id | str | ||
| json_api_automation_in_document | JsonApiAutomationInDocument | ||
| 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] |
No authorization required
- Content-Type: application/vnd.gooddata.api+json
- Accept: application/vnd.gooddata.api+json
| 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_automations(workspace_id, object_id)
Delete an Automation
import time
import gooddata_api_client
from gooddata_api_client.api import automations_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 = automations_api.AutomationsApi(api_client)
workspace_id = "workspaceId_example" # str |
object_id = "objectId_example" # str |
filter = "filter=title==someString;description==someString;notificationChannel.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 Automation
api_instance.delete_entity_automations(workspace_id, object_id)
except gooddata_api_client.ApiException as e:
print("Exception when calling AutomationsApi->delete_entity_automations: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Delete an Automation
api_instance.delete_entity_automations(workspace_id, object_id, filter=filter)
except gooddata_api_client.ApiException as e:
print("Exception when calling AutomationsApi->delete_entity_automations: %s\n" % e)| 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] |
void (empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | Successfully deleted | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JsonApiAutomationOutList get_all_entities_automations(workspace_id)
Get all Automations
import time
import gooddata_api_client
from gooddata_api_client.api import automations_api
from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList
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 = automations_api.AutomationsApi(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;notificationChannel.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=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients",
] # [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 Automations
api_response = api_instance.get_all_entities_automations(workspace_id)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling AutomationsApi->get_all_entities_automations: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get all Automations
api_response = api_instance.get_all_entities_automations(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 AutomationsApi->get_all_entities_automations: %s\n" % e)| 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] |
No authorization required
- Content-Type: Not defined
- Accept: application/vnd.gooddata.api+json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successfully processed | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[DeclarativeAutomation] get_automations(workspace_id)
Get automations
Retrieve automations for the specific workspace
import time
import gooddata_api_client
from gooddata_api_client.api import automations_api
from gooddata_api_client.model.declarative_automation import DeclarativeAutomation
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 = automations_api.AutomationsApi(api_client)
workspace_id = "workspaceId_example" # str |
exclude = [
"ACTIVITY_INFO",
] # [str] | (optional)
# example passing only required values which don't have defaults set
try:
# Get automations
api_response = api_instance.get_automations(workspace_id)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling AutomationsApi->get_automations: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get automations
api_response = api_instance.get_automations(workspace_id, exclude=exclude)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling AutomationsApi->get_automations: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| workspace_id | str | ||
| exclude | [str] | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Retrieved automations. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JsonApiAutomationOutDocument get_entity_automations(workspace_id, object_id)
Get an Automation
import time
import gooddata_api_client
from gooddata_api_client.api import automations_api
from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument
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 = automations_api.AutomationsApi(api_client)
workspace_id = "workspaceId_example" # str |
object_id = "objectId_example" # str |
filter = "filter=title==someString;description==someString;notificationChannel.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=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients",
] # [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 Automation
api_response = api_instance.get_entity_automations(workspace_id, object_id)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling AutomationsApi->get_entity_automations: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get an Automation
api_response = api_instance.get_entity_automations(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 AutomationsApi->get_entity_automations: %s\n" % e)| 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] |
No authorization required
- Content-Type: Not defined
- Accept: application/vnd.gooddata.api+json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successfully processed | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JsonApiAutomationOutDocument patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document)
Patch an Automation
import time
import gooddata_api_client
from gooddata_api_client.api import automations_api
from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument
from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument
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 = automations_api.AutomationsApi(api_client)
workspace_id = "workspaceId_example" # str |
object_id = "objectId_example" # str |
json_api_automation_patch_document = JsonApiAutomationPatchDocument(
data=JsonApiAutomationPatch(
attributes=JsonApiAutomationInAttributes(
alert=JsonApiAutomationInAttributesAlert(
condition=AlertCondition(),
execution=AlertAfm(
attributes=[
AttributeItem(
label=AfmObjectIdentifierLabel(
identifier=AfmObjectIdentifierLabelIdentifier(
id="sample_item.price",
type="label",
),
),
local_identifier="attribute_1",
show_all_values=False,
),
],
aux_measures=[
MeasureItem(
definition=MeasureDefinition(),
local_identifier="metric_1",
),
],
filters=[
FilterDefinition(),
],
measures=[
MeasureItem(
definition=MeasureDefinition(),
local_identifier="metric_1",
),
],
),
trigger="ALWAYS",
),
are_relations_valid=True,
description="description_example",
details=None,
external_recipients=[
JsonApiAutomationInAttributesExternalRecipientsInner(
email="email_example",
),
],
metadata=JsonApiAutomationInAttributesMetadata(
visible_filters=[
VisibleFilter(
local_identifier="local_identifier_example",
title="title_example",
),
],
widget="widget_example",
),
schedule=JsonApiAutomationInAttributesSchedule(
cron="0 */30 9-17 ? * MON-FRI",
first_run=dateutil_parser('2025-01-01T12:00:00Z'),
timezone="Europe/Prague",
),
state="ACTIVE",
tabular_exports=[
JsonApiAutomationInAttributesTabularExportsInner(
request_payload=TabularExportRequest(
custom_override=CustomOverride(
labels={
"key": CustomLabel(
title="title_example",
),
},
metrics={
"key": CustomMetric(
format="format_example",
title="title_example",
),
},
),
execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4",
file_name="result",
format="CSV",
metadata=JsonNode(),
related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0",
settings=Settings(
merge_headers=True,
pdf_page_size="a4 landscape",
pdf_table_style=[
PdfTableStyle(
properties=[
PdfTableStyleProperty(
key="key_example",
value="value_example",
),
],
selector="selector_example",
),
],
pdf_top_left_content="Good",
pdf_top_right_content="Morning",
show_filters=False,
),
visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537",
visualization_object_custom_filters=[
{},
],
),
),
],
tags=[
"tags_example",
],
title="title_example",
visual_exports=[
JsonApiAutomationInAttributesVisualExportsInner(
request_payload=VisualExportRequest(
dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0",
file_name="filename",
metadata={},
),
),
],
),
id="id1",
relationships=JsonApiAutomationInRelationships(
analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard(
data=JsonApiAnalyticalDashboardToOneLinkage(None),
),
export_definitions=JsonApiAutomationInRelationshipsExportDefinitions(
data=JsonApiExportDefinitionToManyLinkage([
JsonApiExportDefinitionLinkage(
id="id_example",
type="exportDefinition",
),
]),
),
notification_channel=JsonApiAutomationInRelationshipsNotificationChannel(
data=JsonApiNotificationChannelToOneLinkage(None),
),
recipients=JsonApiAutomationInRelationshipsRecipients(
data=JsonApiUserToManyLinkage([
JsonApiUserLinkage(
id="id_example",
type="user",
),
]),
),
),
type="automation",
),
) # JsonApiAutomationPatchDocument |
filter = "filter=title==someString;description==someString;notificationChannel.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=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients",
] # [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 Automation
api_response = api_instance.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling AutomationsApi->patch_entity_automations: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Patch an Automation
api_response = api_instance.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, filter=filter, include=include)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling AutomationsApi->patch_entity_automations: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| workspace_id | str | ||
| object_id | str | ||
| json_api_automation_patch_document | JsonApiAutomationPatchDocument | ||
| 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] |
No authorization required
- Content-Type: application/vnd.gooddata.api+json
- Accept: application/vnd.gooddata.api+json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successfully processed | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
set_automations(workspace_id, declarative_automation)
Set automations
Set automations for the specific workspace.
import time
import gooddata_api_client
from gooddata_api_client.api import automations_api
from gooddata_api_client.model.declarative_automation import DeclarativeAutomation
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 = automations_api.AutomationsApi(api_client)
workspace_id = "workspaceId_example" # str |
declarative_automation = [
DeclarativeAutomation(
alert=AutomationAlert(
condition=AutomationAlertCondition(None),
execution=AlertAfm(
attributes=[
AttributeItem(
label=AfmObjectIdentifierLabel(
identifier=AfmObjectIdentifierLabelIdentifier(
id="sample_item.price",
type="label",
),
),
local_identifier="attribute_1",
show_all_values=False,
),
],
aux_measures=[
MeasureItem(
definition=MeasureDefinition(),
local_identifier="metric_1",
),
],
filters=[
FilterDefinition(),
],
measures=[
MeasureItem(
definition=MeasureDefinition(),
local_identifier="metric_1",
),
],
),
trigger="ALWAYS",
),
analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier(
id="dashboard123",
type="analyticalDashboard",
),
created_at="2023-07-20 12:30",
created_by=DeclarativeUserIdentifier(
id="employee123",
type="user",
),
description="description_example",
details={
"key": "key_example",
},
export_definitions=[
DeclarativeExportDefinitionIdentifier(
id="export123",
type="exportDefinition",
),
],
external_recipients=[
AutomationExternalRecipient(
email="email_example",
),
],
id="/6bUUGjjNSwg0_bs",
metadata=AutomationMetadata(
visible_filters=[
VisibleFilter(
local_identifier="local_identifier_example",
title="title_example",
),
],
widget="widget_example",
),
modified_at="2023-07-20 12:30",
modified_by=DeclarativeUserIdentifier(
id="employee123",
type="user",
),
notification_channel=DeclarativeNotificationChannelIdentifier(
id="webhook123",
type="notificationChannel",
),
recipients=[
DeclarativeUserIdentifier(
id="employee123",
type="user",
),
],
schedule=AutomationSchedule(
cron="0 */30 9-17 ? * MON-FRI",
first_run=dateutil_parser('2025-01-01T12:00:00Z'),
timezone="Europe/Prague",
),
state="ACTIVE",
tabular_exports=[
AutomationTabularExport(
request_payload=TabularExportRequest(
custom_override=CustomOverride(
labels={
"key": CustomLabel(
title="title_example",
),
},
metrics={
"key": CustomMetric(
format="format_example",
title="title_example",
),
},
),
execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4",
file_name="result",
format="CSV",
metadata=JsonNode(),
related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0",
settings=Settings(
merge_headers=True,
pdf_page_size="a4 landscape",
pdf_table_style=[
PdfTableStyle(
properties=[
PdfTableStyleProperty(
key="key_example",
value="value_example",
),
],
selector="selector_example",
),
],
pdf_top_left_content="Good",
pdf_top_right_content="Morning",
show_filters=False,
),
visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537",
visualization_object_custom_filters=[
{},
],
),
),
],
tags=[
"["Revenue","Sales"]",
],
title="title_example",
visual_exports=[
AutomationVisualExport(
request_payload=VisualExportRequest(
dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0",
file_name="filename",
metadata={},
),
),
],
),
] # [DeclarativeAutomation] |
# example passing only required values which don't have defaults set
try:
# Set automations
api_instance.set_automations(workspace_id, declarative_automation)
except gooddata_api_client.ApiException as e:
print("Exception when calling AutomationsApi->set_automations: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| workspace_id | str | ||
| declarative_automation | [DeclarativeAutomation] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | Automations successfully set. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
trigger_automation(workspace_id, trigger_automation_request)
Trigger automation.
Trigger the automation in the request.
import time
import gooddata_api_client
from gooddata_api_client.api import automations_api
from gooddata_api_client.model.trigger_automation_request import TriggerAutomationRequest
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 = automations_api.AutomationsApi(api_client)
workspace_id = "workspaceId_example" # str |
trigger_automation_request = TriggerAutomationRequest(
automation=AdHocAutomation(
analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier(
id="dashboard123",
type="analyticalDashboard",
),
description="description_example",
details={
"key": "key_example",
},
external_recipients=[
AutomationExternalRecipient(
email="email_example",
),
],
metadata=AutomationMetadata(
visible_filters=[
VisibleFilter(
local_identifier="local_identifier_example",
title="title_example",
),
],
widget="widget_example",
),
notification_channel=DeclarativeNotificationChannelIdentifier(
id="webhook123",
type="notificationChannel",
),
recipients=[
DeclarativeUserIdentifier(
id="employee123",
type="user",
),
],
tabular_exports=[
AutomationTabularExport(
request_payload=TabularExportRequest(
custom_override=CustomOverride(
labels={
"key": CustomLabel(
title="title_example",
),
},
metrics={
"key": CustomMetric(
format="format_example",
title="title_example",
),
},
),
execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4",
file_name="result",
format="CSV",
metadata=JsonNode(),
related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0",
settings=Settings(
merge_headers=True,
pdf_page_size="a4 landscape",
pdf_table_style=[
PdfTableStyle(
properties=[
PdfTableStyleProperty(
key="key_example",
value="value_example",
),
],
selector="selector_example",
),
],
pdf_top_left_content="Good",
pdf_top_right_content="Morning",
show_filters=False,
),
visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537",
visualization_object_custom_filters=[
{},
],
),
),
],
tags=["Revenue","Sales"],
title="title_example",
visual_exports=[
AutomationVisualExport(
request_payload=VisualExportRequest(
dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0",
file_name="filename",
metadata={},
),
),
],
),
) # TriggerAutomationRequest |
# example passing only required values which don't have defaults set
try:
# Trigger automation.
api_instance.trigger_automation(workspace_id, trigger_automation_request)
except gooddata_api_client.ApiException as e:
print("Exception when calling AutomationsApi->trigger_automation: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| workspace_id | str | ||
| trigger_automation_request | TriggerAutomationRequest |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | The automation is successfully triggered. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
trigger_existing_automation(workspace_id, automation_id)
Trigger existing automation.
Trigger the existing automation to execute immediately.
import time
import gooddata_api_client
from gooddata_api_client.api import automations_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 = automations_api.AutomationsApi(api_client)
workspace_id = "workspaceId_example" # str |
automation_id = "automationId_example" # str |
# example passing only required values which don't have defaults set
try:
# Trigger existing automation.
api_instance.trigger_existing_automation(workspace_id, automation_id)
except gooddata_api_client.ApiException as e:
print("Exception when calling AutomationsApi->trigger_existing_automation: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| workspace_id | str | ||
| automation_id | str |
void (empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | The automation is successfully triggered. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JsonApiAutomationOutDocument update_entity_automations(workspace_id, object_id, json_api_automation_in_document)
Put an Automation
import time
import gooddata_api_client
from gooddata_api_client.api import automations_api
from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument
from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument
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 = automations_api.AutomationsApi(api_client)
workspace_id = "workspaceId_example" # str |
object_id = "objectId_example" # str |
json_api_automation_in_document = JsonApiAutomationInDocument(
data=JsonApiAutomationIn(
attributes=JsonApiAutomationInAttributes(
alert=JsonApiAutomationInAttributesAlert(
condition=AlertCondition(),
execution=AlertAfm(
attributes=[
AttributeItem(
label=AfmObjectIdentifierLabel(
identifier=AfmObjectIdentifierLabelIdentifier(
id="sample_item.price",
type="label",
),
),
local_identifier="attribute_1",
show_all_values=False,
),
],
aux_measures=[
MeasureItem(
definition=MeasureDefinition(),
local_identifier="metric_1",
),
],
filters=[
FilterDefinition(),
],
measures=[
MeasureItem(
definition=MeasureDefinition(),
local_identifier="metric_1",
),
],
),
trigger="ALWAYS",
),
are_relations_valid=True,
description="description_example",
details=None,
external_recipients=[
JsonApiAutomationInAttributesExternalRecipientsInner(
email="email_example",
),
],
metadata=JsonApiAutomationInAttributesMetadata(
visible_filters=[
VisibleFilter(
local_identifier="local_identifier_example",
title="title_example",
),
],
widget="widget_example",
),
schedule=JsonApiAutomationInAttributesSchedule(
cron="0 */30 9-17 ? * MON-FRI",
first_run=dateutil_parser('2025-01-01T12:00:00Z'),
timezone="Europe/Prague",
),
state="ACTIVE",
tabular_exports=[
JsonApiAutomationInAttributesTabularExportsInner(
request_payload=TabularExportRequest(
custom_override=CustomOverride(
labels={
"key": CustomLabel(
title="title_example",
),
},
metrics={
"key": CustomMetric(
format="format_example",
title="title_example",
),
},
),
execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4",
file_name="result",
format="CSV",
metadata=JsonNode(),
related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0",
settings=Settings(
merge_headers=True,
pdf_page_size="a4 landscape",
pdf_table_style=[
PdfTableStyle(
properties=[
PdfTableStyleProperty(
key="key_example",
value="value_example",
),
],
selector="selector_example",
),
],
pdf_top_left_content="Good",
pdf_top_right_content="Morning",
show_filters=False,
),
visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537",
visualization_object_custom_filters=[
{},
],
),
),
],
tags=[
"tags_example",
],
title="title_example",
visual_exports=[
JsonApiAutomationInAttributesVisualExportsInner(
request_payload=VisualExportRequest(
dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0",
file_name="filename",
metadata={},
),
),
],
),
id="id1",
relationships=JsonApiAutomationInRelationships(
analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard(
data=JsonApiAnalyticalDashboardToOneLinkage(None),
),
export_definitions=JsonApiAutomationInRelationshipsExportDefinitions(
data=JsonApiExportDefinitionToManyLinkage([
JsonApiExportDefinitionLinkage(
id="id_example",
type="exportDefinition",
),
]),
),
notification_channel=JsonApiAutomationInRelationshipsNotificationChannel(
data=JsonApiNotificationChannelToOneLinkage(None),
),
recipients=JsonApiAutomationInRelationshipsRecipients(
data=JsonApiUserToManyLinkage([
JsonApiUserLinkage(
id="id_example",
type="user",
),
]),
),
),
type="automation",
),
) # JsonApiAutomationInDocument |
filter = "filter=title==someString;description==someString;notificationChannel.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=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients",
] # [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 Automation
api_response = api_instance.update_entity_automations(workspace_id, object_id, json_api_automation_in_document)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling AutomationsApi->update_entity_automations: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Put an Automation
api_response = api_instance.update_entity_automations(workspace_id, object_id, json_api_automation_in_document, filter=filter, include=include)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling AutomationsApi->update_entity_automations: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| workspace_id | str | ||
| object_id | str | ||
| json_api_automation_in_document | JsonApiAutomationInDocument | ||
| 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] |
No authorization required
- Content-Type: application/vnd.gooddata.api+json
- Accept: application/vnd.gooddata.api+json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Request successfully processed | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]