Skip to content

Hive.cookbook.external tickets

ExternalTickets

Bases: ApiManager

Class that handles all the XAutomata external_tickets APIs

Source code in hive/cookbook/external_tickets.py 
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
class ExternalTickets(ApiManager):
    """Class that handles all the XAutomata external_tickets APIs"""

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

        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
            in_sla (boolean optional): additional filter - parameter
            uuid_customer (string optional): additional filter - parameter
            uuid_virtual_domain (string optional): additional filter - parameter
            uuid_object (string optional): additional filter - parameter
            object (string optional): additional filter - parameter
            metric_type (string optional): additional filter - parameter
            metric (string optional): additional filter - parameter
            external_itsm (string optional): additional filter - parameter
            external_ticket (string optional): additional filter - parameter
            opening_date_start (string optional): additional filter - parameter
            opening_date_end (string optional): additional filter - parameter
            closing_date_start (string optional): additional filter - parameter
            closing_date_end (string optional): additional filter - parameter
            ticket_type (None optional): additional filter - parameter
            mode (None optional): additional filter - parameter
            severity (None optional): additional filter - parameter
            organization (string optional): additional filter - parameter
            responsibility (None optional): additional filter - parameter
            stage_start_sla_l1 (number optional): additional filter - parameter
            working_period_l1 (number optional): additional filter - parameter
            target_stage_start_sla_l1 (number optional): additional filter - parameter
            stage_start_sla_l2 (number optional): additional filter - parameter
            working_period_l2 (number optional): additional filter - parameter
            target_stage_start_sla_l2 (number optional): additional filter - parameter
            resolution_sla (number optional): additional filter - parameter
            working_period_resolution (number optional): additional filter - parameter
            target_period_resolution (number optional): additional filter - parameter
            null_fields (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', 'in_sla', 'uuid_customer',
            'uuid_virtual_domain', 'uuid_object', 'object', 'metric_type',
            'metric', 'external_itsm', 'external_ticket',
            'opening_date_start', 'opening_date_end', 'closing_date_start',
            'closing_date_end', 'ticket_type', 'mode', 'severity',
            'organization', 'responsibility', 'stage_start_sla_l1',
            'working_period_l1', 'target_stage_start_sla_l1',
            'stage_start_sla_l2', 'working_period_l2',
            'target_stage_start_sla_l2', 'resolution_sla',
            'working_period_resolution', 'target_period_resolution',
            'null_fields', 'skip', 'limit', 'like', 'join', 'count']
        params.get('sort_by'), params.get('in_sla'), params.get('uuid_customer'
            ), params.get('uuid_virtual_domain'), params.get('uuid_object'
            ), params.get('object'), params.get('metric_type'), params.get(
            'metric'), params.get('external_itsm'), params.get(
            'external_ticket'), params.get('opening_date_start'), params.get(
            'opening_date_end'), params.get('closing_date_start'), params.get(
            'closing_date_end'), params.get('ticket_type'), params.get('mode'
            ), params.get('severity'), params.get('organization'), params.get(
            'responsibility'), params.get('stage_start_sla_l1'), params.get(
            'working_period_l1'), params.get('target_stage_start_sla_l1'
            ), params.get('stage_start_sla_l2'), params.get('working_period_l2'
            ), params.get('target_stage_start_sla_l2'), params.get(
            'resolution_sla'), params.get('working_period_resolution'
            ), params.get('target_period_resolution'), params.get('null_fields'
            ), params.get('skip'), params.get('limit'), params.get('like'
            ), params.get('join'), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.external_tickets.__name__, params,
                official_params_list)
        response = self.execute('GET', path=f'/external_tickets/',
            single_page=single_page, page_size=page_size, warm_start=
            warm_start, params=params, **kwargs)
        return response

    def external_tickets_create(self, kwargs: dict = None, **payload) -> list:
        """Create External Ticket

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

        Keyword Args:
            uuid_customer (string required): additional filter - payload
            uuid_virtual_domain (string optional): additional filter - payload
            uuid_object (string optional): additional filter - payload
            object (string optional): additional filter - payload
            metric_type (string optional): additional filter - payload
            metric (string optional): additional filter - payload
            external_itsm (string required): additional filter - payload
            external_ticket (string required): additional filter - payload
            opening_date (string required): additional filter - payload
            closing_date (string required): additional filter - payload
            ticket_type (None required): additional filter - payload
            mode (None required): additional filter - payload
            severity (None required): additional filter - payload
            organization (string required): additional filter - payload
            responsibility (None required): additional filter - payload
            stage_start_sla_l1 (number required): additional filter - payload
            working_period_l1 (number required): additional filter - payload
            target_stage_start_sla_l1 (number required): additional filter - payload
            stage_start_sla_l2 (number required): additional filter - payload
            working_period_l2 (number required): additional filter - payload
            target_stage_start_sla_l2 (number required): additional filter - payload
            resolution_sla (number required): additional filter - payload
            working_period_resolution (number required): additional filter - payload
            target_period_resolution (number required): additional filter - payload

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_payload_list = ['uuid_customer', 'uuid_virtual_domain',
            'uuid_object', 'object', 'metric_type', 'metric',
            'external_itsm', 'external_ticket', 'opening_date',
            'closing_date', 'ticket_type', 'mode', 'severity',
            'organization', 'responsibility', 'stage_start_sla_l1',
            'working_period_l1', 'target_stage_start_sla_l1',
            'stage_start_sla_l2', 'working_period_l2',
            'target_stage_start_sla_l2', 'resolution_sla',
            'working_period_resolution', 'target_period_resolution']
        payload.get('uuid_customer'), payload.get('uuid_virtual_domain'
            ), payload.get('uuid_object'), payload.get('object'), payload.get(
            'metric_type'), payload.get('metric'), payload.get('external_itsm'
            ), payload.get('external_ticket'), payload.get('opening_date'
            ), payload.get('closing_date'), payload.get('ticket_type'
            ), payload.get('mode'), payload.get('severity'), payload.get(
            'organization'), payload.get('responsibility'), payload.get(
            'stage_start_sla_l1'), payload.get('working_period_l1'
            ), payload.get('target_stage_start_sla_l1'), payload.get(
            'stage_start_sla_l2'), payload.get('working_period_l2'
            ), payload.get('target_stage_start_sla_l2'), payload.get(
            'resolution_sla'), payload.get('working_period_resolution'
            ), payload.get('target_period_resolution')
        if not self._silence_warning:
            warning_wrong_parameters(self.external_tickets_create.__name__,
                payload, official_payload_list)
        response = self.execute('POST', path=f'/external_tickets/', payload
            =payload, **kwargs)
        return response

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

        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.external_ticket.__name__, params,
                official_params_list)
        response = self.execute('GET', path=f'/external_tickets/{uuid}',
            warm_start=warm_start, params=params, **kwargs)
        return response

    def external_tickets_put(self, uuid: str, kwargs: dict = None, **payload
        ) -> list:
        """Update External Ticket

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

        Keyword Args:
            uuid_customer (string optional): additional filter - payload
            uuid_virtual_domain (string optional): additional filter - payload
            uuid_object (string optional): additional filter - payload
            object (string optional): additional filter - payload
            metric_type (string optional): additional filter - payload
            metric (string optional): additional filter - payload
            external_itsm (string optional): additional filter - payload
            external_ticket (string optional): additional filter - payload
            opening_date (string optional): additional filter - payload
            closing_date (string optional): additional filter - payload
            ticket_type (None optional): additional filter - payload
            mode (None optional): additional filter - payload
            severity (None optional): additional filter - payload
            organization (string optional): additional filter - payload
            responsibility (None optional): additional filter - payload
            stage_start_sla_l1 (number optional): additional filter - payload
            working_period_l1 (number optional): additional filter - payload
            target_stage_start_sla_l1 (number optional): additional filter - payload
            stage_start_sla_l2 (number optional): additional filter - payload
            working_period_l2 (number optional): additional filter - payload
            target_stage_start_sla_l2 (number optional): additional filter - payload
            resolution_sla (number optional): additional filter - payload
            working_period_resolution (number optional): additional filter - payload
            target_period_resolution (number optional): additional filter - payload

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_payload_list = ['uuid_customer', 'uuid_virtual_domain',
            'uuid_object', 'object', 'metric_type', 'metric',
            'external_itsm', 'external_ticket', 'opening_date',
            'closing_date', 'ticket_type', 'mode', 'severity',
            'organization', 'responsibility', 'stage_start_sla_l1',
            'working_period_l1', 'target_stage_start_sla_l1',
            'stage_start_sla_l2', 'working_period_l2',
            'target_stage_start_sla_l2', 'resolution_sla',
            'working_period_resolution', 'target_period_resolution']
        payload.get('uuid_customer'), payload.get('uuid_virtual_domain'
            ), payload.get('uuid_object'), payload.get('object'), payload.get(
            'metric_type'), payload.get('metric'), payload.get('external_itsm'
            ), payload.get('external_ticket'), payload.get('opening_date'
            ), payload.get('closing_date'), payload.get('ticket_type'
            ), payload.get('mode'), payload.get('severity'), payload.get(
            'organization'), payload.get('responsibility'), payload.get(
            'stage_start_sla_l1'), payload.get('working_period_l1'
            ), payload.get('target_stage_start_sla_l1'), payload.get(
            'stage_start_sla_l2'), payload.get('working_period_l2'
            ), payload.get('target_stage_start_sla_l2'), payload.get(
            'resolution_sla'), payload.get('working_period_resolution'
            ), payload.get('target_period_resolution')
        if not self._silence_warning:
            warning_wrong_parameters(self.external_tickets_put.__name__,
                payload, official_payload_list)
        response = self.execute('PUT', path=f'/external_tickets/{uuid}',
            payload=payload, **kwargs)
        return response

    def external_tickets_delete(self, uuid: str, kwargs: dict = None) -> list:
        """Delete External Ticket

        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'/external_tickets/{uuid}',
            **kwargs)
        return response

    def external_tickets_ticket_by_params(self, ticket_type: str,
        uuid_customer: str, warm_start: bool = False, kwargs: dict = None,
        **params) -> list:
        """Pie Charts

        Args:
            ticket_type (str, required): ticket_type
            uuid_customer (str, required): uuid_customer
            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:
            date_start (string optional): additional filter - parameter
            date_end (string optional): additional filter - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        kwargs, params = handling_single_page_methods(kwargs=kwargs, params
            =params)
        official_params_list = ['date_start', 'date_end']
        params.get('date_start'), params.get('date_end')
        if not self._silence_warning:
            warning_wrong_parameters(self.external_tickets_ticket_by_params
                .__name__, params, official_params_list)
        response = self.execute('GET', path=
            f'/external_tickets/ticket_by_params/{ticket_type}/{uuid_customer}'
            , warm_start=warm_start, params=params, **kwargs)
        return response

    def external_tickets_ticket_by_sla(self, ticket_type: str,
        uuid_customer: str, warm_start: bool = False, kwargs: dict = None,
        **params) -> list:
        """Sla Charge And Resolution

        Args:
            ticket_type (str, required): ticket_type
            uuid_customer (str, required): uuid_customer
            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:
            date_start (string optional): additional filter - parameter
            date_end (string optional): additional filter - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        kwargs, params = handling_single_page_methods(kwargs=kwargs, params
            =params)
        official_params_list = ['date_start', 'date_end']
        params.get('date_start'), params.get('date_end')
        if not self._silence_warning:
            warning_wrong_parameters(self.external_tickets_ticket_by_sla.
                __name__, params, official_params_list)
        response = self.execute('GET', path=
            f'/external_tickets/ticket_by_sla/{ticket_type}/{uuid_customer}',
            warm_start=warm_start, params=params, **kwargs)
        return response

    def external_tickets_ticket_by_date(self, uuid_customer: str,
        warm_start: bool = False, kwargs: dict = None, **params) -> list:
        """History

        Args:
            uuid_customer (str, required): uuid_customer
            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:
            date_start (string optional): additional filter - parameter
            date_end (string optional): additional filter - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        kwargs, params = handling_single_page_methods(kwargs=kwargs, params
            =params)
        official_params_list = ['date_start', 'date_end']
        params.get('date_start'), params.get('date_end')
        if not self._silence_warning:
            warning_wrong_parameters(self.external_tickets_ticket_by_date.
                __name__, params, official_params_list)
        response = self.execute('GET', path=
            f'/external_tickets/ticket_by_date/{uuid_customer}', warm_start
            =warm_start, params=params, **kwargs)
        return response

    def external_tickets_ticket_by_params_customers_filtering(self,
        ticket_type: str, warm_start: bool = False, kwargs: dict = None, **
        params) -> list:
        """Customers Filtering Pie Charts

        Args:
            ticket_type (str, required): ticket_type
            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:
            date_start (string optional): additional filter - parameter
            date_end (string optional): additional filter - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        kwargs, params = handling_single_page_methods(kwargs=kwargs, params
            =params)
        official_params_list = ['date_start', 'date_end']
        params.get('date_start'), params.get('date_end')
        if not self._silence_warning:
            warning_wrong_parameters(self.
                external_tickets_ticket_by_params_customers_filtering.
                __name__, params, official_params_list)
        response = self.execute('GET', path=
            f'/external_tickets/ticket_by_params/customers_filtering/{ticket_type}/'
            , warm_start=warm_start, params=params, **kwargs)
        return response

    def external_tickets_ticket_by_sla_customers_filtering(self,
        ticket_type: str, warm_start: bool = False, kwargs: dict = None, **
        params) -> list:
        """Customers Filtering Sla Charge And Resolution

        Args:
            ticket_type (str, required): ticket_type
            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:
            date_start (string optional): additional filter - parameter
            date_end (string optional): additional filter - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        kwargs, params = handling_single_page_methods(kwargs=kwargs, params
            =params)
        official_params_list = ['date_start', 'date_end']
        params.get('date_start'), params.get('date_end')
        if not self._silence_warning:
            warning_wrong_parameters(self.
                external_tickets_ticket_by_sla_customers_filtering.__name__,
                params, official_params_list)
        response = self.execute('GET', path=
            f'/external_tickets/ticket_by_sla/customers_filtering/{ticket_type}/'
            , warm_start=warm_start, params=params, **kwargs)
        return response

    def external_tickets_ticket_by_date_customers_filtering(self,
        warm_start: bool = False, kwargs: dict = None, **params) -> list:
        """Customers Filtering History

        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.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            date_start (string optional): additional filter - parameter
            date_end (string optional): additional filter - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        kwargs, params = handling_single_page_methods(kwargs=kwargs, params
            =params)
        official_params_list = ['date_start', 'date_end']
        params.get('date_start'), params.get('date_end')
        if not self._silence_warning:
            warning_wrong_parameters(self.
                external_tickets_ticket_by_date_customers_filtering.
                __name__, params, official_params_list)
        response = self.execute('GET', path=
            f'/external_tickets/ticket_by_date/customers_filtering/',
            warm_start=warm_start, params=params, **kwargs)
        return response

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

        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.external_tickets_bulk.__name__,
                params, official_params_list)
        response = self.execute('POST', path=
            f'/external_tickets/bulk/read/', single_page=single_page,
            page_size=page_size, warm_start=warm_start, params=params,
            payload=payload, **kwargs)
        return response

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

        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 = 
          [
           {
            "uuid_customer": "string", required
            "uuid_virtual_domain": "string", optional
            "uuid_object": "string", optional
            "object": "string", optional
            "metric_type": "string", optional
            "metric": "string", optional
            "external_itsm": "string", required
            "external_ticket": "string", required
            "opening_date": "string", required
            "closing_date": "string", required
            "ticket_type": "None", required
            "mode": "None", required
            "severity": "None", required
            "organization": "string", required
            "responsibility": "None", required
            "stage_start_sla_l1": "number", required
            "working_period_l1": "number", required
            "target_stage_start_sla_l1": "number", required
            "stage_start_sla_l2": "number", required
            "working_period_l2": "number", required
            "target_stage_start_sla_l2": "number", required
            "resolution_sla": "number", required
            "working_period_resolution": "number", required
            "target_period_resolution": "number", required
           }
          ]

        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.external_tickets_create_bulk.
                __name__, params, official_params_list)
        response = self.execute('POST', path=
            f'/external_tickets/bulk/create/', single_page=single_page,
            page_size=page_size, params=params, payload=payload, **kwargs)
        return response

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

Read External Ticket

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/external_tickets.py 
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
def external_ticket(self, uuid: str, warm_start: bool = False,
    kwargs: dict = None, **params) -> list:
    """Read External Ticket

    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.external_ticket.__name__, params,
            official_params_list)
    response = self.execute('GET', path=f'/external_tickets/{uuid}',
        warm_start=warm_start, params=params, **kwargs)
    return response

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

Read External Tickets

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
in_sla boolean optional

additional filter - parameter
uuid_customer string optional

additional filter - parameter
uuid_virtual_domain string optional

additional filter - parameter
uuid_object string optional

additional filter - parameter
object string optional

additional filter - parameter
metric_type string optional

additional filter - parameter
metric string optional

additional filter - parameter
external_itsm string optional

additional filter - parameter
external_ticket string optional

additional filter - parameter
opening_date_start string optional

additional filter - parameter
opening_date_end string optional

additional filter - parameter
closing_date_start string optional

additional filter - parameter
closing_date_end string optional

additional filter - parameter
ticket_type None optional

additional filter - parameter
mode None optional

additional filter - parameter
severity None optional

additional filter - parameter
organization string optional

additional filter - parameter
responsibility None optional

additional filter - parameter
stage_start_sla_l1 number optional

additional filter - parameter
working_period_l1 number optional

additional filter - parameter
target_stage_start_sla_l1 number optional

additional filter - parameter
stage_start_sla_l2 number optional

additional filter - parameter
working_period_l2 number optional

additional filter - parameter
target_stage_start_sla_l2 number optional

additional filter - parameter
resolution_sla number optional

additional filter - parameter
working_period_resolution number optional

additional filter - parameter
target_period_resolution number optional

additional filter - parameter
null_fields 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/external_tickets.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
def external_tickets(self, warm_start: bool = False,
    single_page: bool = False, page_size: int = 5000,
    kwargs: dict = None, **params) -> list:
    """Read External Tickets

    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
        in_sla (boolean optional): additional filter - parameter
        uuid_customer (string optional): additional filter - parameter
        uuid_virtual_domain (string optional): additional filter - parameter
        uuid_object (string optional): additional filter - parameter
        object (string optional): additional filter - parameter
        metric_type (string optional): additional filter - parameter
        metric (string optional): additional filter - parameter
        external_itsm (string optional): additional filter - parameter
        external_ticket (string optional): additional filter - parameter
        opening_date_start (string optional): additional filter - parameter
        opening_date_end (string optional): additional filter - parameter
        closing_date_start (string optional): additional filter - parameter
        closing_date_end (string optional): additional filter - parameter
        ticket_type (None optional): additional filter - parameter
        mode (None optional): additional filter - parameter
        severity (None optional): additional filter - parameter
        organization (string optional): additional filter - parameter
        responsibility (None optional): additional filter - parameter
        stage_start_sla_l1 (number optional): additional filter - parameter
        working_period_l1 (number optional): additional filter - parameter
        target_stage_start_sla_l1 (number optional): additional filter - parameter
        stage_start_sla_l2 (number optional): additional filter - parameter
        working_period_l2 (number optional): additional filter - parameter
        target_stage_start_sla_l2 (number optional): additional filter - parameter
        resolution_sla (number optional): additional filter - parameter
        working_period_resolution (number optional): additional filter - parameter
        target_period_resolution (number optional): additional filter - parameter
        null_fields (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', 'in_sla', 'uuid_customer',
        'uuid_virtual_domain', 'uuid_object', 'object', 'metric_type',
        'metric', 'external_itsm', 'external_ticket',
        'opening_date_start', 'opening_date_end', 'closing_date_start',
        'closing_date_end', 'ticket_type', 'mode', 'severity',
        'organization', 'responsibility', 'stage_start_sla_l1',
        'working_period_l1', 'target_stage_start_sla_l1',
        'stage_start_sla_l2', 'working_period_l2',
        'target_stage_start_sla_l2', 'resolution_sla',
        'working_period_resolution', 'target_period_resolution',
        'null_fields', 'skip', 'limit', 'like', 'join', 'count']
    params.get('sort_by'), params.get('in_sla'), params.get('uuid_customer'
        ), params.get('uuid_virtual_domain'), params.get('uuid_object'
        ), params.get('object'), params.get('metric_type'), params.get(
        'metric'), params.get('external_itsm'), params.get(
        'external_ticket'), params.get('opening_date_start'), params.get(
        'opening_date_end'), params.get('closing_date_start'), params.get(
        'closing_date_end'), params.get('ticket_type'), params.get('mode'
        ), params.get('severity'), params.get('organization'), params.get(
        'responsibility'), params.get('stage_start_sla_l1'), params.get(
        'working_period_l1'), params.get('target_stage_start_sla_l1'
        ), params.get('stage_start_sla_l2'), params.get('working_period_l2'
        ), params.get('target_stage_start_sla_l2'), params.get(
        'resolution_sla'), params.get('working_period_resolution'
        ), params.get('target_period_resolution'), params.get('null_fields'
        ), params.get('skip'), params.get('limit'), params.get('like'
        ), params.get('join'), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.external_tickets.__name__, params,
            official_params_list)
    response = self.execute('GET', path=f'/external_tickets/',
        single_page=single_page, page_size=page_size, warm_start=
        warm_start, params=params, **kwargs)
    return response

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

Bulk Read External Tickets

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/external_tickets.py 
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
def external_tickets_bulk(self, payload: list, warm_start: bool = False,
    single_page: bool = False, page_size: int = 50, kwargs: dict = None,
    **params) -> list:
    """Bulk Read External Tickets

    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.external_tickets_bulk.__name__,
            params, official_params_list)
    response = self.execute('POST', path=
        f'/external_tickets/bulk/read/', single_page=single_page,
        page_size=page_size, warm_start=warm_start, params=params,
        payload=payload, **kwargs)
    return response

external_tickets_create(kwargs=None, **payload)

Create External Ticket

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
uuid_customer string required

additional filter - payload
uuid_virtual_domain string optional

additional filter - payload
uuid_object string optional

additional filter - payload
object string optional

additional filter - payload
metric_type string optional

additional filter - payload
metric string optional

additional filter - payload
external_itsm string required

additional filter - payload
external_ticket string required

additional filter - payload
opening_date string required

additional filter - payload
closing_date string required

additional filter - payload
ticket_type None required

additional filter - payload
mode None required

additional filter - payload
severity None required

additional filter - payload
organization string required

additional filter - payload
responsibility None required

additional filter - payload
stage_start_sla_l1 number required

additional filter - payload
working_period_l1 number required

additional filter - payload
target_stage_start_sla_l1 number required

additional filter - payload
stage_start_sla_l2 number required

additional filter - payload
working_period_l2 number required

additional filter - payload
target_stage_start_sla_l2 number required

additional filter - payload
resolution_sla number required

additional filter - payload
working_period_resolution number required

additional filter - payload
target_period_resolution number required

additional filter - payload

Returns: list

Source code in hive/cookbook/external_tickets.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
def external_tickets_create(self, kwargs: dict = None, **payload) -> list:
    """Create External Ticket

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

    Keyword Args:
        uuid_customer (string required): additional filter - payload
        uuid_virtual_domain (string optional): additional filter - payload
        uuid_object (string optional): additional filter - payload
        object (string optional): additional filter - payload
        metric_type (string optional): additional filter - payload
        metric (string optional): additional filter - payload
        external_itsm (string required): additional filter - payload
        external_ticket (string required): additional filter - payload
        opening_date (string required): additional filter - payload
        closing_date (string required): additional filter - payload
        ticket_type (None required): additional filter - payload
        mode (None required): additional filter - payload
        severity (None required): additional filter - payload
        organization (string required): additional filter - payload
        responsibility (None required): additional filter - payload
        stage_start_sla_l1 (number required): additional filter - payload
        working_period_l1 (number required): additional filter - payload
        target_stage_start_sla_l1 (number required): additional filter - payload
        stage_start_sla_l2 (number required): additional filter - payload
        working_period_l2 (number required): additional filter - payload
        target_stage_start_sla_l2 (number required): additional filter - payload
        resolution_sla (number required): additional filter - payload
        working_period_resolution (number required): additional filter - payload
        target_period_resolution (number required): additional filter - payload

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_payload_list = ['uuid_customer', 'uuid_virtual_domain',
        'uuid_object', 'object', 'metric_type', 'metric',
        'external_itsm', 'external_ticket', 'opening_date',
        'closing_date', 'ticket_type', 'mode', 'severity',
        'organization', 'responsibility', 'stage_start_sla_l1',
        'working_period_l1', 'target_stage_start_sla_l1',
        'stage_start_sla_l2', 'working_period_l2',
        'target_stage_start_sla_l2', 'resolution_sla',
        'working_period_resolution', 'target_period_resolution']
    payload.get('uuid_customer'), payload.get('uuid_virtual_domain'
        ), payload.get('uuid_object'), payload.get('object'), payload.get(
        'metric_type'), payload.get('metric'), payload.get('external_itsm'
        ), payload.get('external_ticket'), payload.get('opening_date'
        ), payload.get('closing_date'), payload.get('ticket_type'
        ), payload.get('mode'), payload.get('severity'), payload.get(
        'organization'), payload.get('responsibility'), payload.get(
        'stage_start_sla_l1'), payload.get('working_period_l1'
        ), payload.get('target_stage_start_sla_l1'), payload.get(
        'stage_start_sla_l2'), payload.get('working_period_l2'
        ), payload.get('target_stage_start_sla_l2'), payload.get(
        'resolution_sla'), payload.get('working_period_resolution'
        ), payload.get('target_period_resolution')
    if not self._silence_warning:
        warning_wrong_parameters(self.external_tickets_create.__name__,
            payload, official_payload_list)
    response = self.execute('POST', path=f'/external_tickets/', payload
        =payload, **kwargs)
    return response

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

Bulk Create External Tickets

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 =

[ { "uuid_customer": "string", required "uuid_virtual_domain": "string", optional "uuid_object": "string", optional "object": "string", optional "metric_type": "string", optional "metric": "string", optional "external_itsm": "string", required "external_ticket": "string", required "opening_date": "string", required "closing_date": "string", required "ticket_type": "None", required "mode": "None", required "severity": "None", required "organization": "string", required "responsibility": "None", required "stage_start_sla_l1": "number", required "working_period_l1": "number", required "target_stage_start_sla_l1": "number", required "stage_start_sla_l2": "number", required "working_period_l2": "number", required "target_stage_start_sla_l2": "number", required "resolution_sla": "number", required "working_period_resolution": "number", required "target_period_resolution": "number", required } ]

Returns: list

Source code in hive/cookbook/external_tickets.py 
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
def external_tickets_create_bulk(self, payload: list,
    single_page: bool = False, page_size: int = 50, kwargs: dict = None,
    **params) -> list:
    """Bulk Create External Tickets

    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 = 
      [
       {
        "uuid_customer": "string", required
        "uuid_virtual_domain": "string", optional
        "uuid_object": "string", optional
        "object": "string", optional
        "metric_type": "string", optional
        "metric": "string", optional
        "external_itsm": "string", required
        "external_ticket": "string", required
        "opening_date": "string", required
        "closing_date": "string", required
        "ticket_type": "None", required
        "mode": "None", required
        "severity": "None", required
        "organization": "string", required
        "responsibility": "None", required
        "stage_start_sla_l1": "number", required
        "working_period_l1": "number", required
        "target_stage_start_sla_l1": "number", required
        "stage_start_sla_l2": "number", required
        "working_period_l2": "number", required
        "target_stage_start_sla_l2": "number", required
        "resolution_sla": "number", required
        "working_period_resolution": "number", required
        "target_period_resolution": "number", required
       }
      ]

    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.external_tickets_create_bulk.
            __name__, params, official_params_list)
    response = self.execute('POST', path=
        f'/external_tickets/bulk/create/', single_page=single_page,
        page_size=page_size, params=params, payload=payload, **kwargs)
    return response

external_tickets_delete(uuid, kwargs=None)

Delete External Ticket

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/external_tickets.py 
252
253
254
255
256
257
258
259
260
261
262
263
264
def external_tickets_delete(self, uuid: str, kwargs: dict = None) -> list:
    """Delete External Ticket

    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'/external_tickets/{uuid}',
        **kwargs)
    return response

external_tickets_put(uuid, kwargs=None, **payload)

Update External Ticket

Parameters:

Name Type Description Default
uuid (str, required)

uuid

 required
kwargs dict

additional parameters for execute. Default to None.

 None
**payload

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
uuid_customer string optional

additional filter - payload
uuid_virtual_domain string optional

additional filter - payload
uuid_object string optional

additional filter - payload
object string optional

additional filter - payload
metric_type string optional

additional filter - payload
metric string optional

additional filter - payload
external_itsm string optional

additional filter - payload
external_ticket string optional

additional filter - payload
opening_date string optional

additional filter - payload
closing_date string optional

additional filter - payload
ticket_type None optional

additional filter - payload
mode None optional

additional filter - payload
severity None optional

additional filter - payload
organization string optional

additional filter - payload
responsibility None optional

additional filter - payload
stage_start_sla_l1 number optional

additional filter - payload
working_period_l1 number optional

additional filter - payload
target_stage_start_sla_l1 number optional

additional filter - payload
stage_start_sla_l2 number optional

additional filter - payload
working_period_l2 number optional

additional filter - payload
target_stage_start_sla_l2 number optional

additional filter - payload
resolution_sla number optional

additional filter - payload
working_period_resolution number optional

additional filter - payload
target_period_resolution number optional

additional filter - payload

Returns: list

Source code in hive/cookbook/external_tickets.py 
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
def external_tickets_put(self, uuid: str, kwargs: dict = None, **payload
    ) -> list:
    """Update External Ticket

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

    Keyword Args:
        uuid_customer (string optional): additional filter - payload
        uuid_virtual_domain (string optional): additional filter - payload
        uuid_object (string optional): additional filter - payload
        object (string optional): additional filter - payload
        metric_type (string optional): additional filter - payload
        metric (string optional): additional filter - payload
        external_itsm (string optional): additional filter - payload
        external_ticket (string optional): additional filter - payload
        opening_date (string optional): additional filter - payload
        closing_date (string optional): additional filter - payload
        ticket_type (None optional): additional filter - payload
        mode (None optional): additional filter - payload
        severity (None optional): additional filter - payload
        organization (string optional): additional filter - payload
        responsibility (None optional): additional filter - payload
        stage_start_sla_l1 (number optional): additional filter - payload
        working_period_l1 (number optional): additional filter - payload
        target_stage_start_sla_l1 (number optional): additional filter - payload
        stage_start_sla_l2 (number optional): additional filter - payload
        working_period_l2 (number optional): additional filter - payload
        target_stage_start_sla_l2 (number optional): additional filter - payload
        resolution_sla (number optional): additional filter - payload
        working_period_resolution (number optional): additional filter - payload
        target_period_resolution (number optional): additional filter - payload

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_payload_list = ['uuid_customer', 'uuid_virtual_domain',
        'uuid_object', 'object', 'metric_type', 'metric',
        'external_itsm', 'external_ticket', 'opening_date',
        'closing_date', 'ticket_type', 'mode', 'severity',
        'organization', 'responsibility', 'stage_start_sla_l1',
        'working_period_l1', 'target_stage_start_sla_l1',
        'stage_start_sla_l2', 'working_period_l2',
        'target_stage_start_sla_l2', 'resolution_sla',
        'working_period_resolution', 'target_period_resolution']
    payload.get('uuid_customer'), payload.get('uuid_virtual_domain'
        ), payload.get('uuid_object'), payload.get('object'), payload.get(
        'metric_type'), payload.get('metric'), payload.get('external_itsm'
        ), payload.get('external_ticket'), payload.get('opening_date'
        ), payload.get('closing_date'), payload.get('ticket_type'
        ), payload.get('mode'), payload.get('severity'), payload.get(
        'organization'), payload.get('responsibility'), payload.get(
        'stage_start_sla_l1'), payload.get('working_period_l1'
        ), payload.get('target_stage_start_sla_l1'), payload.get(
        'stage_start_sla_l2'), payload.get('working_period_l2'
        ), payload.get('target_stage_start_sla_l2'), payload.get(
        'resolution_sla'), payload.get('working_period_resolution'
        ), payload.get('target_period_resolution')
    if not self._silence_warning:
        warning_wrong_parameters(self.external_tickets_put.__name__,
            payload, official_payload_list)
    response = self.execute('PUT', path=f'/external_tickets/{uuid}',
        payload=payload, **kwargs)
    return response

external_tickets_ticket_by_date(uuid_customer, warm_start=False, kwargs=None, **params)

History

Parameters:

Name Type Description Default
uuid_customer (str, required)

uuid_customer

 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
date_start string optional

additional filter - parameter
date_end string optional

additional filter - parameter

Returns: list

Source code in hive/cookbook/external_tickets.py 
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
def external_tickets_ticket_by_date(self, uuid_customer: str,
    warm_start: bool = False, kwargs: dict = None, **params) -> list:
    """History

    Args:
        uuid_customer (str, required): uuid_customer
        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:
        date_start (string optional): additional filter - parameter
        date_end (string optional): additional filter - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    kwargs, params = handling_single_page_methods(kwargs=kwargs, params
        =params)
    official_params_list = ['date_start', 'date_end']
    params.get('date_start'), params.get('date_end')
    if not self._silence_warning:
        warning_wrong_parameters(self.external_tickets_ticket_by_date.
            __name__, params, official_params_list)
    response = self.execute('GET', path=
        f'/external_tickets/ticket_by_date/{uuid_customer}', warm_start
        =warm_start, params=params, **kwargs)
    return response

external_tickets_ticket_by_date_customers_filtering(warm_start=False, kwargs=None, **params)

Customers Filtering History

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
kwargs dict

additional parameters for execute. Default to None.

 None
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
date_start string optional

additional filter - parameter
date_end string optional

additional filter - parameter

Returns: list

Source code in hive/cookbook/external_tickets.py 
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
def external_tickets_ticket_by_date_customers_filtering(self,
    warm_start: bool = False, kwargs: dict = None, **params) -> list:
    """Customers Filtering History

    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.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        date_start (string optional): additional filter - parameter
        date_end (string optional): additional filter - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    kwargs, params = handling_single_page_methods(kwargs=kwargs, params
        =params)
    official_params_list = ['date_start', 'date_end']
    params.get('date_start'), params.get('date_end')
    if not self._silence_warning:
        warning_wrong_parameters(self.
            external_tickets_ticket_by_date_customers_filtering.
            __name__, params, official_params_list)
    response = self.execute('GET', path=
        f'/external_tickets/ticket_by_date/customers_filtering/',
        warm_start=warm_start, params=params, **kwargs)
    return response

external_tickets_ticket_by_params(ticket_type, uuid_customer, warm_start=False, kwargs=None, **params)

Pie Charts

Parameters:

Name Type Description Default
ticket_type (str, required)

ticket_type

 required
uuid_customer (str, required)

uuid_customer

 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
date_start string optional

additional filter - parameter
date_end string optional

additional filter - parameter

Returns: list

Source code in hive/cookbook/external_tickets.py 
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
def external_tickets_ticket_by_params(self, ticket_type: str,
    uuid_customer: str, warm_start: bool = False, kwargs: dict = None,
    **params) -> list:
    """Pie Charts

    Args:
        ticket_type (str, required): ticket_type
        uuid_customer (str, required): uuid_customer
        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:
        date_start (string optional): additional filter - parameter
        date_end (string optional): additional filter - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    kwargs, params = handling_single_page_methods(kwargs=kwargs, params
        =params)
    official_params_list = ['date_start', 'date_end']
    params.get('date_start'), params.get('date_end')
    if not self._silence_warning:
        warning_wrong_parameters(self.external_tickets_ticket_by_params
            .__name__, params, official_params_list)
    response = self.execute('GET', path=
        f'/external_tickets/ticket_by_params/{ticket_type}/{uuid_customer}'
        , warm_start=warm_start, params=params, **kwargs)
    return response

external_tickets_ticket_by_params_customers_filtering(ticket_type, warm_start=False, kwargs=None, **params)

Customers Filtering Pie Charts

Parameters:

Name Type Description Default
ticket_type (str, required)

ticket_type

 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
date_start string optional

additional filter - parameter
date_end string optional

additional filter - parameter

Returns: list

Source code in hive/cookbook/external_tickets.py 
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
def external_tickets_ticket_by_params_customers_filtering(self,
    ticket_type: str, warm_start: bool = False, kwargs: dict = None, **
    params) -> list:
    """Customers Filtering Pie Charts

    Args:
        ticket_type (str, required): ticket_type
        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:
        date_start (string optional): additional filter - parameter
        date_end (string optional): additional filter - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    kwargs, params = handling_single_page_methods(kwargs=kwargs, params
        =params)
    official_params_list = ['date_start', 'date_end']
    params.get('date_start'), params.get('date_end')
    if not self._silence_warning:
        warning_wrong_parameters(self.
            external_tickets_ticket_by_params_customers_filtering.
            __name__, params, official_params_list)
    response = self.execute('GET', path=
        f'/external_tickets/ticket_by_params/customers_filtering/{ticket_type}/'
        , warm_start=warm_start, params=params, **kwargs)
    return response

external_tickets_ticket_by_sla(ticket_type, uuid_customer, warm_start=False, kwargs=None, **params)

Sla Charge And Resolution

Parameters:

Name Type Description Default
ticket_type (str, required)

ticket_type

 required
uuid_customer (str, required)

uuid_customer

 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
date_start string optional

additional filter - parameter
date_end string optional

additional filter - parameter

Returns: list

Source code in hive/cookbook/external_tickets.py 
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
def external_tickets_ticket_by_sla(self, ticket_type: str,
    uuid_customer: str, warm_start: bool = False, kwargs: dict = None,
    **params) -> list:
    """Sla Charge And Resolution

    Args:
        ticket_type (str, required): ticket_type
        uuid_customer (str, required): uuid_customer
        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:
        date_start (string optional): additional filter - parameter
        date_end (string optional): additional filter - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    kwargs, params = handling_single_page_methods(kwargs=kwargs, params
        =params)
    official_params_list = ['date_start', 'date_end']
    params.get('date_start'), params.get('date_end')
    if not self._silence_warning:
        warning_wrong_parameters(self.external_tickets_ticket_by_sla.
            __name__, params, official_params_list)
    response = self.execute('GET', path=
        f'/external_tickets/ticket_by_sla/{ticket_type}/{uuid_customer}',
        warm_start=warm_start, params=params, **kwargs)
    return response

external_tickets_ticket_by_sla_customers_filtering(ticket_type, warm_start=False, kwargs=None, **params)

Customers Filtering Sla Charge And Resolution

Parameters:

Name Type Description Default
ticket_type (str, required)

ticket_type

 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
date_start string optional

additional filter - parameter
date_end string optional

additional filter - parameter

Returns: list

Source code in hive/cookbook/external_tickets.py 
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
def external_tickets_ticket_by_sla_customers_filtering(self,
    ticket_type: str, warm_start: bool = False, kwargs: dict = None, **
    params) -> list:
    """Customers Filtering Sla Charge And Resolution

    Args:
        ticket_type (str, required): ticket_type
        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:
        date_start (string optional): additional filter - parameter
        date_end (string optional): additional filter - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    kwargs, params = handling_single_page_methods(kwargs=kwargs, params
        =params)
    official_params_list = ['date_start', 'date_end']
    params.get('date_start'), params.get('date_end')
    if not self._silence_warning:
        warning_wrong_parameters(self.
            external_tickets_ticket_by_sla_customers_filtering.__name__,
            params, official_params_list)
    response = self.execute('GET', path=
        f'/external_tickets/ticket_by_sla/customers_filtering/{ticket_type}/'
        , warm_start=warm_start, params=params, **kwargs)
    return response