Skip to content

Risk Indicator Categories

class _incydr_sdk.risk_indicator_categories.client.RiskIndicatorCategoriesV1(parent)

Client for /v1/risk-indicator-categories endpoints.

Usage example:

>>> import incydr
>>> client = incydr.Client(**kwargs)
>>> client.risk_indicators.v1.list_categories()
get_category(self, id)

Returns a single risk indicator category, including its subcategories and associated risk indicators.

Parameters:

  • id: str - The unique ID of the category you wish to retrieve.

Returns: A RiskIndicatorCategory object.

get_subcategory(self, category_id, subcategory_id)

Returns a single risk indicator category, including its subcategories and associated risk indicators.

Parameters:

  • category_id: str - The unique ID of the category in which the subcategory lives.
  • subcategory_id: str - The unique ID of the subcategory you wish to retrieve.

Returns: A RiskIndicatorSubcategory object.

list_categories(self, active=None, sort_direction=None)

Returns all risk indicator categories, including their subcategories and associated risk indicators. Filter results by passing the appropriate parameters:

Parameters:

  • active: bool - When provided, returns only those risk indicators which match the provided value (true or false). When not provided, returns both.
  • sort_direction: SortDirection - The order in which to sort the returned list.

Returns: A RiskIndicatorCategoriesResponsePage object.