waylay.services.rules.TemplatesApi

All URIs are relative to https://api.waylay.io

Method	HTTP request	Description
create	POST /rules/v1/templates	Create Template
delete	DELETE /rules/v1/templates/{name}	Delete Template
get_discovery	GET /rules/v1/discoveryTemplate	Retrieve Discovery Template
get	GET /rules/v1/templates/{name}	Retrieve Template Details
list	GET /rules/v1/templates	List Templates
replace	PUT /rules/v1/templates/{name}	Update Template
set	PUT /rules/v1/discoveryTemplate	Set Discovery Template
upgrade_plugins	PATCH /rules/v1/templates	Upgrade Plugins

create

create( headers ) -> CreateTemplate201Response

Create Template

Create a template.

Example

from pprint import pprint

# Import the waylay-client from the waylay-sdk-core package
from waylay.sdk.client import WaylayClient
from waylay.sdk.api.api_exceptions import ApiError

# Intialize a waylay client instance
waylay_client = WaylayClient.from_profile()

# Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-rules-types` is installed
from waylay.services.rules.models.create_template201_response import CreateTemplate201Response
from waylay.services.rules.models.template_entity import TemplateEntity
try:
    # Create Template
    # calls `POST /rules/v1/templates`
    api_response = await waylay_client.rules.templates.create(
        # json data: use a generated model or a json-serializable python data structure (dict, list)
        json = waylay.services.rules.TemplateEntity() # TemplateEntity | Template Specification
    )
    print("The response of rules.templates.create:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.templates.create: %s\n" % e)

Endpoint

POST /rules/v1/templates

Parameters

Name	Type	API binding	Description	Notes
json	TemplateEntity	json request body	Template Specification
headers	HeaderTypes	request headers

Return type

Selected path param	Raw response param	Return Type	Description	Links
Literal[""] (default)	False (default)	`CreateTemplate201Response`		CreateTemplate201Response
str	False (default)	`Any`	If any other string value for the selected path is provided, the exact type of the response will only be known at runtime.
/	True	`Response`	The raw http response object.

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Template Created	* Location - URI where the created Template can be fetched
400	Validation Failed	-

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

delete

delete( name: str, headers ) -> void (empty response body)

Delete Template

Delete a template.

Example

from pprint import pprint

# Import the waylay-client from the waylay-sdk-core package
from waylay.sdk.client import WaylayClient
from waylay.sdk.api.api_exceptions import ApiError

# Intialize a waylay client instance
waylay_client = WaylayClient.from_profile()

# Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-rules-types` is installed
try:
    # Delete Template
    # calls `DELETE /rules/v1/templates/{name}`
    await waylay_client.rules.templates.delete(
        'name_example', # name | path param "name"
    )
except ApiError as e:
    print("Exception when calling rules.templates.delete: %s\n" % e)

Endpoint

DELETE /rules/v1/templates/{name}

Parameters

Name	Type	API binding	Description	Notes
name	str	path parameter `"name"`	Unique Template identifier
headers	HeaderTypes	request headers

Return type

Selected path param	Raw response param	Return Type	Description
Literal[""] (default)	False (default)	void (empty response body)
str	False (default)	`Any`	If any other string value for the selected path is provided, the exact type of the response will only be known at runtime.
/	True	`Response`	The raw http response object.

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Template Deleted	-
400	Template Still In Use	-
404	Template Not Found	-

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

get_discovery

get_discovery( headers ) -> TemplateDetails | None

Retrieve Discovery Template

Get the discovery template.

Example

from pprint import pprint

# Import the waylay-client from the waylay-sdk-core package
from waylay.sdk.client import WaylayClient
from waylay.sdk.api.api_exceptions import ApiError

# Intialize a waylay client instance
waylay_client = WaylayClient.from_profile()

# Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-rules-types` is installed
from waylay.services.rules.models.template_details import TemplateDetails
try:
    # Retrieve Discovery Template
    # calls `GET /rules/v1/discoveryTemplate`
    api_response = await waylay_client.rules.templates.get_discovery(
    )
    print("The response of rules.templates.get_discovery:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.templates.get_discovery: %s\n" % e)

Endpoint

GET /rules/v1/discoveryTemplate

Parameters

This endpoint does not need any parameter. headers | HeaderTypes | request headers | |

Return type

Selected path param	Raw response param	Return Type	Description	Links
Literal[""] (default)	False (default)	`TemplateDetails \| None`		TemplateDetails
str	False (default)	`Any`	If any other string value for the selected path is provided, the exact type of the response will only be known at runtime.
/	True	`Response`	The raw http response object.

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Discovery Template Details	-
204	No Discovery Template	-

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

get

get( name: str, query: GetQuery, headers ) -> TemplateDetails

Retrieve Template Details

Retrieve the details of a template.

Example

from pprint import pprint

# Import the waylay-client from the waylay-sdk-core package
from waylay.sdk.client import WaylayClient
from waylay.sdk.api.api_exceptions import ApiError

# Intialize a waylay client instance
waylay_client = WaylayClient.from_profile()

# Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-rules-types` is installed
from waylay.services.rules.models.list_tasks_format_parameter import ListTasksFormatParameter
from waylay.services.rules.models.template_details import TemplateDetails
try:
    # Retrieve Template Details
    # calls `GET /rules/v1/templates/{name}`
    api_response = await waylay_client.rules.templates.get(
        'name_example', # name | path param "name"
        # query parameters:
        query = {
        },
    )
    print("The response of rules.templates.get:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.templates.get: %s\n" % e)

Endpoint

GET /rules/v1/templates/{name}

Parameters

Name	Type	API binding	Description	Notes
name	str	path parameter `"name"`	Unique Template identifier
query	QueryParamTypes \| None	URL query parameter
query['format'] (dict) query.format (Query)	ListTasksFormatParameter	query parameter `"format"`	Format of the graph definition	[optional] [default bn]
headers	HeaderTypes	request headers

Return type

Selected path param	Raw response param	Return Type	Description	Links
Literal[""] (default)	False (default)	`TemplateDetails`		TemplateDetails
str	False (default)	`Any`	If any other string value for the selected path is provided, the exact type of the response will only be known at runtime.
/	True	`Response`	The raw http response object.

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Template Details	-
404	Template Not Found	-

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

list

list( query: ListQuery, headers ) -> List[TemplateEntityMetadata]

List Templates

Query templates.

Example

from pprint import pprint

# Import the waylay-client from the waylay-sdk-core package
from waylay.sdk.client import WaylayClient
from waylay.sdk.api.api_exceptions import ApiError

# Intialize a waylay client instance
waylay_client = WaylayClient.from_profile()

# Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-rules-types` is installed
from waylay.services.rules.models.template_entity_metadata import TemplateEntityMetadata
try:
    # List Templates
    # calls `GET /rules/v1/templates`
    api_response = await waylay_client.rules.templates.list(
        # query parameters:
        query = {
            'id': 'id_example'
            'plugin': 'mySensor:1.0.3'
            'tags.X': 'tags.myref: 3904859080956'
        },
    )
    print("The response of rules.templates.list:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.templates.list: %s\n" % e)

Endpoint

GET /rules/v1/templates

Parameters

Name	Type	API binding	Description	Notes
query	QueryParamTypes \| None	URL query parameter
query['hits'] (dict) query.hits (Query)	int	query parameter `"hits"`	(Paging) maximal number of items returned	[optional] [default 10]
query['startIndex'] (dict) query.start_index (Query)	int	query parameter `"startIndex"`	(Paging) items to skip in the listing	[optional] [default 0]
query['filter'] (dict) query.filter (Query)	str	query parameter `"filter"`	fuzzy search on multiple properties	[optional]
query['ids'] (dict) query.ids (Query)	List[str]	query parameter `"ids"`	comma separated string of template names	[optional]
query['id'] (dict) query.id (Query)	str	query parameter `"id"`	filter on template name	[optional]
query['plugin'] (dict) query.plugin (Query)	str	query parameter `"plugin"`	either name of a plugin (e.g. `mySensor`), or full version specification of the plug (e.g `mySensor:1.0.3`)	[optional]
query['tags.X'] (dict) query.tags_x (Query)	str	query parameter `"tags.X"`		[optional]
headers	HeaderTypes	request headers

Return type

Selected path param	Raw response param	Return Type	Description	Links
Literal[""] (default)	False (default)	`List[TemplateEntityMetadata]`		List[TemplateEntityMetadata]
str	False (default)	`Any`	If any other string value for the selected path is provided, the exact type of the response will only be known at runtime.
/	True	`Response`	The raw http response object.

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	* X-Count - Total number of templates that fulfill the query.

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

replace

replace( name: str, headers ) -> ReplaceTemplate200Response

Update Template

Update a template. Note that this will not update any tasks using the template. You will need to do a batch reload operation on the tasks to accomplish that.

Example

from pprint import pprint

# Import the waylay-client from the waylay-sdk-core package
from waylay.sdk.client import WaylayClient
from waylay.sdk.api.api_exceptions import ApiError

# Intialize a waylay client instance
waylay_client = WaylayClient.from_profile()

# Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-rules-types` is installed
from waylay.services.rules.models.replace_template200_response import ReplaceTemplate200Response
from waylay.services.rules.models.template_entity import TemplateEntity
try:
    # Update Template
    # calls `PUT /rules/v1/templates/{name}`
    api_response = await waylay_client.rules.templates.replace(
        'name_example', # name | path param "name"
        # json data: use a generated model or a json-serializable python data structure (dict, list)
        json = waylay.services.rules.TemplateEntity() # TemplateEntity | Template Specification
    )
    print("The response of rules.templates.replace:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.templates.replace: %s\n" % e)

Endpoint

PUT /rules/v1/templates/{name}

Parameters

Name	Type	API binding	Description
name	str	path parameter `"name"`	Unique Template identifier
json	TemplateEntity	json request body	Template Specification
headers	HeaderTypes	request headers

Return type

Selected path param	Raw response param	Return Type	Description	Links
Literal[""] (default)	False (default)	`ReplaceTemplate200Response`		ReplaceTemplate200Response
str	False (default)	`Any`	If any other string value for the selected path is provided, the exact type of the response will only be known at runtime.
/	True	`Response`	The raw http response object.

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Template Updated	-
400	Validation Failed	-
404	Template Not Found	-

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

set

set( query: SetQuery, headers ) -> TemplateDetails | None

Set Discovery Template

Set the discovery template.

Example

from pprint import pprint

# Import the waylay-client from the waylay-sdk-core package
from waylay.sdk.client import WaylayClient
from waylay.sdk.api.api_exceptions import ApiError

# Intialize a waylay client instance
waylay_client = WaylayClient.from_profile()

# Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-rules-types` is installed
from waylay.services.rules.models.template_details import TemplateDetails
try:
    # Set Discovery Template
    # calls `PUT /rules/v1/discoveryTemplate`
    api_response = await waylay_client.rules.templates.set(
        # query parameters:
        query = {
            'name': 'discoverResourceType'
        },
    )
    print("The response of rules.templates.set:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.templates.set: %s\n" % e)

Endpoint

PUT /rules/v1/discoveryTemplate

Parameters

Name	Type	API binding	Description	Notes
query	QueryParamTypes \| None	URL query parameter
query['name'] (dict) query.name (Query)	str	query parameter `"name"`	The template to set as discovery template. If you do not specify this parameter, the current discovery template will be cleared.	[optional]
headers	HeaderTypes	request headers

Return type

Selected path param	Raw response param	Return Type	Description	Links
Literal[""] (default)	False (default)	`TemplateDetails \| None`		TemplateDetails
str	False (default)	`Any`	If any other string value for the selected path is provided, the exact type of the response will only be known at runtime.
/	True	`Response`	The raw http response object.

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Discovery Template Set	-
204	Discovery Template Cleared	-
404	Template Not Found	-

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

upgrade_plugins

upgrade_plugins( query: UpgradePluginsQuery, headers ) -> UpgradePluginsTemplates200Response

Upgrade Plugins

Upgrade plugins on multiple templates. The plugin upgrades specified in the body will be applied to all template that fullfil the query expresses by the query parameters. At least one of the query parameters must be specified.

Example

from pprint import pprint

# Import the waylay-client from the waylay-sdk-core package
from waylay.sdk.client import WaylayClient
from waylay.sdk.api.api_exceptions import ApiError

# Intialize a waylay client instance
waylay_client = WaylayClient.from_profile()

# Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-rules-types` is installed
from waylay.services.rules.models.template_modification import TemplateModification
from waylay.services.rules.models.upgrade_plugins_templates200_response import UpgradePluginsTemplates200Response
try:
    # Upgrade Plugins
    # calls `PATCH /rules/v1/templates`
    api_response = await waylay_client.rules.templates.upgrade_plugins(
        # query parameters:
        query = {
            'id': 'id_example'
            'plugin': '{\"plugin\":\"mySensor:1.0.3\"}'
        },
        # json data: use a generated model or a json-serializable python data structure (dict, list)
        json = waylay.services.rules.TemplateModification() # TemplateModification | Plugin Update Specifications
    )
    print("The response of rules.templates.upgrade_plugins:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.templates.upgrade_plugins: %s\n" % e)

Endpoint

PATCH /rules/v1/templates

Parameters

Name	Type	API binding	Description	Notes
json	TemplateModification	json request body	Plugin Update Specifications
query	QueryParamTypes \| None	URL query parameter
query['ids'] (dict) query.ids (Query)	List[str]	query parameter `"ids"`	comma separated string of template names	[optional]
query['id'] (dict) query.id (Query)	str	query parameter `"id"`	filter on template name	[optional]
query['plugin'] (dict) query.plugin (Query)	str	query parameter `"plugin"`	either name of a plugin (e.g. `mySensor`), or full version specification of the plug (e.g `mySensor:1.0.3`)	[optional]
query['tags.X'] (dict) query.tags_x (Query)	str	query parameter `"tags.X"`		[optional]
headers	HeaderTypes	request headers

Return type

Selected path param	Raw response param	Return Type	Description	Links
Literal[""] (default)	False (default)	`UpgradePluginsTemplates200Response`		UpgradePluginsTemplates200Response
str	False (default)	`Any`	If any other string value for the selected path is provided, the exact type of the response will only be known at runtime.
/	True	`Response`	The raw http response object.

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully Updated	-
400	Unsuccessful	-

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

Files

TemplatesApi.md

Latest commit

History

TemplatesApi.md

File metadata and controls

waylay.services.rules.TemplatesApi

create

Example

Endpoint

Parameters

Return type

HTTP request headers

HTTP response details

delete

Example

Endpoint

Parameters

Return type

HTTP request headers

HTTP response details

get_discovery

Example

Endpoint

Parameters

Return type

HTTP request headers

HTTP response details

get

Example

Endpoint

Parameters

Return type

HTTP request headers

HTTP response details

list

Example

Endpoint

Parameters

Return type

HTTP request headers

HTTP response details

replace

Example

Endpoint

Parameters

Return type

HTTP request headers

HTTP response details

set

Example

Endpoint

Parameters

Return type

HTTP request headers

HTTP response details

upgrade_plugins

Example

Endpoint

Parameters

Return type

HTTP request headers

HTTP response details