13.1.3. APIs¶

13.1.3.1. RESTful APIs¶

Clara DICOM Adapter supports the following RESTful APIs on (default) port 5000.

13.1.3.1.1. GET /api/config/claraaetitle¶

13.1.3.1.2. GET /api/config/sourceaetitle¶

13.1.3.1.3. GET /api/config/destinationaetitle¶

Retrieves list of (Clara|Source|Destination) AE Titles.

13.1.3.1.3.1. Parameters¶

N/A

13.1.3.1.3.2. Responses¶

Response Content Type: JSON

Returns list of AE Titles (in Kubernetes CRD JSON format):

Name	Type	Description
apiVersion	string	CRD apiVersion
items	crd[]	An array of CRDs
kind	string	ClaraAeTitleList, SourceList or DestinationList
metadata	object	A unique ID representing the payload associated with the job where the results are stored

Code	Description
200	CRDs retrieved successfully .

13.1.3.1.3.3. Example Request¶

curl --location --request GET 'http://localhost:5000/api/config/destinationaetitle'

13.1.3.1.4. POST /api/config/claraaetitle¶

Create a new Clara AE Title.

13.1.3.1.4.1. Parameters¶

Required fields listed below. Refer to Schema section for complete list.

Name	Type	Description
name	string	name of CRD
pipelineId	string	Pipeline ID to be mapped to the AE Title
aeTitle	string	Clara AE Title

13.1.3.1.4.2. Responses¶

Response Content Type: JSON

Returns created CRD formatted in JSON.

Name	Type	Description
apiVersion	string	CRD apiVersion
kind	string	ClaraAeTitle
spec	Clara AET	Clara AE Title specs

Code	Description
200	CRD created successfully .
400	CRD already exists or invalid.

13.1.3.1.4.3. Example Request¶

curl --location --request POST 'http://localhost:5000/api/config/claraaetitle' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "clara-brain-tumor",
    "pipelineId": "7b9cda79ed834fdc87cd4169216c4011",
    "aeTitle": "BrainTumorModel",
    "timeout": 0
}'

13.1.3.1.5. POST /api/config/sourceaetitle¶

Create a new Source AE Title.

13.1.3.1.5.1. Parameters¶

Required fields listed below. Refer to Schema section for complete list.

Name	Type	Description
hostIp	string	Host name or IP address of DICOM source
aeTitle	string	AE Title of DICOM source

13.1.3.1.5.2. Responses¶

Response Content Type: JSON

Returns created CRD formatted in JSON.

Name	Type	Description
apiVersion	string	CRD apiVersion
kind	string	Source
spec	Clara AET	Clara AE Title specs

Code	Description
200	CRDs created successfully .
400	CRDs already exists or invalid.

13.1.3.1.5.3. Example Request¶

curl --location --request POST 'http://localhost:5000/api/config/sourceaetitle' \
--header 'Content-Type: application/json' \
--data-raw '{
    "hostIp": "1.2.3.4",
    "aeTitle": "Orthanc"

}'

13.1.3.1.6. POST /api/config/destinationaetitle¶

Create a new Destination AE Title.

13.1.3.1.6.1. Parameters¶

Required fields listed below. Refer to Schema section for complete list.

Name	Type	Description
name	string	Name of DICOM instance that can be referenced by Results Service
hostIp	string	Host name or IP address of DICOM destination
aeTitle	string	AE Title of DICOM destination
port	int	Port of DICOM destination

13.1.3.1.6.2. Responses¶

Response Content Type: JSON

Returns created CRD formatted in JSON.

Name	Type	Description
apiVersion	string	CRD apiVersion
kind	string	Destination
spec	Clara AET	Clara AE Title specs

Code	Description
200	CRDs created successfully .
400	CRDs already exists or invalid.

13.1.3.1.6.3. Example Request¶

curl --location --request POST 'http://localhost:5000config/destinationaetitle' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name":"pacs",
    "hostIp": "10.20.30.40",
    "aeTitle": "ARCHIVEX",
    "port": 104

}'

13.1.3.1.7. DELETE /api/config/claraaetitle/[name]¶

13.1.3.1.8. DELETE /api/config/sourceaetitle/[name]¶

13.1.3.1.9. DELETE /api/config/destinationaetitle/[name]¶

Deletes a (Clara|Source|Destination) AE Title.

13.1.3.1.9.1. Parameters¶

Name	Type	Description
name	string	`name` of the Kubernetes custom resource. Note: name can be found in the metadata section of a CRD.

13.1.3.1.9.2. Responses¶

Response Content Type: JSON

Returns status of the deleted CRD.

Name	Type	Description
apiVersion	string	v1
status	string	Status of the call.
kind	string	Status

Code	Description
200	CRDs retrieved successfully .

13.1.3.1.9.3. Example Request¶

curl --location --request DELETE 'http://localhost:5000/api/config/claraaetitle/clara-brain-tumor' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "clara-brain-tumor1",
    "pipelineId": "7b9cda79ed834fdc87cd4169216c4011",
    "aeTitle": "BrainTumor1",
    "timeout": 0
}'