Simplifier-Token wird generiert

Anfrage

curl -X POST 'https://your.simplifier.url/genToken/' \
-H 'content-type: application/json; charset=UTF-8' \
--data-raw '{"user":"<api_user_name>","pass":"<password>"}'

Antwort

{"result":"<simplifier_token>","success":true}

Transportpaket exportieren

Wenn der Export startet, wird der Transport in die Warteschlange eingereiht. Die Warteschlange wird schrittweise abgearbeitet.

Export anfordern

curl -X POST 'https://your.simplifier.url/UserInterface/api/transport/export' \
-H 'content-type: application/json; charset=UTF-8' \
-H 'simplifiertoken: <simplifier_token>' \
--data-raw '{"transportCollectionName":"<transport_package_name"}'

Export antworten

{"processId":"<export_process_id>"}

Exportstatus anfordern

curl 'https://your.simplifier.url/UserInterface/api/transport/export/status/<process_id>' \
-H 'content-type: application/json; charset=utf-8' \
-H 'simplifiertoken: <simplifier_token>'

Exportstatus antworten

{"processId":"<process_id>","transportCollectionName":"<transport_package_name>","exporter":"<export_user>","statusI18n":"<state_of_the_transport>","statusData":["<state_data>"],"changed":"<change_date>"}

Download anfordern

Wenn sich der Status des Exports in transportExportStatus_Finished geändert hat, kann das Paket heruntergeladen werden. Der Download kann nach dem Start des Prozesses ausgelöst werden, es ist nicht erforderlich, auf den Endzustand zu warten.

curl 'https://your.simplifier.url/UserInterface/api/transport/export/<process_id>?SimplifierToken=<simplifier_token>'

Download antworten

Die Antwort ist application/octet-stream

Exportwarteschlange anfordern

Beim gleichzeitigen Exportieren mehrerer Pakete ist es möglich, die globale Exportwarteschlange zu überprüfen

curl 'https://your.simplifier.url/UserInterface/api/transport/export/queue' \
-H 'SimplifierToken: <simplifier_token>'

Exportwarteschlange antworten

{"processQueue":[<list_of_export_processes>]}

Transportpaket importieren

Anfrage zum Hochladen

Um einen Importvorgang zu starten, müssen Sie die Transportdatei als Multipart hochladen

curl -F session=<optional_session> -F start=<start_byte_of_part> -F end=<end_byte_of_part> -F dataSize=<size_of_part> -F num=<part_number> -F count=<number_of_parts> -F data=@<local_filename> https://your.simplifier.url/UserInterface/api/html5Uploader?SimplifierToken=<simplifier_token>

Antwort zum Hochladen

{"result":"<optional_session>","success":true}

Es wird empfohlen, den Upload in kleinere Teile aufzuteilen und die Sitzung für jede einzelne Anfrage wiederzuverwenden. Es ist jedoch auch möglich, die gesamte Datei auf einmal zu senden, was jedoch je nach Servereinstellungen und Dateigröße zu Problemen führen kann.

curl -F session=<session_id> -F start=0 -F end=<file_size> -F dataSize=<file_size> -F num=1 -F count=1 -F data=@<file_name> https://your.simplifier.url/UserInterface/api/html5Uploader?SimplifierToken=<simplifier_token>

Import anfordern

curl -X POST 'https://your.simplifier.url/UserInterface/api/transport/import' \
-H 'content-type: application/json; charset=UTF-8' \
-H 'simplifiertoken: <simplifier_token>' \
--data-raw '{"uploadSession":"<upload_session>","overwrite":<true|false>,"dryRun":<true|false>}'

Import antworten

{"processId":"<process_id>"}

 

Importstatus anfordern

curl 'https://your.simplifier.url/UserInterface/api/transport/import/status/<process_id>' \
-H 'content-type: application/json; charset=utf-8' \
-H 'simplifiertoken: <simplifier_token>'

Importstatus antworten

{"processId":"<process_id>","importert":"<import_user>","statusI18n":"<state_of_the_transport>","statusData":["<state_data>"],"changed":"<change_date>"}

Importwarteschlange anfordern

Beim gleichzeitigen Importieren mehrerer Pakete ist es möglich, die globale Importwarteschlange zu überprüfen

curl 'https://your.simplifier.url/UserInterface/api/transport/import/queue' \
-H 'SimplifierToken: <simplifier_token>'

Importwarteschlange antworten

{"processQueue":[<list_of_import_processes>]}