Skip to content

Latest commit

 

History

History
455 lines (310 loc) · 12.4 KB

AlertTemplateApi.md

File metadata and controls

455 lines (310 loc) · 12.4 KB
Raw

thirdeye_client.AlertTemplateApi

All URIs are relative to https://localhost

Method HTTP request Description
count_with_predicate4 GET /api/alert-templates/count
create_multiple4 POST /api/alert-templates
delete4 DELETE /api/alert-templates/{id}
delete_all4 DELETE /api/alert-templates/all
edit_multiple4 PUT /api/alert-templates
get10 GET /api/alert-templates/name/{name}
get9 GET /api/alert-templates/{id}
get_all4 GET /api/alert-templates
load_recommended_templates POST /api/alert-templates/load-defaults

count_with_predicate4

count_with_predicate4()

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.AlertTemplateApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.count_with_predicate4()
except ApiException as e:
    print("Exception when calling AlertTemplateApi->count_with_predicate4: %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]

create_multiple4

create_multiple4(body=body)

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.AlertTemplateApi(thirdeye_client.ApiClient(configuration))
body = [thirdeye_client.AlertTemplateApiModel()] # list[AlertTemplateApiModel] |  (optional)

try:
    api_instance.create_multiple4(body=body)
except ApiException as e:
    print("Exception when calling AlertTemplateApi->create_multiple4: %s\n" % e)

Parameters

Name Type Description Notes
body list[AlertTemplateApiModel] [optional]

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]

delete4

delete4(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.AlertTemplateApi(thirdeye_client.ApiClient(configuration))
id = 789 # int | 

try:
    api_instance.delete4(id)
except ApiException as e:
    print("Exception when calling AlertTemplateApi->delete4: %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]

delete_all4

delete_all4()

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.AlertTemplateApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.delete_all4()
except ApiException as e:
    print("Exception when calling AlertTemplateApi->delete_all4: %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]

edit_multiple4

edit_multiple4(body=body)

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.AlertTemplateApi(thirdeye_client.ApiClient(configuration))
body = [thirdeye_client.AlertTemplateApiModel()] # list[AlertTemplateApiModel] |  (optional)

try:
    api_instance.edit_multiple4(body=body)
except ApiException as e:
    print("Exception when calling AlertTemplateApi->edit_multiple4: %s\n" % e)

Parameters

Name Type Description Notes
body list[AlertTemplateApiModel] [optional]

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]

get10

get10(name)

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.AlertTemplateApi(thirdeye_client.ApiClient(configuration))
name = 'name_example' # str | 

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

Parameters

Name Type Description Notes
name 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]

get9

get9(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.AlertTemplateApi(thirdeye_client.ApiClient(configuration))
id = 789 # int | 

try:
    api_instance.get9(id)
except ApiException as e:
    print("Exception when calling AlertTemplateApi->get9: %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]

get_all4

get_all4()

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.AlertTemplateApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.get_all4()
except ApiException as e:
    print("Exception when calling AlertTemplateApi->get_all4: %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]

load_recommended_templates

load_recommended_templates(update_existing=update_existing)

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.AlertTemplateApi(thirdeye_client.ApiClient(configuration))
update_existing = true # bool |  (optional)

try:
    api_instance.load_recommended_templates(update_existing=update_existing)
except ApiException as e:
    print("Exception when calling AlertTemplateApi->load_recommended_templates: %s\n" % e)

Parameters

Name Type Description Notes
update_existing bool [optional]

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]