Orsoft Doku
Dokumentace a nápověda pro IS Orsoft Open

Na základě poskytnutého Java zdrojového kódu pro `OrImportRestService` je zde návrh dokumentace pro API, které umožňuje manipulaci s daty pomocí REST volání. API poskytuje funkce pro zahájení procesu, manipulaci s daty a možná další operace s daty, které nejsou z kódu plně zřejmé.

### Základní informace

API Endpoint: `/orimport`

### 1. Zahájení procesu - URL: `/orimport/startDemon` - Metoda: POST - Přijímá: Parametr v URL - Vrací: TEXT_PLAIN - QueryParametr:

  1. `propertyFileName`: Název souboru s vlastnostmi (povinný)

- Popis: Tato metoda zahajuje proces na serveru s využitím konfiguračního souboru specifikovaného v parametru.

### 2. Nastavení dat - URL: `/orimport/data` - Metoda: POST - Přijímá: APPLICATION_JSON - Vrací: APPLICATION_JSON - Parametry:

  1. `json`: JSON reprezentující data k zpracování

- Popis: Tato metoda přijímá JSON objekt, který popisuje data k zpracování. Vrací výsledek operace v JSON formátu. - Příklady vstupu:

```json
{
  "EntityType": "type1",
  "Id": "123",
  "Properties": {
    "PropertyDesciptor": [
      {"Name": "Property1", "Value": "Value1"},
      {"Name": "Property2", "Value": "Value2"}
    ]
  }
}
```

### Chybové stavy - Popis: API může vrátit chybové stavy při selhání interních operací. Specifické kódy chyb a popisy nejsou definovány.

### Logování - API loguje důležité operace do souboru. Formát a obsah logování nejsou plně specifikovány.

Zde je tabulka s hodnotami `EntityType` z vašeho zdrojového kódu a sloupcem pro popis každé entity. Tuto tabulku můžete použít pro dokumentaci nebo další reference. Můžete ji také vyplnit podle potřeby pro každou entitu.

EntityType Popis Entity
UNITS Export měrných jednotek do MES
PERSONS Export pracovníků do MES
DEFLECTION Export typů odchylek z MES
NONCONFORMITIES Export typů neshod z MES
DOWNTIME Export typů prostojů z MES
WORK_CENTER Export pracovních středisek do MES
MATERIAL Export katalogu položek - materiálů do MES
EQUIPMENT Export nářadí do MES
TOOLS Export přípravku do MES
WORK_ORDER Export výrobního příkazu do MES
PRODUCT_DEFINITION_OPERATION Export pracovního postupu do MES
WORK_ORDER_OPERATION Export operací výrobního příkazu
STATEMENT_OF_DOWNTIME Import prostojů z MES
STATEMENT_OF_WORK Import hlášení výkonu z MES
STATEMENT_OF_NONCONFORMITIES Import hlášení neshod z MES
BUSINESS_PARTNERS Export katalogu odběratelů do externího systému
STOCKING Import skladové transakce z MES
ENABIDKA Import nabídek z Excelu
EPRODOBJ Import prodejních objednávek z Excelu
EPOPTAVKA Import poptávek z Excelu
OR_IMPORT_SERVANT Spuštění tiskového reportu na základě zadaných parametrů GA
CPOLOZKA_IMPORT další popisy budou doplněny později
CNARADI_IMPORT
OUZIV_IMPORT
CODBERATEL_IMPORT
CDODAVATEL_IMPORT
CADRESAFIRMY_IMPORT
OHKON_IMPORT
CSTROJ_IMPORT
CSTAND_KUS_KOMP_IMP
CKONSTR_KUS_KOMP_IMP
CTECH_POSTUP_OP_IMP
SHLASENI_OPERACE
SLBT_DOKLAD
SLBT_POHYB
SPOHYB_TXT
PALETIZACE
INTERNI_LOGISTIKA
SBALIKOVE_TRANSAKCE
SPOHYB_MOBILNI_APLIKACE
SMOBILNI_APLIKACE
ELEKTROTEST
SERIAL_NUMBER_SERVICE
TLAKOVA_ZKOUSKA
KONSTRUKCNI_KUSOVNIK
ODHLASOVANI_PRIDELENYCH_OPERACI
ODVADENI_VYROBY
HLASENI_VYROBY
PRIPRAVA_EXPEDICE_ZAKAZEK
SW_KONSTR_KUS_HLAV_IMP
SW_KONSTR_KUS_KOMP_IMP
SW_POLOZKA_ZADANKA
MOVEIT_PRODEJNI_NABIDKA
ENTITY_WEB_SERVICE
MOVEIT_PRODEJNI_NABIDKA_RADEK
MOVEIT_KONFIGURATOR_POLOZKA_ULOZENI
VYROBA_JADRA
ENTITY_IMPORT
FORMOVANI