Okres

GET

/districts

Získá kolekci BO Okres

GET

/districts/meta/dataprotection

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

GET

/districts/views/{view}

Získá pohled nad BO Okres

GET

/districts/{id}

Získá daný BO Okres

GET

/districts/{id}/iseditlock

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

GET

/districts/{id}/meta/dataprotection

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

GET

/districts/{id}/userparameters

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

POST

/districts

Vytvoří nový BO Okres

POST

/districts/query

Vyhodnotí query dotaz nad BO Okres

PUT

/districts/{id}

Modifikuje daný BO Okres

PUT

/districts/{id}/editlock

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

PUT

/districts/{id}/editunlock

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

DELETE

/districts/{id}

Smaže BO Okres

Metadata - Perzistentní položky

code string (10)

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

country_id string (country) relace

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

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

intrastatregion_id string (intrastatregion) relace

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

lau1 string (10)

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

name string (50)

Název, 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

Metadata - Neperzistentní položky

classid string (26)

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

displayname string (100)

Název, pouze pro čtení

id string (10)

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

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

GET

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

GET

https://atd.abra.eu/demodata/districts/{id}
Response
{
    "objversion": 2,
    "hidden": true,
    "code": "CZ0101",
    "name": "Praha 1",
    "country_id": "00000CZ000",
    "lau1": "CZ0100",
    "intrastatregion_id": "F000000000"
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/districts/query
{"take": "1"}
Response
{
    "objversion": 2,
    "hidden": true,
    "code": "CZ0101",
    "name": "Praha 1",
    "country_id": "00000CZ000",
    "lau1": "CZ0100",
    "intrastatregion_id": "F000000000"
}
Request

POST

https://atd.abra.eu/demodata/districts?select=id
Body
{
    "code": "CZ0101",
    "country_id": "00000CZ000",
    "hidden": true,
    "intrastatregion_id": "F000000000",
    "lau1": "CZ0100",
    "name": "Praha 1"
}
Response
{
    "id": "1600000101"
}
Request

PUT

https://atd.abra.eu/demodata/districts/{id}?select=id
Body
{
    "code": "CZ0101",
    "country_id": "00000CZ000",
    "hidden": true,
    "intrastatregion_id": "F000000000",
    "lau1": "CZ0100",
    "name": "Praha 1"
}
Response
{
    "id": "1600000101"
}

DELETE

https://atd.abra.eu/demodata/districts/{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": "districts",
                "object_data": {
                    "code": "CZ0101",
                    "country_id": "00000CZ000",
                    "hidden": true,
                    "intrastatregion_id": "F000000000",
                    "lau1": "CZ0100",
                    "name": "Praha 1"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "districts",
                "object_data": {
                    "code": "CZ0101",
                    "country_id": "00000CZ000",
                    "hidden": true,
                    "intrastatregion_id": "F000000000",
                    "lau1": "CZ0100",
                    "name": "Praha 1"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "districts",
                "obj_id": "1600000100",
                "object_data": {
                    "code": "CZ0101",
                    "country_id": "00000CZ000",
                    "hidden": true,
                    "intrastatregion_id": "F000000000",
                    "lau1": "CZ0100",
                    "name": "Praha 1"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "districts",
                "obj_id": "1600000101",
                "object_data": {
                    "code": "CZ0101",
                    "country_id": "00000CZ000",
                    "hidden": true,
                    "intrastatregion_id": "F000000000",
                    "lau1": "CZ0100",
                    "name": "Praha 1"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "districts",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "districts",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "districts",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "districts",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "districts",
                "obj_id": "1600000104"
            }
        }
    ]
}