Skip to content

Latest commit

 

History

History
186 lines (128 loc) · 6.69 KB

WidgetsApi.md

File metadata and controls

186 lines (128 loc) · 6.69 KB
Raw

eliona.api_client2.WidgetsApi

All URIs are relative to https://name.eliona.io/v2

Method HTTP request Description
get_dashboard_widgets GET /dashboards/{dashboard-id}/widgets Information about widgets on dashboard
post_dashboard_widget POST /dashboards/{dashboard-id}/widgets Adds widget to dashboard

get_dashboard_widgets

Widget get_dashboard_widgets(dashboard_id, expansions=expansions)

Information about widgets on dashboard

Gets information about widgets on a dashboard.

Example

  • Api Key Authentication (ApiKeyAuth):
  • Bearer (JWT) Authentication (BearerAuth):
import eliona.api_client2
from eliona.api_client2.models.widget import Widget
from eliona.api_client2.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client2.Configuration(
    host = "https://name.eliona.io/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): BearerAuth
configuration = eliona.api_client2.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with eliona.api_client2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eliona.api_client2.WidgetsApi(api_client)
    dashboard_id = 4711 # int | The id of the dashboard
    expansions = ['expansions_example'] # List[str] | List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'. (optional)

    try:
        # Information about widgets on dashboard
        api_response = api_instance.get_dashboard_widgets(dashboard_id, expansions=expansions)
        print("The response of WidgetsApi->get_dashboard_widgets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WidgetsApi->get_dashboard_widgets: %s\n" % e)

Parameters

Name Type Description Notes
dashboard_id int The id of the dashboard
expansions List[str] List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'. [optional]

Return type

Widget

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successfully returned the widgets for the dashboard -
404 Dashboard with id not found -

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

post_dashboard_widget

post_dashboard_widget(dashboard_id, widget, expansions=expansions)

Adds widget to dashboard

Create a new widget and add this to a dashboard

Example

  • Api Key Authentication (ApiKeyAuth):
  • Bearer (JWT) Authentication (BearerAuth):
import eliona.api_client2
from eliona.api_client2.models.widget import Widget
from eliona.api_client2.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client2.Configuration(
    host = "https://name.eliona.io/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): BearerAuth
configuration = eliona.api_client2.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with eliona.api_client2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eliona.api_client2.WidgetsApi(api_client)
    dashboard_id = 4711 # int | The id of the dashboard
    widget = eliona.api_client2.Widget() # Widget | 
    expansions = ['expansions_example'] # List[str] | List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'. (optional)

    try:
        # Adds widget to dashboard
        api_instance.post_dashboard_widget(dashboard_id, widget, expansions=expansions)
    except Exception as e:
        print("Exception when calling WidgetsApi->post_dashboard_widget: %s\n" % e)

Parameters

Name Type Description Notes
dashboard_id int The id of the dashboard
widget Widget
expansions List[str] List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'. [optional]

Return type

void (empty response body)

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
201 Successfully added widget -
404 Dashboard with id not found -

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