Skip to content
This repository was archived by the owner on Oct 11, 2026. It is now read-only.

Latest commit

 

History

History
208 lines (141 loc) · 5.47 KB

EntityApi.md

File metadata and controls

208 lines (141 loc) · 5.47 KB

thirdeye_client.EntityApi

All URIs are relative to https://localhost

Method HTTP request Description
get_entity GET /api/entities/types/{bean_class}
get_entity_info GET /api/entities/types/{bean_class}/info
get_raw_entity GET /api/entities/{id}
list_entities GET /api/entities/types

get_entity

get_entity(bean_class)

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.EntityApi(thirdeye_client.ApiClient(configuration))
bean_class = 'bean_class_example' # str | 

try:
    api_instance.get_entity(bean_class)
except ApiException as e:
    print("Exception when calling EntityApi->get_entity: %s\n" % e)

Parameters

Name Type Description Notes
bean_class str

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

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

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

get_entity_info

get_entity_info(bean_class)

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.EntityApi(thirdeye_client.ApiClient(configuration))
bean_class = 'bean_class_example' # str | 

try:
    api_instance.get_entity_info(bean_class)
except ApiException as e:
    print("Exception when calling EntityApi->get_entity_info: %s\n" % e)

Parameters

Name Type Description Notes
bean_class str

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

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

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

get_raw_entity

get_raw_entity(id)

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.EntityApi(thirdeye_client.ApiClient(configuration))
id = 789 # int | 

try:
    api_instance.get_raw_entity(id)
except ApiException as e:
    print("Exception when calling EntityApi->get_raw_entity: %s\n" % e)

Parameters

Name Type Description Notes
id int

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

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

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

list_entities

list_entities()

Example

from __future__ import print_function
import time
import thirdeye_client
from thirdeye_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: oauth
configuration = thirdeye_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = thirdeye_client.EntityApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.list_entities()
except ApiException as e:
    print("Exception when calling EntityApi->list_entities: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

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

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