DashletApi.md

clientapi_atrocore.DashletApi

All URIs are relative to https://demo.atropim.com/api/v1

Method	HTTP request	Description
get_dashlet_data	GET /Dashlet/{dashletName}	Get Dashlet data

get_dashlet_data

GetLinkedItemsForAccountItem200Response get_dashlet_data(dashlet_name)

Get Dashlet data

Get Dashlet data

Example

• Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_linked_items_for_account_item200_response import GetLinkedItemsForAccountItem200Response
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# 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: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.DashletApi(api_client)
    dashlet_name = 'dashlet_name_example' # str | 

    try:
        # Get Dashlet data
        api_response = api_instance.get_dashlet_data(dashlet_name)
        print("The response of DashletApi->get_dashlet_data:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DashletApi->get_dashlet_data: %s\n" % e)

Parameters

Name	Type	Description	Notes
dashlet_name	str

Return type

GetLinkedItemsForAccountItem200Response

Authorization

Authorization-Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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