Skip to content

United tool

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

Return a list of United tool.

Parameters:

Name Type Description Default
body EntitiesListRequest

A list of 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 united analysis element list

body

exception message

Returns:

Type Description
UnitedToolListResponse

A Dictionary with

  • "entities" as key , (List[UnitedTool]) as value
  • "total" as key : record count as value

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

Return a list of United tool.

Parameters:

Name Type Description Default
body EntitiesListRequest

A list of 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 united analysis element list

body

exception message

Returns:

A Dictionary with

    - "entities" as key , (List[UnitedTool]) as value
    - "total" as key : record count as value

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

Save or update a united tool.

Parameters:

Name Type Description Default
body UnitedTool

A list of requested entities. Defaults to Body().

required
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 save united tool

body

exception message

Returns:

Type Description
UnitedToolListResponse

A Dictionary with

  • "entities" as key , (List[UnitedTool]) as value
  • "total" as key : record count as value