All URIs are relative to http://localhost
Method | HTTP request | Description |
---|---|---|
create_entity_data_sources | POST /api/v1/entities/dataSources | Post Data Sources |
delete_entity_data_sources | DELETE /api/v1/entities/dataSources/{id} | Delete Data Source entity |
get_all_entities_data_source_identifiers | GET /api/v1/entities/dataSourceIdentifiers | Get all Data Source Identifiers |
get_all_entities_data_sources | GET /api/v1/entities/dataSources | Get Data Source entities |
get_entity_data_source_identifiers | GET /api/v1/entities/dataSourceIdentifiers/{id} | Get Data Source Identifier |
get_entity_data_sources | GET /api/v1/entities/dataSources/{id} | Get Data Source entity |
patch_entity_data_sources | PATCH /api/v1/entities/dataSources/{id} | Patch Data Source entity |
update_entity_data_sources | PUT /api/v1/entities/dataSources/{id} | Put Data Source entity |
JsonApiDataSourceOutDocument create_entity_data_sources(json_api_data_source_in_document)
Post Data Sources
Data Source - represents data source for the workspace
import time
import gooddata_api_client
from gooddata_api_client.api import data_source_entity_apis_api
from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument
from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument
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 = data_source_entity_apis_api.DataSourceEntityAPIsApi(api_client)
json_api_data_source_in_document = JsonApiDataSourceInDocument(
data=JsonApiDataSourceIn(
attributes=JsonApiDataSourceInAttributes(
cache_strategy="ALWAYS",
client_id="client_id_example",
client_secret="client_secret_example",
name="name_example",
parameters=[
JsonApiDataSourceInAttributesParametersInner(
name="name_example",
value="value_example",
),
],
password="password_example",
private_key="private_key_example",
private_key_passphrase="private_key_passphrase_example",
schema="schema_example",
token="token_example",
type="POSTGRESQL",
url="url_example",
username="username_example",
),
id="id1",
type="dataSource",
),
) # JsonApiDataSourceInDocument |
meta_include = [
"metaInclude=permissions,all",
] # [str] | Include Meta objects. (optional)
# example passing only required values which don't have defaults set
try:
# Post Data Sources
api_response = api_instance.create_entity_data_sources(json_api_data_source_in_document)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling DataSourceEntityAPIsApi->create_entity_data_sources: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Post Data Sources
api_response = api_instance.create_entity_data_sources(json_api_data_source_in_document, meta_include=meta_include)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling DataSourceEntityAPIsApi->create_entity_data_sources: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
json_api_data_source_in_document | JsonApiDataSourceInDocument | ||
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_data_sources(id)
Delete Data Source entity
Data Source - represents data source for the workspace
import time
import gooddata_api_client
from gooddata_api_client.api import data_source_entity_apis_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 = data_source_entity_apis_api.DataSourceEntityAPIsApi(api_client)
id = "/6bUUGjjNSwg0_bs" # str |
filter = "filter=name==someString;type==DatabaseTypeValue" # 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 Data Source entity
api_instance.delete_entity_data_sources(id)
except gooddata_api_client.ApiException as e:
print("Exception when calling DataSourceEntityAPIsApi->delete_entity_data_sources: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Delete Data Source entity
api_instance.delete_entity_data_sources(id, filter=filter)
except gooddata_api_client.ApiException as e:
print("Exception when calling DataSourceEntityAPIsApi->delete_entity_data_sources: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
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]
JsonApiDataSourceIdentifierOutList get_all_entities_data_source_identifiers()
Get all Data Source Identifiers
import time
import gooddata_api_client
from gooddata_api_client.api import data_source_entity_apis_api
from gooddata_api_client.model.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList
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 = data_source_entity_apis_api.DataSourceEntityAPIsApi(api_client)
filter = "filter=name==someString;schema==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)
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)
meta_include = [
"metaInclude=permissions,page,all",
] # [str] | Include Meta objects. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get all Data Source Identifiers
api_response = api_instance.get_all_entities_data_source_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling DataSourceEntityAPIsApi->get_all_entities_data_source_identifiers: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
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] |
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. |
meta_include | [str] | Include Meta objects. | [optional] |
JsonApiDataSourceIdentifierOutList
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]
JsonApiDataSourceOutList get_all_entities_data_sources()
Get Data Source entities
Data Source - represents data source for the workspace
import time
import gooddata_api_client
from gooddata_api_client.api import data_source_entity_apis_api
from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList
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 = data_source_entity_apis_api.DataSourceEntityAPIsApi(api_client)
filter = "filter=name==someString;type==DatabaseTypeValue" # 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)
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)
meta_include = [
"metaInclude=permissions,page,all",
] # [str] | Include Meta objects. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get Data Source entities
api_response = api_instance.get_all_entities_data_sources(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling DataSourceEntityAPIsApi->get_all_entities_data_sources: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
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] |
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. |
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]
JsonApiDataSourceIdentifierOutDocument get_entity_data_source_identifiers(id)
Get Data Source Identifier
import time
import gooddata_api_client
from gooddata_api_client.api import data_source_entity_apis_api
from gooddata_api_client.model.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument
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 = data_source_entity_apis_api.DataSourceEntityAPIsApi(api_client)
id = "/6bUUGjjNSwg0_bs" # str |
filter = "filter=name==someString;schema==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)
meta_include = [
"metaInclude=permissions,all",
] # [str] | Include Meta objects. (optional)
# example passing only required values which don't have defaults set
try:
# Get Data Source Identifier
api_response = api_instance.get_entity_data_source_identifiers(id)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling DataSourceEntityAPIsApi->get_entity_data_source_identifiers: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get Data Source Identifier
api_response = api_instance.get_entity_data_source_identifiers(id, filter=filter, meta_include=meta_include)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling DataSourceEntityAPIsApi->get_entity_data_source_identifiers: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
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] |
meta_include | [str] | Include Meta objects. | [optional] |
JsonApiDataSourceIdentifierOutDocument
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]
JsonApiDataSourceOutDocument get_entity_data_sources(id)
Get Data Source entity
Data Source - represents data source for the workspace
import time
import gooddata_api_client
from gooddata_api_client.api import data_source_entity_apis_api
from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument
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 = data_source_entity_apis_api.DataSourceEntityAPIsApi(api_client)
id = "/6bUUGjjNSwg0_bs" # str |
filter = "filter=name==someString;type==DatabaseTypeValue" # 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)
meta_include = [
"metaInclude=permissions,all",
] # [str] | Include Meta objects. (optional)
# example passing only required values which don't have defaults set
try:
# Get Data Source entity
api_response = api_instance.get_entity_data_sources(id)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling DataSourceEntityAPIsApi->get_entity_data_sources: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get Data Source entity
api_response = api_instance.get_entity_data_sources(id, filter=filter, meta_include=meta_include)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling DataSourceEntityAPIsApi->get_entity_data_sources: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
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] |
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]
JsonApiDataSourceOutDocument patch_entity_data_sources(id, json_api_data_source_patch_document)
Patch Data Source entity
Data Source - represents data source for the workspace
import time
import gooddata_api_client
from gooddata_api_client.api import data_source_entity_apis_api
from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument
from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument
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 = data_source_entity_apis_api.DataSourceEntityAPIsApi(api_client)
id = "/6bUUGjjNSwg0_bs" # str |
json_api_data_source_patch_document = JsonApiDataSourcePatchDocument(
data=JsonApiDataSourcePatch(
attributes=JsonApiDataSourcePatchAttributes(
cache_strategy="ALWAYS",
client_id="client_id_example",
client_secret="client_secret_example",
name="name_example",
parameters=[
JsonApiDataSourceInAttributesParametersInner(
name="name_example",
value="value_example",
),
],
password="password_example",
private_key="private_key_example",
private_key_passphrase="private_key_passphrase_example",
schema="schema_example",
token="token_example",
type="POSTGRESQL",
url="url_example",
username="username_example",
),
id="id1",
type="dataSource",
),
) # JsonApiDataSourcePatchDocument |
filter = "filter=name==someString;type==DatabaseTypeValue" # 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:
# Patch Data Source entity
api_response = api_instance.patch_entity_data_sources(id, json_api_data_source_patch_document)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling DataSourceEntityAPIsApi->patch_entity_data_sources: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Patch Data Source entity
api_response = api_instance.patch_entity_data_sources(id, json_api_data_source_patch_document, filter=filter)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling DataSourceEntityAPIsApi->patch_entity_data_sources: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | str | ||
json_api_data_source_patch_document | JsonApiDataSourcePatchDocument | ||
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] |
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]
JsonApiDataSourceOutDocument update_entity_data_sources(id, json_api_data_source_in_document)
Put Data Source entity
Data Source - represents data source for the workspace
import time
import gooddata_api_client
from gooddata_api_client.api import data_source_entity_apis_api
from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument
from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument
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 = data_source_entity_apis_api.DataSourceEntityAPIsApi(api_client)
id = "/6bUUGjjNSwg0_bs" # str |
json_api_data_source_in_document = JsonApiDataSourceInDocument(
data=JsonApiDataSourceIn(
attributes=JsonApiDataSourceInAttributes(
cache_strategy="ALWAYS",
client_id="client_id_example",
client_secret="client_secret_example",
name="name_example",
parameters=[
JsonApiDataSourceInAttributesParametersInner(
name="name_example",
value="value_example",
),
],
password="password_example",
private_key="private_key_example",
private_key_passphrase="private_key_passphrase_example",
schema="schema_example",
token="token_example",
type="POSTGRESQL",
url="url_example",
username="username_example",
),
id="id1",
type="dataSource",
),
) # JsonApiDataSourceInDocument |
filter = "filter=name==someString;type==DatabaseTypeValue" # 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:
# Put Data Source entity
api_response = api_instance.update_entity_data_sources(id, json_api_data_source_in_document)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling DataSourceEntityAPIsApi->update_entity_data_sources: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Put Data Source entity
api_response = api_instance.update_entity_data_sources(id, json_api_data_source_in_document, filter=filter)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling DataSourceEntityAPIsApi->update_entity_data_sources: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | str | ||
json_api_data_source_in_document | JsonApiDataSourceInDocument | ||
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] |
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]