Smlouva

GET

/contracts

Získá kolekci BO Smlouva

GET

/contracts/meta/dataprotection

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

GET

/contracts/views/{view}

Získá pohled nad BO Smlouva

GET

/contracts/{id}

Získá daný BO Smlouva

GET

/contracts/{id}/iseditlock

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

GET

/contracts/{id}/meta/dataprotection

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

GET

/contracts/{id}/userparameters

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

POST

/contracts

Vytvoří nový BO Smlouva

POST

/contracts/query

Vyhodnotí query dotaz nad BO Smlouva

PUT

/contracts/{id}

Modifikuje daný BO Smlouva

PUT

/contracts/{id}/editlock

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

PUT

/contracts/{id}/editunlock

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

DELETE

/contracts/{id}

Smaže BO Smlouva

Metadata - Perzistentní položky

autodataprocessingpermit boolean

Automatické povolení ke zpracování dat, 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

contracttype_id string (contracttype) relace

Typ, 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

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

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

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

externalnumber string (30)

Externí čí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

firm_id string (firm) relace

Firma, 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

ordnumber integer

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

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, pole je přístupná pro hromadné změny

shortdescription string (200)

Popis, 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

validfrom$date string

Platná od, 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

validto$date string

Platná do, 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

displayname string (24)

Číslo dok., pouze pro čtení

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

partnertype integer

Typ žadatele

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request 
GET
https://atd.abra.eu/demodata/contracts?take=1
GET
https://atd.abra.eu/demodata/contracts/{id}
Response 
{
    "autodataprocessingpermit": null,
    "contracttype_id": null,
    "correctedat$date": null,
    "correctedby_id": null,
    "createdat$date": null,
    "createdby_id": null,
    "docdate$date": null,
    "docqueue_id": null,
    "externalnumber": null,
    "firm_id": null,
    "objversion": null,
    "ordnumber": null,
    "period_id": null,
    "person_id": null,
    "shortdescription": null,
    "validfrom$date": null,
    "validto$date": null
}
Request POST 
POST
https://atd.abra.eu/demodata/query
{"class": "contracts", "take": "1"}
POST
https://atd.abra.eu/demodata/contracts/query
{"take": "1"}
Response 
{
    "autodataprocessingpermit": null,
    "contracttype_id": null,
    "correctedat$date": null,
    "correctedby_id": null,
    "createdat$date": null,
    "createdby_id": null,
    "docdate$date": null,
    "docqueue_id": null,
    "externalnumber": null,
    "firm_id": null,
    "objversion": null,
    "ordnumber": null,
    "period_id": null,
    "person_id": null,
    "shortdescription": null,
    "validfrom$date": null,
    "validto$date": null
}
Request 
POST
https://atd.abra.eu/demodata/contracts?select=id
Body 
{
    "autodataprocessingpermit": null,
    "contracttype_id": null,
    "correctedat$date": null,
    "correctedby_id": null,
    "createdat$date": null,
    "createdby_id": null,
    "docdate$date": null,
    "docqueue_id": null,
    "externalnumber": null,
    "firm_id": null,
    "ordnumber": null,
    "period_id": null,
    "person_id": null,
    "shortdescription": null,
    "validfrom$date": null,
    "validto$date": null
}
Response 
{
    "id": "1600000101"
}
Request 
PUT
https://atd.abra.eu/demodata/contracts/{id}?select=id
Body 
{
    "autodataprocessingpermit": null,
    "contracttype_id": null,
    "correctedat$date": null,
    "correctedby_id": null,
    "createdat$date": null,
    "createdby_id": null,
    "docdate$date": null,
    "docqueue_id": null,
    "externalnumber": null,
    "firm_id": null,
    "ordnumber": null,
    "period_id": null,
    "person_id": null,
    "shortdescription": null,
    "validfrom$date": null,
    "validto$date": null
}
Response 
{
    "id": "1600000101"
}
DELETE
https://atd.abra.eu/demodata/contracts/{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": "contracts",
                "object_data": {
                    "autodataprocessingpermit": null,
                    "contracttype_id": null,
                    "correctedat$date": null,
                    "correctedby_id": null,
                    "createdat$date": null,
                    "createdby_id": null,
                    "docdate$date": null,
                    "docqueue_id": null,
                    "externalnumber": null,
                    "firm_id": null,
                    "ordnumber": null,
                    "period_id": null,
                    "person_id": null,
                    "shortdescription": null,
                    "validfrom$date": null,
                    "validto$date": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "contracts",
                "object_data": {
                    "autodataprocessingpermit": null,
                    "contracttype_id": null,
                    "correctedat$date": null,
                    "correctedby_id": null,
                    "createdat$date": null,
                    "createdby_id": null,
                    "docdate$date": null,
                    "docqueue_id": null,
                    "externalnumber": null,
                    "firm_id": null,
                    "ordnumber": null,
                    "period_id": null,
                    "person_id": null,
                    "shortdescription": null,
                    "validfrom$date": null,
                    "validto$date": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "contracts",
                "obj_id": "1600000100",
                "object_data": {
                    "autodataprocessingpermit": null,
                    "contracttype_id": null,
                    "correctedat$date": null,
                    "correctedby_id": null,
                    "createdat$date": null,
                    "createdby_id": null,
                    "docdate$date": null,
                    "docqueue_id": null,
                    "externalnumber": null,
                    "firm_id": null,
                    "ordnumber": null,
                    "period_id": null,
                    "person_id": null,
                    "shortdescription": null,
                    "validfrom$date": null,
                    "validto$date": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "contracts",
                "obj_id": "1600000101",
                "object_data": {
                    "autodataprocessingpermit": null,
                    "contracttype_id": null,
                    "correctedat$date": null,
                    "correctedby_id": null,
                    "createdat$date": null,
                    "createdby_id": null,
                    "docdate$date": null,
                    "docqueue_id": null,
                    "externalnumber": null,
                    "firm_id": null,
                    "ordnumber": null,
                    "period_id": null,
                    "person_id": null,
                    "shortdescription": null,
                    "validfrom$date": null,
                    "validto$date": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "contracts",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "contracts",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "contracts",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "contracts",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "contracts",
                "obj_id": "1600000104"
            }
        }
    ]
}