„ArchiveOverCLI” változatai közötti eltérés
(→Szalag műveletek) |
(→Szalag műveletek) |
||
8. sor: | 8. sor: | ||
==Szalag műveletek== | ==Szalag műveletek== | ||
− | * útvonal: '''/tape''' | + | * útvonal: '''<big>/tape</big>''' |
− | ** ''GET'' - lekérdezhető az elérhető szalagok azonosítói | + | ** ''<big>GET</big>'' - lekérdezhető az elérhető szalagok azonosítói |
*** paraméterek: - | *** paraméterek: - | ||
*** OPCIONÁLIS paraméterek: | *** OPCIONÁLIS paraméterek: | ||
23. sor: | 23. sor: | ||
</pre> | </pre> | ||
::* példa:<br><pre> curl --header "token:<TOKEN>" -X GET 'https://api.archiver.niif.hu/tape/'</pre><br> | ::* példa:<br><pre> curl --header "token:<TOKEN>" -X GET 'https://api.archiver.niif.hu/tape/'</pre><br> | ||
− | :* ''POST'' - szalag nevét lehet beállítani | + | ::<hr /><br /> |
+ | :* ''<big>POST</big>'' - szalag nevét lehet beállítani | ||
::* paraméterek: | ::* paraméterek: | ||
:::* tape_id - szalag azonosítója | :::* tape_id - szalag azonosítója | ||
29. sor: | 30. sor: | ||
::* válasz: - | ::* válasz: - | ||
::* példa:<br><pre> curl --header "token:<TOKEN>" https://api.archiver.niif.hu/tape/ --data "tape_id=<ID>&name=<NAME>"</pre><br> | ::* példa:<br><pre> curl --header "token:<TOKEN>" https://api.archiver.niif.hu/tape/ --data "tape_id=<ID>&name=<NAME>"</pre><br> | ||
− | :* ''DELETE'' - szalag tartalmának törlése | + | ::<hr /><br /> |
+ | :* ''<big>DELETE</big>'' - szalag tartalmának törlése | ||
::* paraméterek: | ::* paraméterek: | ||
:::* tape_id - melyik szalag tartalmát szeretnénk törölni | :::* tape_id - melyik szalag tartalmát szeretnénk törölni |
A lap 2015. május 7., 10:29-kori változata
Lehetőség van az archiválást nem csak a webes felületen keresztül használni. Erre a célra ki lett alakítva egy RESTAPI interfész, amin keresztül elérhetőek a szükséges funkciók.
Az API használatát segédletekkel megtalálhatod https://api.archiver.niif.hu/?help oldalon.
A használathoz szükséges token a webes felületen a Token fül alatt érhető el.
Tartalomjegyzék
[elrejtés]Funkcionalitások kivonatolt segédlete:
Szalag műveletek
- útvonal: /tape
- GET - lekérdezhető az elérhető szalagok azonosítói
- paraméterek: -
- OPCIONÁLIS paraméterek:
- tape_id - amennyiben csak egy szalag adatai szeretnénk lekérdezni
- válasz:
- Egy JSON, mely tartalmazza az elérhető szalagok azonosítóit és neveit.
- Egy JSON, mely tartalmazza az elérhető szalagok azonosítóit és neveit.
- GET - lekérdezhető az elérhető szalagok azonosítói
[ { "id" : <szalag id>, "name" : "szalag neve" }, ... ]
- példa:
curl --header "token:<TOKEN>" -X GET 'https://api.archiver.niif.hu/tape/'
- példa:
- POST - szalag nevét lehet beállítani
- paraméterek:
- tape_id - szalag azonosítója
- name - beállítandó név
- válasz: -
- példa:
curl --header "token:<TOKEN>" https://api.archiver.niif.hu/tape/ --data "tape_id=<ID>&name=<NAME>"
- DELETE - szalag tartalmának törlése
- paraméterek:
- tape_id - melyik szalag tartalmát szeretnénk törölni
- válasz: -
- példa:
curl --header "token:<TOKEN>" -X DELETE 'https://api.archiver.niif.hu/tape/?tape_id=<ID>'
Feladatokkal kapcsolatos műveletek
- útvonal: /archive
- POST - új archiválási feladata beküldése
- GET - lekérdezhető a beküldött feladat állapota
- útvonal: /restore
- POST - új visszaállítási feladata beküldése
- GET - lekérdezhető a beküldött feladat állapota
Fájl műveletek
- útvonal: /file
- GET - lekérdezhető a szalagon található fájlok listája