_tasks¶

class appian_locust._tasks._Tasks(interactor: appian_locust._interactor._Interactor)¶

INITIAL_FEED_URI = '/suite/api/feed/tempo?m=menu-tasks&t=t&s=pt&defaultFacets=%255Bstatus-open%255D'¶

get_all(search_string: str = None, locust_request_label: str = 'Tasks') → Dict[str, Any]¶

Retrieves all the available “tasks” and associated metadata from “Appian-Tempo-Tasks”

Note: All the retrieved data about tasks is stored in the private variable self._tasks

Returns (dict): List of tasks and associated metadata

Examples

>>> self.appian.task.get_all()

get_task(task_name: str, exact_match: bool = True) → Dict[str, Any]¶

Get the information about specific task by name.

Parameters

task_name (str) – Name of the task
exact_match (bool) – Should task name match exactly or to be partial match. Default : True

Returns (dict): Specific task’s info

Raises: In case of task is not found in the system, it throws an “Exception”

Example

If full name of task is known,

>>> self.appian.task.get("task_name")

If only partial name is known,

>>> self.appian.task.get("task_name", exact_match=False)

visit(task_name: str, exact_match: bool = True) → Dict[str, Any]¶

This function calls the API for the specific task to get its “form” data

Parameters

task_name (str) – Name of the task to be called.
exact_match (bool, optional) – Should task name match exactly or to be partial match. Default : True

Returns (dict): Response of task’s Get UI call in dictionary

Examples

If full name of task is known,

>>> self.appian.task.visit("task_name")

If only partial name is known,

>>> self.appian.task.visit("task_name", exact_match=False)

visit_and_get_form(task_name: str, exact_match: bool = True, locust_request_label: str = '') → appian_locust.uiform.SailUiForm ¶

Gets the SailUiForm given a task name

Parameters

task_name (str) – Name of the task to search for
exact_match (bool, optional) – Whether or not a full match is returned. Defaults to True.
locust_request_label (str, optional) – label to be used within locust

Returns

SAIL form for the task

Return type

SailUiForm