Info module

class appian_locust.info.actions_info.ActionsInfo(actions: _Actions)

Bases: object

get_action_info(action_name: str, exact_match: bool = False) → Dict[str, Any]

Get the information about specific action by name.

Parameters:

  • action_name (str) – Name of the action

  • exact_match (bool) – Should action name match exactly or to be partial match. Default : False

Returns (dict): Specific Action’s info

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

Example

If full name of action is known:

>>> action_info.get_action_info("action_name", exact_match=True)

If only the display name is known, or part of the display name:

>>> action_info.get_action_info("actio")
get_all_available_actions(locust_request_label_breadcrumb: str = 'Actions.MainMenu.AvailableActions') → Dict[str, Any]

Retrieves all the available “actions” and associated metadata from “Appian-Tempo-Actions”

Parameters:

locust_request_label_breadcrumb (str) – Base label used for each of the multiple requests made by this method

Returns (dict): List of actions and associated metadata

Examples

>>> actions_info.get_all_available_actions()
class appian_locust.info.news_info.NewsInfo(news: _News)

Bases: object

Class which provides metadata about news entries from the Tempo News tab

get_all_available_entries(search_string: str | None = None, locust_request_label: str = 'News.AllAvailableEntries') → Dict[str, Any]

Retrieves all the available “news” and associated metadata from “Appian-Tempo-News”

Parameters:

  • search_string (str, optional) – results will be filtered based on the search string.

  • locust_request_label (str) – Label locust should associate with the request

Returns (dict): List of news and associated metadata

Examples

>>> news_info.get_all()
get_news_entry(news_name: str, exact_match: bool = True, search_string: str | None = None) → Dict[str, Any]

Get the information about specific news by name.

Parameters:

  • news_name (str) – name of the news entry

  • exact_match (bool, optional) – Should news name match exactly or to be partial match. Default : True

  • search_string (str, optional) – results will be filtered based on the search string.

Returns: Specific News’s info

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

Example

If full name of action is known,

>>> news_info.get_news("news_name")

If only partial name is known,

>>> news_info.get_news("news_name", exact_match=False)
get_news_entry_record_tags(news_name: str, locust_request_label: str | None = None) → Response | None

Get the record tags associated with a news entry :param news_name: News entry ID :type news_name: str :param locust_request_label: Label locust should associate with the request for record tags :type locust_request_label: str, optional

Returns:

get_news_entry_related_records(news_name: str, exact_match: bool = True, search_string: str | None = None, locust_request_label: str | None = None) → Response | None

Request related records information for a news entry :param news_name: name of the news entry :type news_name: str :param exact_match: Should news name match exactly or to be partial match. Default : True :type exact_match: bool, optional :param search_string: results will be filtered based on the search string. :type search_string: str, optional :param locust_request_label: Label locust should associate with the request for related records :type locust_request_label: str, optional

Returns: Response object with related records information, if any exists

class appian_locust.info.records_info.RecordsInfo(records: _Records)

Bases: object

Class which provides metadata about available record types from the Tempo Records tab

get_all_available_record_types(locust_request_label: str = 'Records.MainMenu_ViewAll') → Dict[str, Any]

Get all metadata for visible record types on Tempo Records.

Returns (dict): List of record types and associated metadata

class appian_locust.info.reports_info.ReportsInfo(reports: _Reports)

Bases: object

Class which provides metadata about available reports from the Tempo Reports tab

get_all_available_reports(search_string: str | None = None, locust_request_label: str | None = None) → Dict[str, Any]

Retrieves all the available “reports” and associated metadata from “Appian-Tempo-Reports”

Returns (dict): List of reports and associated metadata

Examples

>>> reports_info.get_all_available_reports()
get_report_info(report_name: str, exact_match: bool = True) → Dict[str, Any]

Get the information about specific report by name.

Parameters:

  • report_name (str) – Name of the action

  • exact_match (bool) – Should action name match exactly or to be partial match. Default : True

Returns (dict): Specific Report’s info

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

Example

If full name of report is known:

>>> report_info.get_report_info("report_name", exact_match=True)

If only the display name is known, or part of the display name:

>>> report_info.get_report_info("report")
class appian_locust.info.sites_info.SitesInfo(sites: _Sites)

Bases: object

Class which provides metadata about available Sites

get_all_available_sites() → Dict[str, Site]

Retrieves all the available “sites” and associated metadata

Returns (dict): List of sites and associated metadata

Examples

>>> sites_info.get_all_available_sites()
get_site_info(site_name: str, exact_match: bool = True) → Site

Get the information about specific site by name.

Parameters:

site_name (str) – Name of the action

Returns (Site): Specific site’s info

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

Example

If full name of site is known:

>>> site_info.get_site_info("site_name", exact_match=True)

If only the display name is known, or part of the display name:

>>> site_info.get_site_info("site")
class appian_locust.info.tasks_info.TasksInfo(tasks: _Tasks)

Bases: object

Class which provides metadata about available tasks from the Tempo Tasks tab

get_all_available_tasks(locust_request_label: str = 'Tasks.MainMenu.GetAllAvailable') → Dict[str, Any]

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

Parameters:

locust_request_label (str) – Label locust should associate with the request

Returns (dict): List of tasks and associated metadata

Examples

>>> tasks_info.get_all_available_tasks()
get_task_info(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 action

  • exact_match (bool) – Should action 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:

>>> task_info.get_task_info("task_name", exact_match=True)

If only the display name is known, or part of the display name:

>>> task_info.get_task_info("task")