Skip to content

Commit dffc3ee

Browse files
neildsouthwoodheadio
authored andcommitted
updating APi docs
Signed-off-by: Neil South <[email protected]>
1 parent de8d857 commit dffc3ee

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

docs/api/rest/config.md

+39
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,45 @@ curl --location --request GET 'http://localhost:5000/config/source/USEAST'
345345

346346
---
347347

348+
## GET /config/source/getbyaetitle/{aeTitle}
349+
350+
Returns configurations for the specified calling (source) AET.
351+
352+
### Parameters
353+
354+
| Name | Type | Description |
355+
| ---- | ------ | ------------------------------------------ |
356+
| name | string | The aeTitle of an AE Title to be retrieved. |
357+
358+
### Responses
359+
360+
Response Content Type: JSON - [SourceApplicationEntity[]](xref:Monai.Deploy.InformaticsGateway.Api.SourceApplicationEntity).
361+
362+
| Code | Description |
363+
| ---- | --------------------------------------------------------------------------------------------------------------------------------------- |
364+
| 200 | AE Titles retrieved successfully. |
365+
| 404 | Named source not found. |
366+
| 500 | Server error. The response will be a [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) object with server error details. |
367+
368+
### Example Request
369+
370+
```bash
371+
curl --location --request GET 'http://localhost:5000/config/source/getbyaetitle/USEAST'
372+
```
373+
374+
### Example Response
375+
376+
```json
377+
[{
378+
"name": "USEAST",
379+
"aeTitle": "PACSUSEAST",
380+
"hostIp": "10.20.3.4"
381+
},
382+
{...}]
383+
```
384+
385+
---
386+
348387
## POST /config/source
349388

350389
Adds a new calling (source) AE Title to the Informatics Gateway to allow DICOM instances from the specified IP address and AE Title.

0 commit comments

Comments
 (0)