Osoba

GET

/persons

Získá kolekci BO Osoba

GET

/persons/meta/dataprotection

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

GET

/persons/views/{view}

Získá pohled nad BO Osoba

GET

/persons/{id}

Získá daný BO Osoba

GET

/persons/{id}/iseditlock

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

GET

/persons/{id}/meta/dataprotection

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

GET

/persons/{id}/pictures

Získá řádky kolekce Obrázek k osobě

GET

/persons/{id}/pictures/{id1}

Získá daný řádek kolekce Obrázek k osobě

GET

/persons/{id}/userparameters

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

POST

/persons

Vytvoří nový BO Osoba

POST

/persons/query

Vyhodnotí query dotaz nad BO Osoba

POST

/persons/{id}/pictures

Vytvoří nový řádek v kolekci Obrázek k osobě

PUT

/persons/{id}

Modifikuje daný BO Osoba

PUT

/persons/{id}/dataprotectionswitch

Modifikuje položku IsEmployee na BO Osoba podle předaného parametru

PUT

/persons/{id}/editlock

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

PUT

/persons/{id}/editunlock

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

PUT

/persons/{id}/pictures/{id1}

Modifikuje řádek v kolekci Obrázek k osobě

DELETE

/persons/{id}

Smaže BO Osoba

DELETE

/persons/{id}/pictures/{id1}

Smaže řádek z kolekce Obrázek k osobě

Metadata - Perzistentní položky

address_id string (address) relace

Adresa, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

birthnumber string (20)

Rodné číslo, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole je přístupná pro hromadné změny

commercialsagreement integer

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

crmmenuitem_id string (crmmenuitem) relace

CRM zařazení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole je přístupná pro hromadné změny

dateofbirth$date string

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

firstname string (20)

Jméno, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole je přístupná pro hromadné změny

gdprvaliditysuspended boolean

Omezení zpracování (GDPR), pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole je přístupná pro hromadné změny, pole nepodporuje ochranu dat/GDPR

grade string (60)

Popis pozice, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole je přístupná pro hromadné změny

hidden boolean

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

idcardnumber string (20)

Číslo OP/pasu, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole je přístupná pro hromadné změny

isemployee boolean

Zaměstnanec/Pracovník, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole nepodporuje ochranu dat/GDPR

isowned boolean

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

lastname string (30)

Příjmení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole je přístupná pro hromadné změny

note string

Poznámka, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole je přístupná pro hromadné změny

objversion integer

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

personalnumber string (10)

Osob.číslo, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

picture_id string (picture) relace

Obrázek, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn', pole nepodporuje ochranu dat/GDPR

pictures array (personpicture) relace

kolekce BO Obrázek k osobě, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

salutationname string (30)

Jméno v 5. pádu, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

salutationtitle string (30)

Oslovení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole je přístupná pro hromadné změny

suffix string (20)

Titul za jménem, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole je přístupná pro hromadné změny

title string (20)

Titul, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole je přístupná pro hromadné změny

Metadata - Neperzistentní položky

classid string (26)

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

comment string (8191)

Poznámka

commercialsagreementdesc string (20)

Souhlas s reklamou - popis, pole nepodporuje ochranu dat/GDPR

displayname string (50)

Název, pouze pro čtení

fullname string (51)

Jméno + Příjmení, pouze pro čtení

id string (10)

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

insolvencycheckresult integer

Stav insolvence, pole nepodporuje ochranu dat/GDPR

insolvencycheckresultastext string (40)

Stav insolvence textově, pole nepodporuje ochranu dat/GDPR

insolvencylastcheckdatetime string

Datum a čas posledního ověření insolvence

insolvencylastcheckdatetime$date string

Datum a čas posledního ověření insolvence

lastandfirstname string (51)

Příjmení + Jméno, pouze pro čtení

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

GET

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

GET

https://atd.abra.eu/demodata/persons/{id}
Response
{
    "objversion": 8,
    "hidden": false,
    "lastname": "Nejedlý",
    "firstname": "Martin",
    "title": "ing.",
    "grade": "",
    "birthnumber": "680821\/3335",
    "idcardnumber": "378956789",
    "note": "",
    "address_id": "ZC00000101",
    "isemployee": true,
    "isowned": true,
    "personalnumber": "001",
    "picture_id": null,
    "suffix": "",
    "dateofbirth$date": "1968-08-20T22:00:00.000Z",
    "gdprvaliditysuspended": false,
    "salutationtitle": "",
    "salutationname": "",
    "commercialsagreement": 0,
    "crmmenuitem_id": null,
    "pictures": []
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/persons/query
{"take": "1"}
Response
{
    "objversion": 8,
    "hidden": false,
    "lastname": "Nejedlý",
    "firstname": "Martin",
    "title": "ing.",
    "grade": "",
    "birthnumber": "680821\/3335",
    "idcardnumber": "378956789",
    "note": "",
    "address_id": "ZC00000101",
    "isemployee": true,
    "isowned": true,
    "personalnumber": "001",
    "picture_id": null,
    "suffix": "",
    "dateofbirth$date": "1968-08-20T22:00:00.000Z",
    "gdprvaliditysuspended": false,
    "salutationtitle": "",
    "salutationname": "",
    "commercialsagreement": 0,
    "crmmenuitem_id": null,
    "pictures": []
}
Request

POST

https://atd.abra.eu/demodata/persons?select=id
Body
{
    "address_id": "ZC00000101",
    "birthnumber": "680821\/3335",
    "commercialsagreement": 0,
    "crmmenuitem_id": null,
    "dateofbirth$date": "1968-08-20T22:00:00.000Z",
    "firstname": "Martin",
    "gdprvaliditysuspended": false,
    "grade": "",
    "hidden": false,
    "idcardnumber": "378956789",
    "lastname": "Nejedlý",
    "note": "",
    "personalnumber": "001",
    "picture_id": null,
    "pictures": [],
    "salutationname": "",
    "salutationtitle": "",
    "suffix": "",
    "title": "ing."
}
Response
{
    "id": "1600000101"
}
Request

PUT

https://atd.abra.eu/demodata/persons/{id}?select=id
Body
{
    "address_id": "ZC00000101",
    "birthnumber": "680821\/3335",
    "commercialsagreement": 0,
    "crmmenuitem_id": null,
    "dateofbirth$date": "1968-08-20T22:00:00.000Z",
    "firstname": "Martin",
    "gdprvaliditysuspended": false,
    "grade": "",
    "hidden": false,
    "idcardnumber": "378956789",
    "lastname": "Nejedlý",
    "note": "",
    "personalnumber": "001",
    "picture_id": null,
    "pictures": [],
    "salutationname": "",
    "salutationtitle": "",
    "suffix": "",
    "title": "ing."
}
Response
{
    "id": "1600000101"
}

DELETE

https://atd.abra.eu/demodata/persons/{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": "persons",
                "object_data": {
                    "address_id": "ZC00000101",
                    "birthnumber": "680821\/3335",
                    "commercialsagreement": 0,
                    "crmmenuitem_id": null,
                    "dateofbirth$date": "1968-08-20T22:00:00.000Z",
                    "firstname": "Martin",
                    "gdprvaliditysuspended": false,
                    "grade": "",
                    "hidden": false,
                    "idcardnumber": "378956789",
                    "lastname": "Nejedlý",
                    "note": "",
                    "personalnumber": "001",
                    "picture_id": null,
                    "pictures": [],
                    "salutationname": "",
                    "salutationtitle": "",
                    "suffix": "",
                    "title": "ing."
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "persons",
                "object_data": {
                    "address_id": "ZC00000101",
                    "birthnumber": "680821\/3335",
                    "commercialsagreement": 0,
                    "crmmenuitem_id": null,
                    "dateofbirth$date": "1968-08-20T22:00:00.000Z",
                    "firstname": "Martin",
                    "gdprvaliditysuspended": false,
                    "grade": "",
                    "hidden": false,
                    "idcardnumber": "378956789",
                    "lastname": "Nejedlý",
                    "note": "",
                    "personalnumber": "001",
                    "picture_id": null,
                    "pictures": [],
                    "salutationname": "",
                    "salutationtitle": "",
                    "suffix": "",
                    "title": "ing."
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "persons",
                "obj_id": "1600000100",
                "object_data": {
                    "address_id": "ZC00000101",
                    "birthnumber": "680821\/3335",
                    "commercialsagreement": 0,
                    "crmmenuitem_id": null,
                    "dateofbirth$date": "1968-08-20T22:00:00.000Z",
                    "firstname": "Martin",
                    "gdprvaliditysuspended": false,
                    "grade": "",
                    "hidden": false,
                    "idcardnumber": "378956789",
                    "lastname": "Nejedlý",
                    "note": "",
                    "personalnumber": "001",
                    "picture_id": null,
                    "pictures": [],
                    "salutationname": "",
                    "salutationtitle": "",
                    "suffix": "",
                    "title": "ing."
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "persons",
                "obj_id": "1600000101",
                "object_data": {
                    "address_id": "ZC00000101",
                    "birthnumber": "680821\/3335",
                    "commercialsagreement": 0,
                    "crmmenuitem_id": null,
                    "dateofbirth$date": "1968-08-20T22:00:00.000Z",
                    "firstname": "Martin",
                    "gdprvaliditysuspended": false,
                    "grade": "",
                    "hidden": false,
                    "idcardnumber": "378956789",
                    "lastname": "Nejedlý",
                    "note": "",
                    "personalnumber": "001",
                    "picture_id": null,
                    "pictures": [],
                    "salutationname": "",
                    "salutationtitle": "",
                    "suffix": "",
                    "title": "ing."
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "persons",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "persons",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "persons",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "persons",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "persons",
                "obj_id": "1600000104"
            }
        }
    ]
}