Skip to content

flywheel.api.dimse_api

DimseApi

Bases: object

create_project_aet(body, **kwargs)

Create a new DIMSE project AET

Will create a new DIMSE AET that refers to a Flywheel project. AETs can only be created by admins and use drone access via DIMSE. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
body ProjectAETInput
required
async_ (bool, optional)

Perform the request asynchronously

required

create_project_aet_with_http_info(body, **kwargs)

Create a new DIMSE project AET

Will create a new DIMSE AET that refers to a Flywheel project. AETs can only be created by admins and use drone access via DIMSE. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
body ProjectAETInput
required
async_ (bool, optional)

Perform the request asynchronously

required

create_service_aet(body, **kwargs)

Create a new DIMSE service AET

Will create a new DIMSE AET that refers to an external DICOM node. Service AETs can be used to issue C-MOVEs to from project AETs. Requires login. AETs can only be created by admins. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
body union[ProjectAETInput, ServiceAETInput]
required
async_ (bool, optional)

Perform the request asynchronously

required

create_service_aet_with_http_info(body, **kwargs)

Create a new DIMSE service AET

Will create a new DIMSE AET that refers to an external DICOM node. Service AETs can be used to issue C-MOVEs to from project AETs. Requires login. AETs can only be created by admins. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
body union[ProjectAETInput, ServiceAETInput]
required
async_ (bool, optional)

Perform the request asynchronously

required

delete_project_aet(project_aet, **kwargs)

Delete a DIMSE project AET

Delete DIMSE project by AET. AETs can only be deleted by admins. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
project_aet str
required
async_ (bool, optional)

Perform the request asynchronously

required

delete_project_aet_with_http_info(project_aet, **kwargs)

Delete a DIMSE project AET

Delete DIMSE project by AET. AETs can only be deleted by admins. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
project_aet str
required
async_ (bool, optional)

Perform the request asynchronously

required

delete_service_aet(service_aet, **kwargs)

Delete a DIMSE service AET

Delete DIMSE service by AET. AETs can only be deleted by admins. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
service_aet str
required
async_ (bool, optional)

Perform the request asynchronously

required

delete_service_aet_with_http_info(service_aet, **kwargs)

Delete a DIMSE service AET

Delete DIMSE service by AET. AETs can only be deleted by admins. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
service_aet str
required
async_ (bool, optional)

Perform the request asynchronously

required

get_all_project_aets(**kwargs)

List all DIMSE project AETs

Will list all DIMSE AETs referring to a Flywheel project. Project AETs can be used to issue C-FIND and C-MOVE on Flywheel projects. Requires login and admin privilege. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
async_ (bool, optional)

Perform the request asynchronously

required

get_all_project_aets_with_http_info(**kwargs)

List all DIMSE project AETs

Will list all DIMSE AETs referring to a Flywheel project. Project AETs can be used to issue C-FIND and C-MOVE on Flywheel projects. Requires login and admin privilege. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
async_ (bool, optional)

Perform the request asynchronously

required

get_all_service_aets(**kwargs)

List all DIMSE services AETs

Will list all DIMSE AETs referring to external DICOM nodes. Requires login and admin privilege. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
async_ (bool, optional)

Perform the request asynchronously

required

get_all_service_aets_with_http_info(**kwargs)

List all DIMSE services AETs

Will list all DIMSE AETs referring to external DICOM nodes. Requires login and admin privilege. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
async_ (bool, optional)

Perform the request asynchronously

required

get_project_aet(project_aet, **kwargs)

Get DIMSE project AET

Get DIMSE project by AET, id or project id. Requires admin privilege. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
project_aet str
required
async_ (bool, optional)

Perform the request asynchronously

required

get_project_aet_with_http_info(project_aet, **kwargs)

Get DIMSE project AET

Get DIMSE project by AET, id or project id. Requires admin privilege. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
project_aet str
required
async_ (bool, optional)

Perform the request asynchronously

required

get_service_aet(service_aet, **kwargs)

Get DIMSE service by AET or id

Get a DIMSE service. Requires login and admin privilege. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
service_aet str
required
async_ (bool, optional)

Perform the request asynchronously

required

get_service_aet_with_http_info(service_aet, **kwargs)

Get DIMSE service by AET or id

Get a DIMSE service. Requires login and admin privilege. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
service_aet str
required
async_ (bool, optional)

Perform the request asynchronously

required