Dokument

GET

/documents

Získá kolekci BO Dokument

GET

/documents/meta/dataprotection

Získá seznam položek BO, které mohou být chráněny na BO Dokument

GET

/documents/views/{view}

Získá pohled nad BO Dokument

GET

/documents/{id}

Získá daný BO Dokument

GET

/documents/{id}/contents

Získá řádky kolekce Obsah dokumentu

GET

/documents/{id}/contents/{id1}

Získá daný řádek kolekce Obsah dokumentu

GET

/documents/{id}/docconfirmation

Získá záznam o schvalování k danému dokladu

GET

/documents/{id}/iseditlock

Otestuje, zda existuje editační zámek na daném BO Dokument

GET

/documents/{id}/meta/dataprotection

Získá seznam chráněných položek, které jsou na BO Dokument aktuálnímu uživateli znepřístupněny

GET

/documents/{id}/participants

Získá řádky kolekce Účastník dokumentu

GET

/documents/{id}/participants/{id1}

Získá daný řádek kolekce Účastník dokumentu

GET

/documents/{id}/userparameters

Získá seznam uživatelských parametrů včetně jejich hodnot k danému BO Dokument

POST

/documents

Vytvoří nový BO Dokument

POST

/documents/query

Vyhodnotí query dotaz nad BO Dokument

POST

/documents/{id}/contents

Vytvoří nový řádek v kolekci Obsah dokumentu

POST

/documents/{id}/participants

Vytvoří nový řádek v kolekci Účastník dokumentu

PUT

/documents/{id}

Modifikuje daný BO Dokument

PUT

/documents/{id}/contents/{id1}

Modifikuje řádek v kolekci Obsah dokumentu

PUT

/documents/{id}/docconfirmation/confirm

Schválení daného dokladu

PUT

/documents/{id}/docconfirmation/reject

Zamítnutí schválení daného dokladu

PUT

/documents/{id}/docconfirmation/return

Vrátí daný doklad k doplnění

PUT

/documents/{id}/docconfirmation/start

Zahájí schvalování daného dokladu

PUT

/documents/{id}/editlock

Vytvoří editační zámek na daném BO Dokument

PUT

/documents/{id}/editunlock

Zruší editační zámek na daném BO Dokument

PUT

/documents/{id}/participants/{id1}

Modifikuje řádek v kolekci Účastník dokumentu

DELETE

/documents/{id}

Smaže BO Dokument

DELETE

/documents/{id}/contents/{id1}

Smaže řádek z kolekce Obsah dokumentu

DELETE

/documents/{id}/participants/{id1}

Smaže řádek z kolekce Účastník dokumentu

Metadata - Perzistentní položky

busorder_id string (busorder) relace

Zakázka, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

busproject_id string (busproject) relace

Projekt, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

bustransaction_id string (bustransaction) relace

Obch. případ, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

category_id string (documentcategory) relace

Kategorie dokumentu, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

closed boolean

Vyřízen, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

contents array (documentcontent) relace

kolekce BO Obsah dokumentu, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

correctedat$date string

Opraveno, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

correctedby_id string (securityuser) relace

Opravil, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

correctiontime$date string

Opraveno, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

createdat$date string

Vytvořeno, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

createdby_id string (securityuser) relace

Vytvořil, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

description string (150)

Popis, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

division_id string (division) relace

Středisko, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

docdate$date string

Datum dok., pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole nepodporuje ochranu dat/GDPR

docqueue_id string (docqueue) relace

Zdrojová řada, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

docstate integer

Stav, pole vlastněné tabulkou, možné řadit a filtrovat

driverparams string

Parametry ovladače, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

errorcode integer

Kód chyby, pole vlastněné tabulkou, možné řadit a filtrovat

errormessage string

Popis chyby, pole vlastněné tabulkou, možné řadit a filtrovat

firm_id string (firm) relace

Firma, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

firmoffice_id string (firmoffice) relace

Provozovna, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

interrupted boolean

Přerušeno, pole vlastněné tabulkou, možné řadit a filtrovat

lockedby_id string (securityuser) relace

Uživatel zamykající dokument, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

objversion integer

Verze objektu, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

ordnumber integer

Pořadové číslo, pole vlastněné tabulkou, možné řadit a filtrovat

participants array (documentparticipant) relace

kolekce BO Účastník dokumentu, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

period_id string (period) relace

Období, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

person_id string (person) relace

Osoba, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

processingtype integer

Způsob zpracování, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

ruledriverparams string

Parametry ovladače z pravidla, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

Metadata - Neperzistentní položky

classid string (26)

ID třídy, pouze pro čtení, fkAnsiCaseSensitive, pole nepodporuje ochranu dat/GDPR

displayname string (24)

Číslo dok., pouze pro čtení

docstatename string (100)

Stav (název)

errormessageline string (512)

Popis chyby (jednořádkový)

id string (10)

Vlastní ID, pouze pro čtení, fkAnsiCaseSensitive, pole nepodporuje ochranu dat/GDPR

newrelateddocument_id string (10)

ID dokladu pro připojení, fkAnsiCaseSensitive

newrelatedtype integer

Typ relace

processingtypename string (100)

Způsob zpracování (název)

revided_id string (document) relace

ID revidovaného objektu, pouze pro čtení

revision integer

Číslo revize, pouze pro čtení

revisionauthor_id string (securityuser) relace

Autor revize, pouze pro čtení

revisiondate$date string

Datum revize, pouze pro čtení

revisiondescription string (500)

Popis revize, pouze pro čtení

totalcompressedsize integer

Komprimovaná velikost dat

totaloriginalsize integer

Původní velikost dat

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request

GET

https://atd.abra.eu/demodata/documents?take=1

GET

https://atd.abra.eu/demodata/documents/{id}
Response
{
    "objversion": 1,
    "docqueue_id": "N700000101",
    "period_id": "1M00000101",
    "ordnumber": 1,
    "docdate$date": "2017-08-10T22:00:00.000Z",
    "createdby_id": "1200000101",
    "correctedby_id": null,
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "closed": false,
    "correctiontime$date": null,
    "description": "",
    "division_id": null,
    "category_id": "2000000000",
    "firm_id": "3000000101",
    "firmoffice_id": "3000000101",
    "docstate": 0,
    "processingtype": 1,
    "person_id": null,
    "interrupted": false,
    "errorcode": 0,
    "errormessage": "",
    "driverparams": "",
    "contents": [
        {
            "correctedby_id": null,
            "correctiontime$date": null,
            "createdby_id": "1200000101",
            "creationtime$date": "2017-08-11T15:06:30.664Z",
            "description": "",
            "externalfile": false,
            "filename": "GenLogo.jpg",
            "id": "1200000101",
            "objversion": 1,
            "parent_id": "1300000101",
            "pathandfilename": "",
            "posindex": 1,
            "specification": 0
        }
    ],
    "participants": [],
    "ruledriverparams": "",
    "lockedby_id": null,
    "createdat$date": "2017-08-11T15:06:56.100Z",
    "correctedat$date": null
}
Request POST

POST

https://atd.abra.eu/demodata/query
{"class": "documents", "take": "1"}

POST

https://atd.abra.eu/demodata/documents/query
{"take": "1"}
Response
{
    "objversion": 1,
    "docqueue_id": "N700000101",
    "period_id": "1M00000101",
    "ordnumber": 1,
    "docdate$date": "2017-08-10T22:00:00.000Z",
    "createdby_id": "1200000101",
    "correctedby_id": null,
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "closed": false,
    "correctiontime$date": null,
    "description": "",
    "division_id": null,
    "category_id": "2000000000",
    "firm_id": "3000000101",
    "firmoffice_id": "3000000101",
    "docstate": 0,
    "processingtype": 1,
    "person_id": null,
    "interrupted": false,
    "errorcode": 0,
    "errormessage": "",
    "driverparams": "",
    "contents": [
        {
            "correctedby_id": null,
            "correctiontime$date": null,
            "createdby_id": "1200000101",
            "creationtime$date": "2017-08-11T15:06:30.664Z",
            "description": "",
            "externalfile": false,
            "filename": "GenLogo.jpg",
            "id": "1200000101",
            "objversion": 1,
            "parent_id": "1300000101",
            "pathandfilename": "",
            "posindex": 1,
            "specification": 0
        }
    ],
    "participants": [],
    "ruledriverparams": "",
    "lockedby_id": null,
    "createdat$date": "2017-08-11T15:06:56.100Z",
    "correctedat$date": null
}
Request

POST

https://atd.abra.eu/demodata/documents?select=id
Body
{
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "category_id": "2000000000",
    "closed": false,
    "contents": [
        {
            "correctedby_id": null,
            "correctiontime$date": null,
            "createdby_id": "1200000101",
            "creationtime$date": "2017-08-11T15:06:30.664Z",
            "description": "",
            "externalfile": false,
            "filename": "GenLogo.jpg",
            "id": "1200000101",
            "objversion": 1,
            "parent_id": "1300000101",
            "pathandfilename": "",
            "posindex": 1,
            "specification": 0
        }
    ],
    "correctedat$date": null,
    "correctedby_id": null,
    "correctiontime$date": null,
    "createdat$date": "2017-08-11T15:06:56.100Z",
    "createdby_id": "1200000101",
    "description": "",
    "division_id": null,
    "docdate$date": "2017-08-10T22:00:00.000Z",
    "docqueue_id": "N700000101",
    "docstate": 0,
    "driverparams": "",
    "errorcode": 0,
    "errormessage": "",
    "firm_id": "3000000101",
    "firmoffice_id": "3000000101",
    "interrupted": false,
    "lockedby_id": null,
    "ordnumber": 1,
    "participants": [],
    "period_id": "1M00000101",
    "person_id": null,
    "processingtype": 1,
    "ruledriverparams": ""
}
Response
{
    "id": "1600000101"
}
Request

PUT

https://atd.abra.eu/demodata/documents/{id}?select=id
Body
{
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "category_id": "2000000000",
    "closed": false,
    "contents": [
        {
            "correctedby_id": null,
            "correctiontime$date": null,
            "createdby_id": "1200000101",
            "creationtime$date": "2017-08-11T15:06:30.664Z",
            "description": "",
            "externalfile": false,
            "filename": "GenLogo.jpg",
            "id": "1200000101",
            "objversion": 1,
            "parent_id": "1300000101",
            "pathandfilename": "",
            "posindex": 1,
            "specification": 0
        }
    ],
    "correctedat$date": null,
    "correctedby_id": null,
    "correctiontime$date": null,
    "createdat$date": "2017-08-11T15:06:56.100Z",
    "createdby_id": "1200000101",
    "description": "",
    "division_id": null,
    "docdate$date": "2017-08-10T22:00:00.000Z",
    "docqueue_id": "N700000101",
    "docstate": 0,
    "driverparams": "",
    "errorcode": 0,
    "errormessage": "",
    "firm_id": "3000000101",
    "firmoffice_id": "3000000101",
    "interrupted": false,
    "lockedby_id": null,
    "ordnumber": 1,
    "participants": [],
    "period_id": "1M00000101",
    "person_id": null,
    "processingtype": 1,
    "ruledriverparams": ""
}
Response
{
    "id": "1600000101"
}

DELETE

https://atd.abra.eu/demodata/documents/{id}
Response
200 - OK Everything worked as expected.
Dávkové zprocování záznamů Request

PUT

https://atd.abra.eu/demodata//batch
  • CREATE
  • UPDATE
  • DELETE
Body - Create
{
    "items": [
        {
            "type": "create",
            "id": "id0",
            "data": {
                "class_id": "documents",
                "object_data": {
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "category_id": "2000000000",
                    "closed": false,
                    "contents": [
                        {
                            "correctedby_id": null,
                            "correctiontime$date": null,
                            "createdby_id": "1200000101",
                            "creationtime$date": "2017-08-11T15:06:30.664Z",
                            "description": "",
                            "externalfile": false,
                            "filename": "GenLogo.jpg",
                            "id": "1200000101",
                            "objversion": 1,
                            "parent_id": "1300000101",
                            "pathandfilename": "",
                            "posindex": 1,
                            "specification": 0
                        }
                    ],
                    "correctedat$date": null,
                    "correctedby_id": null,
                    "correctiontime$date": null,
                    "createdat$date": "2017-08-11T15:06:56.100Z",
                    "createdby_id": "1200000101",
                    "description": "",
                    "division_id": null,
                    "docdate$date": "2017-08-10T22:00:00.000Z",
                    "docqueue_id": "N700000101",
                    "docstate": 0,
                    "driverparams": "",
                    "errorcode": 0,
                    "errormessage": "",
                    "firm_id": "3000000101",
                    "firmoffice_id": "3000000101",
                    "interrupted": false,
                    "lockedby_id": null,
                    "ordnumber": 1,
                    "participants": [],
                    "period_id": "1M00000101",
                    "person_id": null,
                    "processingtype": 1,
                    "ruledriverparams": ""
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "documents",
                "object_data": {
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "category_id": "2000000000",
                    "closed": false,
                    "contents": [
                        {
                            "correctedby_id": null,
                            "correctiontime$date": null,
                            "createdby_id": "1200000101",
                            "creationtime$date": "2017-08-11T15:06:30.664Z",
                            "description": "",
                            "externalfile": false,
                            "filename": "GenLogo.jpg",
                            "id": "1200000101",
                            "objversion": 1,
                            "parent_id": "1300000101",
                            "pathandfilename": "",
                            "posindex": 1,
                            "specification": 0
                        }
                    ],
                    "correctedat$date": null,
                    "correctedby_id": null,
                    "correctiontime$date": null,
                    "createdat$date": "2017-08-11T15:06:56.100Z",
                    "createdby_id": "1200000101",
                    "description": "",
                    "division_id": null,
                    "docdate$date": "2017-08-10T22:00:00.000Z",
                    "docqueue_id": "N700000101",
                    "docstate": 0,
                    "driverparams": "",
                    "errorcode": 0,
                    "errormessage": "",
                    "firm_id": "3000000101",
                    "firmoffice_id": "3000000101",
                    "interrupted": false,
                    "lockedby_id": null,
                    "ordnumber": 1,
                    "participants": [],
                    "period_id": "1M00000101",
                    "person_id": null,
                    "processingtype": 1,
                    "ruledriverparams": ""
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "documents",
                "obj_id": "1600000100",
                "object_data": {
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "category_id": "2000000000",
                    "closed": false,
                    "contents": [
                        {
                            "correctedby_id": null,
                            "correctiontime$date": null,
                            "createdby_id": "1200000101",
                            "creationtime$date": "2017-08-11T15:06:30.664Z",
                            "description": "",
                            "externalfile": false,
                            "filename": "GenLogo.jpg",
                            "id": "1200000101",
                            "objversion": 1,
                            "parent_id": "1300000101",
                            "pathandfilename": "",
                            "posindex": 1,
                            "specification": 0
                        }
                    ],
                    "correctedat$date": null,
                    "correctedby_id": null,
                    "correctiontime$date": null,
                    "createdat$date": "2017-08-11T15:06:56.100Z",
                    "createdby_id": "1200000101",
                    "description": "",
                    "division_id": null,
                    "docdate$date": "2017-08-10T22:00:00.000Z",
                    "docqueue_id": "N700000101",
                    "docstate": 0,
                    "driverparams": "",
                    "errorcode": 0,
                    "errormessage": "",
                    "firm_id": "3000000101",
                    "firmoffice_id": "3000000101",
                    "interrupted": false,
                    "lockedby_id": null,
                    "ordnumber": 1,
                    "participants": [],
                    "period_id": "1M00000101",
                    "person_id": null,
                    "processingtype": 1,
                    "ruledriverparams": ""
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "documents",
                "obj_id": "1600000101",
                "object_data": {
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "category_id": "2000000000",
                    "closed": false,
                    "contents": [
                        {
                            "correctedby_id": null,
                            "correctiontime$date": null,
                            "createdby_id": "1200000101",
                            "creationtime$date": "2017-08-11T15:06:30.664Z",
                            "description": "",
                            "externalfile": false,
                            "filename": "GenLogo.jpg",
                            "id": "1200000101",
                            "objversion": 1,
                            "parent_id": "1300000101",
                            "pathandfilename": "",
                            "posindex": 1,
                            "specification": 0
                        }
                    ],
                    "correctedat$date": null,
                    "correctedby_id": null,
                    "correctiontime$date": null,
                    "createdat$date": "2017-08-11T15:06:56.100Z",
                    "createdby_id": "1200000101",
                    "description": "",
                    "division_id": null,
                    "docdate$date": "2017-08-10T22:00:00.000Z",
                    "docqueue_id": "N700000101",
                    "docstate": 0,
                    "driverparams": "",
                    "errorcode": 0,
                    "errormessage": "",
                    "firm_id": "3000000101",
                    "firmoffice_id": "3000000101",
                    "interrupted": false,
                    "lockedby_id": null,
                    "ordnumber": 1,
                    "participants": [],
                    "period_id": "1M00000101",
                    "person_id": null,
                    "processingtype": 1,
                    "ruledriverparams": ""
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "documents",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "documents",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "documents",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "documents",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "documents",
                "obj_id": "1600000104"
            }
        }
    ]
}