Skip to content

Hive.cookbook.anomalies

Anomalies

Bases: ApiManager

Class that handles all the XAutomata anomalies APIs

Source code in hive/cookbook/anomalies.py
class Anomalies(ApiManager):
    """Class that handles all the XAutomata anomalies APIs"""

    def anomalies(self, warm_start: bool = False, single_page: bool = False,
        page_size: int = 5000, kwargs: dict = None, **params) -> list:
        """Read Anomalies

        Args:
            warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            sort_by (string optional): Stringa separata da virgole di campi su cui ordinare. Si indica uno o piu campi della risposta e si puo chiedere di ottenere i valori di quei campi in ordine ascendente o discendente. Esempio "Customer:Desc". Default to "". - parameter
            null_fields (string optional): additional filter - parameter
            date_start (string optional): additional filter - parameter
            date_end (string optional): additional filter - parameter
            uuid_customer (string optional): additional filter - parameter
            type (string optional): additional filter - parameter
            value (string optional): additional filter - parameter
            sampling (string optional): additional filter - parameter
            skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
            limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
            like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
            join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
            count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['sort_by', 'null_fields', 'date_start',
            'date_end', 'uuid_customer', 'type', 'value', 'sampling',
            'skip', 'limit', 'like', 'join', 'count']
        params.get('sort_by'), params.get('null_fields'), params.get(
            'date_start'), params.get('date_end'), params.get('uuid_customer'
            ), params.get('type'), params.get('value'), params.get('sampling'
            ), params.get('skip'), params.get('limit'), params.get('like'
            ), params.get('join'), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.anomalies.__name__, params,
                official_params_list)
        response = self.execute('GET', path=f'/anomalies/', single_page=
            single_page, page_size=page_size, warm_start=warm_start, params
            =params, **kwargs)
        return response

    def anomalies_create(self, kwargs: dict = None, **payload) -> list:
        """Create Anomalies Multi

        Args:
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **payload: additional parameters for the API.

        Keyword Args:
            date_anomaly_start (string required): additional filter - payload
            date_anomaly (string required): additional filter - payload
            uuid_customer (string required): additional filter - payload
            type (string required): additional filter - payload
            value (string required): additional filter - payload
            sampling (string required): additional filter - payload
            parameters (array object optional): additional filter - payload

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_payload_list = ['date_anomaly_start', 'date_anomaly',
            'uuid_customer', 'type', 'value', 'sampling', 'parameters']
        payload.get('date_anomaly_start'), payload.get('date_anomaly'
            ), payload.get('uuid_customer'), payload.get('type'), payload.get(
            'value'), payload.get('sampling'), payload.get('parameters')
        if not self._silence_warning:
            warning_wrong_parameters(self.anomalies_create.__name__,
                payload, official_payload_list)
        response = self.execute('POST', path=f'/anomalies/', payload=
            payload, **kwargs)
        return response

    def anomalie(self, uuid: str, warm_start: bool = False,
        kwargs: dict = None, **params) -> list:
        """Read Anomaly

        Args:
            uuid (str, required): uuid
            warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        kwargs, params = handling_single_page_methods(kwargs=kwargs, params
            =params)
        official_params_list = ['join']
        params.get('join')
        if not self._silence_warning:
            warning_wrong_parameters(self.anomalie.__name__, params,
                official_params_list)
        response = self.execute('GET', path=f'/anomalies/{uuid}',
            warm_start=warm_start, params=params, **kwargs)
        return response

    def anomalies_delete(self, uuid: str, kwargs: dict = None) -> list:
        """Delete Anomaly

        Args:
            uuid (str, required): uuid
            kwargs (dict, optional): additional parameters for execute. Default to None.

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        response = self.execute('DELETE', path=f'/anomalies/{uuid}', **kwargs)
        return response

    def anomalies_bulk(self, payload: list, warm_start: bool = False,
        single_page: bool = False, page_size: int = 50, kwargs: dict = None,
        **params) -> list:
        """Bulk Read Anomalies

        Args:
            payload (list[dict], optional): List dict to create.
            warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 50.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter

        Examples:
            payload = 
          [
            "uuid": "str", required
          ]

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['join']
        params.get('join')
        if not self._silence_warning:
            warning_wrong_parameters(self.anomalies_bulk.__name__, params,
                official_params_list)
        response = self.execute('POST', path=f'/anomalies/bulk/read/',
            single_page=single_page, page_size=page_size, warm_start=
            warm_start, params=params, payload=payload, **kwargs)
        return response

    def anomalies_create_bulk(self, payload: list,
        single_page: bool = False, page_size: int = 50, kwargs: dict = None,
        **params) -> list:
        """Bulk Create Anomalies

        Args:
            payload (list[dict], optional): List dict to create.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 50.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            best_effort (boolean optional): additional filter - parameter

        Examples:
            payload = 
          [
           {
            "date_anomaly_start": "string", required
            "date_anomaly": "string", required
            "uuid_customer": "string", required
            "type": "string", required
            "value": "string", required
            "sampling": "string", required
            "parameters": "array object", optional
           }
          ]

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['best_effort']
        params.get('best_effort')
        if not self._silence_warning:
            warning_wrong_parameters(self.anomalies_create_bulk.__name__,
                params, official_params_list)
        response = self.execute('POST', path=f'/anomalies/bulk/create/',
            single_page=single_page, page_size=page_size, params=params,
            payload=payload, **kwargs)
        return response

    def anomalies_delete_bulk(self, payload: list,
        single_page: bool = False, page_size: int = 50, kwargs: dict = None
        ) -> list:
        """Bulk Delete Anomalies

        Args:
            payload (list[dict], optional): List dict to create.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 50.
            kwargs (dict, optional): additional parameters for execute. Default to None.

        Examples:
            payload = 
          [
            "uuid": "str", required
          ]

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        response = self.execute('POST', path=f'/anomalies/bulk/delete/',
            single_page=single_page, page_size=page_size, payload=payload,
            **kwargs)
        return response

anomalie(uuid, warm_start=False, kwargs=None, **params)

Read Anomaly

Parameters:

Name Type Description Default
uuid (str, required)

uuid

required
warm_start bool

salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.

False
kwargs dict

additional parameters for execute. Default to None.

None
**params

additional parameters for the API.

{}

Other Parameters:

Name Type Description
join boolean optional

Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter

Returns: list

Source code in hive/cookbook/anomalies.py
def anomalie(self, uuid: str, warm_start: bool = False,
    kwargs: dict = None, **params) -> list:
    """Read Anomaly

    Args:
        uuid (str, required): uuid
        warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    kwargs, params = handling_single_page_methods(kwargs=kwargs, params
        =params)
    official_params_list = ['join']
    params.get('join')
    if not self._silence_warning:
        warning_wrong_parameters(self.anomalie.__name__, params,
            official_params_list)
    response = self.execute('GET', path=f'/anomalies/{uuid}',
        warm_start=warm_start, params=params, **kwargs)
    return response

anomalies(warm_start=False, single_page=False, page_size=5000, kwargs=None, **params)

Read Anomalies

Parameters:

Name Type Description Default
warm_start bool

salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.

False
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 5000.

5000
kwargs dict

additional parameters for execute. Default to None.

None
**params

additional parameters for the API.

{}

Other Parameters:

Name Type Description
sort_by string optional

Stringa separata da virgole di campi su cui ordinare. Si indica uno o piu campi della risposta e si puo chiedere di ottenere i valori di quei campi in ordine ascendente o discendente. Esempio "Customer:Desc". Default to "". - parameter

null_fields string optional

additional filter - parameter

date_start string optional

additional filter - parameter

date_end string optional

additional filter - parameter

uuid_customer string optional

additional filter - parameter

type string optional

additional filter - parameter

value string optional

additional filter - parameter

sampling string optional

additional filter - parameter

skip integer optional

numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter

limit integer optional

numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter

like boolean optional

Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter

join boolean optional

Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter

count boolean optional

Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

Returns: list

Source code in hive/cookbook/anomalies.py
def anomalies(self, warm_start: bool = False, single_page: bool = False,
    page_size: int = 5000, kwargs: dict = None, **params) -> list:
    """Read Anomalies

    Args:
        warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        sort_by (string optional): Stringa separata da virgole di campi su cui ordinare. Si indica uno o piu campi della risposta e si puo chiedere di ottenere i valori di quei campi in ordine ascendente o discendente. Esempio "Customer:Desc". Default to "". - parameter
        null_fields (string optional): additional filter - parameter
        date_start (string optional): additional filter - parameter
        date_end (string optional): additional filter - parameter
        uuid_customer (string optional): additional filter - parameter
        type (string optional): additional filter - parameter
        value (string optional): additional filter - parameter
        sampling (string optional): additional filter - parameter
        skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
        limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
        like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
        join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
        count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['sort_by', 'null_fields', 'date_start',
        'date_end', 'uuid_customer', 'type', 'value', 'sampling',
        'skip', 'limit', 'like', 'join', 'count']
    params.get('sort_by'), params.get('null_fields'), params.get(
        'date_start'), params.get('date_end'), params.get('uuid_customer'
        ), params.get('type'), params.get('value'), params.get('sampling'
        ), params.get('skip'), params.get('limit'), params.get('like'
        ), params.get('join'), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.anomalies.__name__, params,
            official_params_list)
    response = self.execute('GET', path=f'/anomalies/', single_page=
        single_page, page_size=page_size, warm_start=warm_start, params
        =params, **kwargs)
    return response

anomalies_bulk(payload, warm_start=False, single_page=False, page_size=50, kwargs=None, **params)

Bulk Read Anomalies

Parameters:

Name Type Description Default
payload list[dict]

List dict to create.

required
warm_start bool

salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.

False
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 50.

50
kwargs dict

additional parameters for execute. Default to None.

None
**params

additional parameters for the API.

{}

Other Parameters:

Name Type Description
join boolean optional

Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter

Examples:

payload =

[ "uuid": "str", required ]

Returns: list

Source code in hive/cookbook/anomalies.py
def anomalies_bulk(self, payload: list, warm_start: bool = False,
    single_page: bool = False, page_size: int = 50, kwargs: dict = None,
    **params) -> list:
    """Bulk Read Anomalies

    Args:
        payload (list[dict], optional): List dict to create.
        warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 50.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter

    Examples:
        payload = 
      [
        "uuid": "str", required
      ]

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['join']
    params.get('join')
    if not self._silence_warning:
        warning_wrong_parameters(self.anomalies_bulk.__name__, params,
            official_params_list)
    response = self.execute('POST', path=f'/anomalies/bulk/read/',
        single_page=single_page, page_size=page_size, warm_start=
        warm_start, params=params, payload=payload, **kwargs)
    return response

anomalies_create(kwargs=None, **payload)

Create Anomalies Multi

Parameters:

Name Type Description Default
kwargs dict

additional parameters for execute. Default to None.

None
**payload

additional parameters for the API.

{}

Other Parameters:

Name Type Description
date_anomaly_start string required

additional filter - payload

date_anomaly string required

additional filter - payload

uuid_customer string required

additional filter - payload

type string required

additional filter - payload

value string required

additional filter - payload

sampling string required

additional filter - payload

parameters array object optional

additional filter - payload

Returns: list

Source code in hive/cookbook/anomalies.py
def anomalies_create(self, kwargs: dict = None, **payload) -> list:
    """Create Anomalies Multi

    Args:
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **payload: additional parameters for the API.

    Keyword Args:
        date_anomaly_start (string required): additional filter - payload
        date_anomaly (string required): additional filter - payload
        uuid_customer (string required): additional filter - payload
        type (string required): additional filter - payload
        value (string required): additional filter - payload
        sampling (string required): additional filter - payload
        parameters (array object optional): additional filter - payload

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_payload_list = ['date_anomaly_start', 'date_anomaly',
        'uuid_customer', 'type', 'value', 'sampling', 'parameters']
    payload.get('date_anomaly_start'), payload.get('date_anomaly'
        ), payload.get('uuid_customer'), payload.get('type'), payload.get(
        'value'), payload.get('sampling'), payload.get('parameters')
    if not self._silence_warning:
        warning_wrong_parameters(self.anomalies_create.__name__,
            payload, official_payload_list)
    response = self.execute('POST', path=f'/anomalies/', payload=
        payload, **kwargs)
    return response

anomalies_create_bulk(payload, single_page=False, page_size=50, kwargs=None, **params)

Bulk Create Anomalies

Parameters:

Name Type Description Default
payload list[dict]

List dict to create.

required
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 50.

50
kwargs dict

additional parameters for execute. Default to None.

None
**params

additional parameters for the API.

{}

Other Parameters:

Name Type Description
best_effort boolean optional

additional filter - parameter

Examples:

payload =

[ { "date_anomaly_start": "string", required "date_anomaly": "string", required "uuid_customer": "string", required "type": "string", required "value": "string", required "sampling": "string", required "parameters": "array object", optional } ]

Returns: list

Source code in hive/cookbook/anomalies.py
def anomalies_create_bulk(self, payload: list,
    single_page: bool = False, page_size: int = 50, kwargs: dict = None,
    **params) -> list:
    """Bulk Create Anomalies

    Args:
        payload (list[dict], optional): List dict to create.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 50.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        best_effort (boolean optional): additional filter - parameter

    Examples:
        payload = 
      [
       {
        "date_anomaly_start": "string", required
        "date_anomaly": "string", required
        "uuid_customer": "string", required
        "type": "string", required
        "value": "string", required
        "sampling": "string", required
        "parameters": "array object", optional
       }
      ]

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['best_effort']
    params.get('best_effort')
    if not self._silence_warning:
        warning_wrong_parameters(self.anomalies_create_bulk.__name__,
            params, official_params_list)
    response = self.execute('POST', path=f'/anomalies/bulk/create/',
        single_page=single_page, page_size=page_size, params=params,
        payload=payload, **kwargs)
    return response

anomalies_delete(uuid, kwargs=None)

Delete Anomaly

Parameters:

Name Type Description Default
uuid (str, required)

uuid

required
kwargs dict

additional parameters for execute. Default to None.

None

Returns: list

Source code in hive/cookbook/anomalies.py
def anomalies_delete(self, uuid: str, kwargs: dict = None) -> list:
    """Delete Anomaly

    Args:
        uuid (str, required): uuid
        kwargs (dict, optional): additional parameters for execute. Default to None.

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    response = self.execute('DELETE', path=f'/anomalies/{uuid}', **kwargs)
    return response

anomalies_delete_bulk(payload, single_page=False, page_size=50, kwargs=None)

Bulk Delete Anomalies

Parameters:

Name Type Description Default
payload list[dict]

List dict to create.

required
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 50.

50
kwargs dict

additional parameters for execute. Default to None.

None

Examples:

payload =

[ "uuid": "str", required ]

Returns: list

Source code in hive/cookbook/anomalies.py
def anomalies_delete_bulk(self, payload: list,
    single_page: bool = False, page_size: int = 50, kwargs: dict = None
    ) -> list:
    """Bulk Delete Anomalies

    Args:
        payload (list[dict], optional): List dict to create.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 50.
        kwargs (dict, optional): additional parameters for execute. Default to None.

    Examples:
        payload = 
      [
        "uuid": "str", required
      ]

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    response = self.execute('POST', path=f'/anomalies/bulk/delete/',
        single_page=single_page, page_size=page_size, payload=payload,
        **kwargs)
    return response