waylay.services.rules.TasksApi

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

Method	HTTP request	Description
create	POST /rules/v1/tasks	Create Task
delete	DELETE /rules/v1/tasks/{taskId}	Delete Task
get_configuration	GET /rules/v1/tasks/{taskId}/conf	Get Task Configuration
get	GET /rules/v1/tasks/{taskId}	Retrieve Task Details
list	GET /rules/v1/tasks	Query Multiple Tasks
replace	PUT /rules/v1/tasks/{taskId}	Update Task
start	POST /rules/v1/tasks/{taskId}/command/start	Start Task
stop	POST /rules/v1/tasks/{taskId}/command/stop	Stop Task

create

create( query: CreateQuery, headers ) -> CreateTask201Response

Create Task

Create a new task.

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_task201_response import CreateTask201Response
from waylay.services.rules.models.task_specification import TaskSpecification
try:
    # Create Task
    # calls `POST /rules/v1/tasks`
    api_response = await waylay_client.rules.tasks.create(
        # query parameters:
        query = {
            'failOnWarning': False
            'returnWarnings': False
        },
        # json data: use a generated model or a json-serializable python data structure (dict, list)
        json = waylay.services.rules.TaskSpecification() # TaskSpecification | Task Specification
    )
    print("The response of rules.tasks.create:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.tasks.create: %s\n" % e)

Endpoint

POST /rules/v1/tasks

Parameters

Name	Type	API binding	Description	Notes
json	TaskSpecification	json request body	Task Specification
query	QueryParamTypes \| None	URL query parameter
query['failOnWarning'] (dict) query.fail_on_warning (Query)	bool	query parameter `"failOnWarning"`	If `true` and there are task warnings, the response will be a `400 Validation failed`	[optional] [default False]
query['returnWarnings'] (dict) query.return_warnings (Query)	bool	query parameter `"returnWarnings"`	If `true`, result body will contain a list of task warnings that where detected	[optional] [default False]
headers	HeaderTypes	request headers

Return type

Selected path param	Raw response param	Return Type	Description	Links
Literal[""] (default)	False (default)	`CreateTask201Response`		CreateTask201Response
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	Task Created	* Location - URI where the created Template can be fetched
400	Validation Error	-

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

delete

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

Delete Task

Delete a task.

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 Task
    # calls `DELETE /rules/v1/tasks/{taskId}`
    await waylay_client.rules.tasks.delete(
        'task_id_example', # task_id | path param "taskId"
    )
except ApiError as e:
    print("Exception when calling rules.tasks.delete: %s\n" % e)

Endpoint

DELETE /rules/v1/tasks/{taskId}

Parameters

Name	Type	API binding	Description	Notes
task_id	str	path parameter `"taskId"`	Unique Task 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	Task Deleted	-
400	Error Response	-

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

get_configuration

get_configuration( task_id: str, query: GetConfigurationQuery, headers ) -> TaskSpecification

Get Task Configuration

Getting the configuration of an existing task.

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.task_specification import TaskSpecification
try:
    # Get Task Configuration
    # calls `GET /rules/v1/tasks/{taskId}/conf`
    api_response = await waylay_client.rules.tasks.get_configuration(
        'task_id_example', # task_id | path param "taskId"
        # query parameters:
        query = {
        },
    )
    print("The response of rules.tasks.get_configuration:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.tasks.get_configuration: %s\n" % e)

Endpoint

GET /rules/v1/tasks/{taskId}/conf

Parameters

Name	Type	API binding	Description	Notes
task_id	str	path parameter `"taskId"`	Unique Task 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)	`TaskSpecification`		TaskSpecification
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	Task Configuration	-
404	Task Not Found	-

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

get

get( task_id: str, query: GetQuery, headers ) -> TaskListingInner

Retrieve Task Details

Retrieve the details of a task.

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.task_listing_inner import TaskListingInner
try:
    # Retrieve Task Details
    # calls `GET /rules/v1/tasks/{taskId}`
    api_response = await waylay_client.rules.tasks.get(
        'task_id_example', # task_id | path param "taskId"
        # query parameters:
        query = {
        },
    )
    print("The response of rules.tasks.get:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.tasks.get: %s\n" % e)

Endpoint

GET /rules/v1/tasks/{taskId}

Parameters

Name	Type	API binding	Description	Notes
task_id	str	path parameter `"taskId"`	Unique Task 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)	`TaskListingInner`		TaskListingInner
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	Task Details	-
404	Task Not Found	-

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

list

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

Query Multiple Tasks

Query multiple tasks.

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.task_listing_inner import TaskListingInner
from waylay.services.rules.models.task_scenario_type import TaskScenarioType
from waylay.services.rules.models.task_status import TaskStatus
try:
    # Query Multiple Tasks
    # calls `GET /rules/v1/tasks`
    api_response = await waylay_client.rules.tasks.list(
        # query parameters:
        query = {
            'resource': 'resource_example'
            'resourceType': 'resource_type_example'
            'type': 'scheduled'
            'status': 'running'
            'id': 'id_example'
            'tags.key': 3904859080956
            'finishedBefore': 56
            'createdAfter': 1661990400000
            'createdBefore': 1662768000000
            'includeHealth': False
        },
    )
    print("The response of rules.tasks.list:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.tasks.list: %s\n" % e)

Endpoint

GET /rules/v1/tasks

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['format'] (dict) query.format (Query)	ListTasksFormatParameter	query parameter `"format"`	Format of the graph definition	[optional] [default bn]
query['name'] (dict) query.name (Query)	str	query parameter `"name"`		[optional]
query['resource'] (dict) query.resource (Query)	str	query parameter `"resource"`		[optional]
query['resourceType'] (dict) query.resource_type (Query)	str	query parameter `"resourceType"`		[optional]
query['type'] (dict) query.type (Query)	TaskScenarioType	query parameter `"type"`		[optional]
query['status'] (dict) query.status (Query)	TaskStatus	query parameter `"status"`		[optional]
query['ids'] (dict) query.ids (Query)	List[str]	query parameter `"ids"`		[optional]
query['id'] (dict) query.id (Query)	str	query parameter `"id"`		[optional]
query['plugin'] (dict) query.plugin (Query)	str	query parameter `"plugin"`		[optional]
query['template'] (dict) query.template (Query)	str	query parameter `"template"`		[optional]
query['filter'] (dict) query.filter (Query)	str	query parameter `"filter"`	fuzzy search on multiple properties	[optional]
query['tags.key'] (dict) query.tags_key (Query)	ListTasksTagsKeyParameter	query parameter `"tags.key"`	Parameter is `form` style serialized, with explode: true See Query multiple tasks tag examples You can add the same tag query parameter multiple times with different values, which will be applied with a logical OR. You can specify the `tags.<key>` query parameter without a value, tasks which have a value for tag `<key>` will be returned	[optional]
query['tags'] (dict) query.tags (Query)	List[str]	query parameter `"tags"`	Filter tasks that have one of the tag keys in the array	[optional]
query['finishedBefore'] (dict) query.finished_before (Query)	int	query parameter `"finishedBefore"`	Tasks stopped before provided time will be returned.	[optional]
query['createdAfter'] (dict) query.created_after (Query)	int	query parameter `"createdAfter"`	Tasks created after provided time will be returned.	[optional]
query['createdBefore'] (dict) query.created_before (Query)	int	query parameter `"createdBefore"`	Tasks created before provided time will be returned	[optional]
query['includeHealth'] (dict) query.include_health (Query)	bool	query parameter `"includeHealth"`	If `true`, the response will include the health status of the task. The health status is a summary of the errorsCount and errorsRate of the last 64 invocations of the task.	[optional] [default False]
headers	HeaderTypes	request headers

Return type

Selected path param	Raw response param	Return Type	Description	Links
Literal[""] (default)	False (default)	`List[TaskListingInner]`		List[TaskListingInner]
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, application/vnd.waylay.paged+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( task_id: str, headers ) -> TaskEntity

Update Task

Update a task. Remark that the full specification of the task must be given

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.task_entity import TaskEntity
from waylay.services.rules.models.task_specification import TaskSpecification
try:
    # Update Task
    # calls `PUT /rules/v1/tasks/{taskId}`
    api_response = await waylay_client.rules.tasks.replace(
        'task_id_example', # task_id | path param "taskId"
        # json data: use a generated model or a json-serializable python data structure (dict, list)
        json = waylay.services.rules.TaskSpecification() # TaskSpecification | Task Specification
    )
    print("The response of rules.tasks.replace:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.tasks.replace: %s\n" % e)

Endpoint

PUT /rules/v1/tasks/{taskId}

Parameters

Name	Type	API binding	Description
task_id	str	path parameter `"taskId"`	Unique Task identifier
json	TaskSpecification	json request body	Task Specification
headers	HeaderTypes	request headers

Return type

Selected path param	Raw response param	Return Type	Description	Links
Literal[""] (default)	False (default)	`TaskEntity`		TaskEntity
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	Task Updated	-
400	Validation Error	-
404	Task Not Found	-

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

start

start( task_id: str, headers ) -> TaskEntity

Start Task

Start a task.

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.task_entity import TaskEntity
try:
    # Start Task
    # calls `POST /rules/v1/tasks/{taskId}/command/start`
    api_response = await waylay_client.rules.tasks.start(
        'task_id_example', # task_id | path param "taskId"
    )
    print("The response of rules.tasks.start:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.tasks.start: %s\n" % e)

Endpoint

POST /rules/v1/tasks/{taskId}/command/start

Parameters

Name	Type	API binding	Description	Notes
task_id	str	path parameter `"taskId"`	Unique Task identifier
headers	HeaderTypes	request headers

Return type

Selected path param	Raw response param	Return Type	Description	Links
Literal[""] (default)	False (default)	`TaskEntity`		TaskEntity
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	Task Started	-
400	Task Cannot Be Started	-
404	Task Not Found	-

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

stop

stop( task_id: str, headers ) -> TaskEntity

Stop Task

Stop a task.

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.task_entity import TaskEntity
try:
    # Stop Task
    # calls `POST /rules/v1/tasks/{taskId}/command/stop`
    api_response = await waylay_client.rules.tasks.stop(
        'task_id_example', # task_id | path param "taskId"
    )
    print("The response of rules.tasks.stop:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.tasks.stop: %s\n" % e)

Endpoint

POST /rules/v1/tasks/{taskId}/command/stop

Parameters

Name	Type	API binding	Description	Notes
task_id	str	path parameter `"taskId"`	Unique Task identifier
headers	HeaderTypes	request headers

Return type

Selected path param	Raw response param	Return Type	Description	Links
Literal[""] (default)	False (default)	`TaskEntity`		TaskEntity
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	Task Stopped	-
400	Task Cannot Be Stopped	-
404	Task Not Found	-

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

Files

TasksApi.md

Latest commit

History

TasksApi.md

File metadata and controls

waylay.services.rules.TasksApi

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_configuration

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

start

Example

Endpoint

Parameters

Return type

HTTP request headers

HTTP response details

stop

Example

Endpoint

Parameters

Return type

HTTP request headers

HTTP response details