ArchiveOverCLI

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.

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.
        

          [
            { "id" : <szalag id>,
              "name" : "szalag neve"
            },
            ...
          ]

• példa:
  

       curl --header "token:<TOKEN>" -X GET 'https://api.archiver.niif.hu/tape/'

  
  

• 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