Analysis element

delete(body=Body(), execution_id=None, token=Depends(oauth2_scheme)) async

Delete an analysis element.

Parameters:

Name	Type	Description	Default
body	EntitiesDeleteRequest	The requested entities. Defaults to Body().	Body()
execution_id	str	Unique identifier of the execution. Defaults to None.	None
token	str	The authentication token. Defaults to Depends(oauth2_scheme).	Depends(oauth2_scheme)

Raises:

Type	Description
HTTPException
status_code	HTTP_400_BAD_REQUEST
message	Problem on delete analysis element
body	exception message

Returns:

Name	Type	Description
EntitiesDeleteBaseResponse	EntitiesDeleteBaseResponse	The deleted entities

get(body=Body(), execution_id=None, token=Depends(oauth2_scheme)) async

Return a details of analysis element.

Parameters:

Name	Type	Description	Default
body	EntityGetRequest	The requested entity. Defaults to Body().	Body()
execution_id	str	Unique identifier of the execution. Defaults to None.	None
token	str	The authentication token. Defaults to Depends(oauth2_scheme).	Depends(oauth2_scheme)

Raises:

Type	Description
HTTPException
status_code	HTTP_400_BAD_REQUEST
message	Problem on get analysis element details
body	exception message

Returns:

Type	Description
AnalysisElementListResponse	A Dictionary with "entities" as key , (List[AnalysisElement]) as value "total" as key , record count as value

list(body=Body(), execution_id=None, token=Depends(oauth2_scheme)) async

Return a list of analysis element.

Parameters:

Name	Type	Description	Default
body	EntitiesListRequest	The requested entities. Defaults to Body().	Body()
execution_id	str	Unique identifier of the execution. Defaults to None.	None
token	str	The authentication token. Defaults to Depends(oauth2_scheme).	Depends(oauth2_scheme)

Raises:

Type	Description
HTTPException
status_code	HTTP_400_BAD_REQUEST
message	Problem on get analysis element list
body	exception message

Returns:

Type	Description
AnalysisElementListResponse	A Dictionary with "entities" as key , (List[AnalysisElement]) as value "total" as key , record count as value

list_by_category(body=Body(), execution_id=None, token=Depends(oauth2_scheme)) async

Return a list of analysis element by category.

Parameters:

Name	Type	Description	Default
body	EntitiesListRequestByCategory	The requested entities. Defaults to Body().	Body()
execution_id	str	Unique identifier of the execution. Defaults to None.	None
token	str	The authentication token. Defaults to Depends(oauth2_scheme).	Depends(oauth2_scheme)

Raises:

Type	Description
HTTPException
status_code	HTTP_400_BAD_REQUEST
message	Problem on get analysis element list by category
body	exception message

Returns:

Type	Description
AnalysisElementListResponse	A Dictionary with "entities" as key , (List[AnalysisElement]) as value "total" as key , record count as value

save(body=Body(), execution_id=None, token=Depends(oauth2_scheme)) async

Save a new analysis element.

Parameters:

Name	Type	Description	Default
OrganizationId		uuid = Organization identifier	required
Name		str = Analysis element name	required
Id		uuid = Analysis element identifier	required
Code		str = Analysis element code	required

Returns:

Name	Type	Description
AnalysisElement	AnalysisElement	The saved analysis element