Skip to content

Organization unit

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

Delete organization unit entities.

Parameters:

Name Type Description Default
body EntitiesDeleteRequest

A list of entities to delete. 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 organization member profile

body

exception message

Returns:

Type Description
EntitiesDeleteBaseResponse

EntitiesDeleteBaseResponse

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

Return a details of organization unit.

Parameters:

Name Type Description Default
body EntityGetRequest

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 organization unit details

body

exception message

Returns:

Type Description
OrganizationUnitListResponse

A Dictionary with

  • "entities" as key , (List[OrganizationUnit]) as value

  • "total" as key : record count as value

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

Return a list of organization units.

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)
body

exception message

Body()

Raises:

Type Description
HTTPException
status_code

HTTP_400_BAD_REQUEST

message

Problem on get organization unit list

body

exception message

Returns:

Type Description
OrganizationUnitListResponse

A Dictionary with

  • "entities" as key , (List[OrganizationUnit]) as value

  • "total" as key : record count as value

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

Save or update an organization unit.

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 organization member profile details

body

exception message

Returns:

Name Type Description
OrganizationUnit OrganizationUnit

The new or updated OrganizationUnit