Analysis element
delete_analysis_elements(ids, delete_children=False, logger=None, session=None)
Delete analysis elements
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
ids |
List[str]
|
List of identifiers of analysis elements |
required |
logger |
Logger object instance |
None
|
|
session |
SQLAlchemy
|
SQLAlchemy session |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
ids |
list[str]
|
List of deleted analysis elements identifiers |
get_analysis_element(organization_id, relations=0, id=None, logger=None, session=None, orm_entities=False)
Get detail of analysis elements
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
organization_id |
uuid
|
Organization identifier |
required |
relations |
int
|
Flag sum of associated enities type. Use Entities enum type. |
0
|
id |
str
|
Analysis element identifier |
None
|
session |
SQLAlchemy
|
SQLAlchemy session |
None
|
orm_entities |
bool
|
If True, return mapping models, else domain models |
False
|
Returns:
| Type | Description |
|---|---|
|
Dictionary with 2 keys. [Data]: a list of AnalysisElementModel entities (if orm_entities==True) or a list of AnalysisElement (if orm_entities=False). [Total]: record count. |
get_analysis_elements(organization_id, relations=0, ids=None, order=None, offset=0, limit=100, filters=None, logger=None, session=None, orm_entities=False)
Get list of analysis elements
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
organization_id |
uuid
|
Organization identifier |
required |
relations |
int
|
Flag sum of associated enities type. Use Entities enum type. |
0
|
ids |
List[str]
|
List of identifiers of analysis elements. If empty, load all data. |
None
|
order |
str
|
Order field |
None
|
offset |
int
|
Index of first record |
0
|
limit |
int
|
Number of records to be returned |
100
|
filters |
str
|
JSON string with query filter |
None
|
session |
SQLAlchemy
|
SQLAlchemy session |
None
|
orm_entities |
bool
|
If True, return mapping models, else domain models |
False
|
Returns:
| Type | Description |
|---|---|
|
Dictionary with 2 keys. [Data]: a list of AnalysisElementModel entities (if orm_entities==True) or a list of AnalysisElement (if orm_entities=False). [Total]: record count. |
get_analysis_elements_by_categories(organization_id, relations=0, ids=None, categories=None, order=None, offset=0, limit=100, filters=None, logger=None, session=None, orm_entities=False)
Get list of analysis elements filtered by categories
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
organization_id |
uuid
|
Organization identifier |
required |
relations |
int
|
Flag sum of associated enities type. Use Entities enum type. |
0
|
ids |
List[str]
|
List of identifiers of analysis elements. If empty, load all data. |
None
|
categories |
List[str]
|
List of categories |
None
|
order |
str
|
Order field |
None
|
offset |
int
|
Index of first record |
0
|
limit |
int
|
Number of records to be returned |
100
|
filters |
str
|
JSON string with query filter |
None
|
session |
SQLAlchemy
|
SQLAlchemy session |
None
|
orm_entities |
bool
|
If True, return mapping models, else domain models |
False
|
Returns:
| Type | Description |
|---|---|
|
Dictionary with 2 keys. [Data]: a list of AnalysisElementModel entities (if orm_entities==True) or a list of AnalysisElement (if orm_entities=False). [Total]: record count. |
save_analysis_element(organization_id, payload, logger=None, session=None)
Save analysis elements
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
organization_id |
uuid
|
Organization identifier |
required |
obj |
AnalysisElement
|
Analysis element object |
required |
session |
SQLAlchemy
|
SQLAlchemy session |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
AnalysisElement |
AnalysisElement
|
Analysis element object |