Procedure

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

Return a detail of procedure.

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 procedure details
body	exception message

Returns:

Type	Description
ProcedureListResponse	A Dictionary with "entities" as key , (List[Procedure]) as value "total" as key : record count as value

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

Return a list of procedures.

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 procedure list
body	exception message

Returns:

A Dictionary with

    - "entities" as key , (List[Procedure]) as value

    - "total" as key : record count as value

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

Save or update a Procedure.

Parameters:

Name	Type	Description	Default
body	EntityGetRequest	A list of 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 procedure details
body	exception message

Returns:

Name	Type	Description
Procedure	Procedure	The new or updated Procedure