Hive.cookbook.reason for closure
ReasonForClosure
Bases: ApiManager
Class that handles all the XAutomata reason_for_closure APIs
Source code in hive/cookbook/reason_for_closure.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 |
|
reason_for_closure(warm_start=False, single_page=False, page_size=5000, kwargs=None, **params)
Read Reason For Closure
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 |
code |
string optional
|
additional filter - parameter |
description |
string optional
|
additional filter - parameter |
jurisdiction |
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/reason_for_closure.py
reason_for_closure_bulk(payload, warm_start=False, single_page=False, page_size=50, kwargs=None, **params)
Bulk Read Reasons For Closure
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/reason_for_closure.py
reason_for_closure_create(kwargs=None, **payload)
Create Reason For Closure
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 |
---|---|---|
code |
string required
|
additional filter - payload |
description |
string optional
|
additional filter - payload |
jurisdiction |
string optional
|
additional filter - payload |
Returns: list
Source code in hive/cookbook/reason_for_closure.py
reason_for_closure_create_bulk(payload, single_page=False, page_size=50, kwargs=None, **params)
Bulk Create Reasons For Closure
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 =
[ { "code": "string", required "description": "string", optional "jurisdiction": "string", optional } ]
Returns: list
Source code in hive/cookbook/reason_for_closure.py
reason_for_closure_delete(uuid, kwargs=None)
Delete Reason For Closure
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/reason_for_closure.py
reason_for_closure_delete_bulk(payload, single_page=False, page_size=50, kwargs=None)
Bulk Delete Reasons For Closure
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/reason_for_closure.py
reason_for_closure_put(uuid, kwargs=None, **payload)
Update Reason For Closure
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 |
---|---|---|
code |
string required
|
additional filter - payload |
description |
string optional
|
additional filter - payload |
jurisdiction |
string optional
|
additional filter - payload |
Returns: list
Source code in hive/cookbook/reason_for_closure.py
reason_for_closure_uuid(uuid, warm_start=False, kwargs=None)
Read Reason For Closure
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
|
Returns: list