waylay.services.rules.TaskNodesApi

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

Method	HTTP request	Description
get_states	GET /rules/v1/tasks/{taskId}/nodes/{nodeId}/states	Get Supported States
get	GET /rules/v1/tasks/{taskId}/nodes/{nodeId}	Get Current States
patch	PATCH /rules/v1/tasks/{taskId}/nodes/{nodeId}	Set Node State
post	POST /rules/v1/tasks/callback	Finalize Asynchronous Execution With Token
update	POST /rules/v1/tasks/{taskId}/nodes/{nodeId}	Set Current State

get_states

get_states( task_id: str, node_id: str, headers ) -> object

Get Supported States

Get the supported states of a node. #### visibility This definition has visibility status deprecated.

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:
    # Get Supported States
    # calls `GET /rules/v1/tasks/{taskId}/nodes/{nodeId}/states`
    api_response = await waylay_client.rules.task_nodes.get_states(
        'task_id_example', # task_id | path param "taskId"
        'node_id_example', # node_id | path param "nodeId"
    )
    print("The response of rules.task_nodes.get_states:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.task_nodes.get_states: %s\n" % e)

Endpoint

GET /rules/v1/tasks/{taskId}/nodes/{nodeId}/states

Parameters

Name	Type	API binding	Description
task_id	str	path parameter `"taskId"`	Unique Task identifier
node_id	str	path parameter `"nodeId"`	Unique node label
headers	HeaderTypes	request headers

Return type

Selected path param	Raw response param	Return Type	Description
Literal[""] (default)	False (default)	`object`
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	-

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

get

get( task_id: str, node_id: str, headers ) -> object

Get Current States

Get current states (posteriors) and raw data of the node. #### visibility This definition has visibility status deprecated.

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:
    # Get Current States
    # calls `GET /rules/v1/tasks/{taskId}/nodes/{nodeId}`
    api_response = await waylay_client.rules.task_nodes.get(
        'task_id_example', # task_id | path param "taskId"
        'node_id_example', # node_id | path param "nodeId"
    )
    print("The response of rules.task_nodes.get:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.task_nodes.get: %s\n" % e)

Endpoint

GET /rules/v1/tasks/{taskId}/nodes/{nodeId}

Parameters

Name	Type	API binding	Description
task_id	str	path parameter `"taskId"`	Unique Task identifier
node_id	str	path parameter `"nodeId"`	Unique node label
headers	HeaderTypes	request headers

Return type

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

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

patch

patch( task_id: str, node_id: str, headers ) -> object

Set Node State

Set the current state and rawData for the node. This can only be done for a running 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.node_state_specification import NodeStateSpecification
try:
    # Set Node State
    # calls `PATCH /rules/v1/tasks/{taskId}/nodes/{nodeId}`
    api_response = await waylay_client.rules.task_nodes.patch(
        'task_id_example', # task_id | path param "taskId"
        'node_id_example', # node_id | path param "nodeId"
        # json data: use a generated model or a json-serializable python data structure (dict, list)
        json = waylay.services.rules.NodeStateSpecification() # NodeStateSpecification | 
    )
    print("The response of rules.task_nodes.patch:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.task_nodes.patch: %s\n" % e)

Endpoint

PATCH /rules/v1/tasks/{taskId}/nodes/{nodeId}

Parameters

Name	Type	API binding	Description
task_id	str	path parameter `"taskId"`	Unique Task identifier
node_id	str	path parameter `"nodeId"`	Unique node label
json	NodeStateSpecification	json request body
headers	HeaderTypes	request headers

Return type

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

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

post

post( query: PostQuery, headers ) -> object

Finalize Asynchronous Execution With Token

Post a result to finalize an asynchronous plugin execution using the onetime token from the callback url.

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:
    # Finalize Asynchronous Execution With Token
    # calls `POST /rules/v1/tasks/callback`
    api_response = await waylay_client.rules.task_nodes.post(
        # query parameters:
        query = {
        },
        # non-json binary data: use a byte array or a generator of bytearray chuncks
        content=b'my-binary-data',
        # this operation supports multiple request content types: use `headers` to specify the one used
        # alternatives: 
        headers = {
            'content-type': 'application/octet-stream'
        },
    )
    print("The response of rules.task_nodes.post:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.task_nodes.post: %s\n" % e)

Endpoint

POST /rules/v1/tasks/callback

Parameters

Name	Type	API binding	Description	Notes
content	ContentRequest	binary request body	Callback result to be passed to the plugin	[optional]
query	QueryParamTypes \| None	URL query parameter
query['access_token'] (dict) query.access_token (Query)	str	query parameter `"access_token"`	Token that was given in the callback url
headers	HeaderTypes	request headers
headers['content-type']	str	content type	request header `"content-type"`	should match mediaType `application/octet-stream`

Return type

Selected path param	Raw response param	Return Type	Description
Literal[""] (default)	False (default)	`object`
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/octet-stream
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
403	Invalid Token	-

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

update

update( task_id: str, node_id: str, headers ) -> object

Set Current State

Set the current state of the node. This call is deprecated. Please use PATCH /rules/v1/tasks/{taskId}/nodes/{nodeId} #### visibility This definition has visibility status deprecated.

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:
    # Set Current State
    # calls `POST /rules/v1/tasks/{taskId}/nodes/{nodeId}`
    api_response = await waylay_client.rules.task_nodes.update(
        'task_id_example', # task_id | path param "taskId"
        'node_id_example', # node_id | path param "nodeId"
        # non-json binary data: use a byte array or a generator of bytearray chuncks
        content=b'my-binary-data',
        # this operation supports multiple request content types: use `headers` to specify the one used
        # alternatives: 
        headers = {
            'content-type': 'text/plain'
        },
    )
    print("The response of rules.task_nodes.update:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.task_nodes.update: %s\n" % e)

Endpoint

POST /rules/v1/tasks/{taskId}/nodes/{nodeId}

Parameters

Name	Type	API binding	Description	Notes
task_id	str	path parameter `"taskId"`	Unique Task identifier
node_id	str	path parameter `"nodeId"`	Unique node label
content	ContentRequest	binary request body	Command string to apply to a node of a task.
headers	HeaderTypes	request headers
headers['content-type']	str	content type	request header `"content-type"`	should match mediaType `text/plain`

Return type

Selected path param	Raw response param	Return Type	Description
Literal[""] (default)	False (default)	`object`
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: text/plain
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

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

Files

TaskNodesApi.md

Latest commit

History

TaskNodesApi.md

File metadata and controls

waylay.services.rules.TaskNodesApi

get_states

Example

Endpoint

Parameters

Return type

HTTP request headers

HTTP response details

get

Example

Endpoint

Parameters

Return type

HTTP request headers

HTTP response details

patch

Example

Endpoint

Parameters

Return type

HTTP request headers

HTTP response details

post

Example

Endpoint

Parameters

Return type

HTTP request headers

HTTP response details

update

Example

Endpoint

Parameters

Return type

HTTP request headers

HTTP response details