API » History » Version 1
Denis Kildishev, 04/09/2020 08:45 PM
| 1 | 1 | Denis Kildishev | h1. API |
|---|---|---|---|
| 2 | |||
| 3 | h2. Experimental |
||
| 4 | |||
| 5 | h3. Test data |
||
| 6 | |||
| 7 | ed612ae4-ced3-408c-8d64-66d87981611f — id of document |
||
| 8 | 5b9946fe-585c-47f6-93bb-5bb2e37a04d3 — id of new location |
||
| 9 | b7088d84-9c96-4657-abab-7690585ddd8e — id of requirement |
||
| 10 | |||
| 11 | h3. Methods |
||
| 12 | |||
| 13 | PUT |
||
| 14 | http://localhost:9988/projects/someproject/documents/ed612ae4-ced3-408c-8d64-66d87981611f/addlocation |
||
| 15 | add location to doc with id before addloc |
||
| 16 | |||
| 17 | GET |
||
| 18 | http://localhost:9988/projects/someproject/documents/ed612ae4-ced3-408c-8d64-66d87981611f/locations |
||
| 19 | list all locations |
||
| 20 | |||
| 21 | GET |
||
| 22 | http://localhost:9988/projects/someproject/documents/ed612ae4-ced3-408c-8d64-66d87981611f/contents |
||
| 23 | get contents of document and all related resourses in form of multidata |
||
| 24 | have fields |
||
| 25 | *fileName* — name of xhtml file |
||
| 26 | *resources* — list of related resources |
||
| 27 | for example, "imgs/testDoc_html_2f94255ac1355d0d.jpg", "testDoc.xhtml", "imgs/testDoc_html_6a3c8113b28c3ae7.jpg" |
||
| 28 | and several files. File with html content have name «html» |
||
| 29 | |||
| 30 | DELETE |
||
| 31 | http://localhost:9988/projects/someproject/documents/location/5b9946fe-585c-47f6-93bb-5bb2e37a04d3 |
||
| 32 | removes location |
||
| 33 | |||
| 34 | POST |
||
| 35 | http://localhost:9988/projects/someproject/documents/location/5b9946fe-585c-47f6-93bb-5bb2e37a04d3/addfragment |
||
| 36 | BODY |
||
| 37 | { |
||
| 38 | „fragment“:“test“; |
||
| 39 | } |
||
| 40 | adds fragment to location |
||
| 41 | |||
| 42 | |||
| 43 | POST |
||
| 44 | http://localhost:9988/projects/someproject/documents/location/5b9946fe-585c-47f6-93bb-5bb2e37a04d3/removefragment |
||
| 45 | BODY |
||
| 46 | { |
||
| 47 | „fragment“:“test“; |
||
| 48 | } |
||
| 49 | removes fragment from location |
||
| 50 | |||
| 51 | |||
| 52 | |||
| 53 | POST |
||
| 54 | http://localhost:9988/projects/someproject/documents/location/5b9946fe-585c-47f6-93bb-5bb2e37a04d3/linkto/b7088d84-9c96-4657-abab-7690585ddd8e |
||
| 55 | add link between requirement and location |
||
| 56 | |||
| 57 | DELETE |
||
| 58 | http://localhost:9988/projects/someproject/documents/location/5b9946fe-585c-47f6-93bb-5bb2e37a04d3/linkto/b7088d84-9c96-4657-abab-7690585ddd8e |
||
| 59 | remove link between requirement and location |