Documented fda rest api
This commit is contained in:
@@ -26,6 +26,50 @@ To use the FDA libary in an other project use:
|
||||
## REST
|
||||
FDA offers a rest service to execute scans. There are 3 distinct service for fda scan, fdaq and cdump.
|
||||
|
||||
### FDA Service
|
||||
|
||||
Submit scan
|
||||
|
||||
```
|
||||
PUT fda/{trackingId}
|
||||
Accept: application/xml
|
||||
|
||||
204 - Success
|
||||
|
||||
```
|
||||
|
||||
Stop/cancel scan
|
||||
|
||||
```
|
||||
DELETE fda/{trackingId}
|
||||
|
||||
204 - Success
|
||||
```
|
||||
|
||||
Stop all scans
|
||||
|
||||
```
|
||||
DELETE fda
|
||||
|
||||
204 - Success
|
||||
```
|
||||
|
||||
Check if scan is running
|
||||
|
||||
```
|
||||
GET fda/{trackingId}/running
|
||||
|
||||
200 - true/false
|
||||
```
|
||||
|
||||
Wait for scan done (blocks until scan is done)
|
||||
|
||||
```
|
||||
GET fda/{trackingId}/done
|
||||
|
||||
204 - Success
|
||||
```
|
||||
|
||||
# Notes
|
||||
## Upgrade FDA 1.x to 2.x
|
||||
In existing fda.properties file the following property need to be added: `ch.psi.fda.aq.data.dir=../data`
|
||||
Reference in New Issue
Block a user