Pošta

GET

/postoffices

Získá kolekci BO Pošta

GET

/postoffices/meta/dataprotection

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

GET

/postoffices/views/{view}

Získá pohled nad BO Pošta

GET

/postoffices/{id}

Získá daný BO Pošta

GET

/postoffices/{id}/iseditlock

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

GET

/postoffices/{id}/meta/dataprotection

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

GET

/postoffices/{id}/userparameters

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

POST

/postoffices

Vytvoří nový BO Pošta

POST

/postoffices/query

Vyhodnotí query dotaz nad BO Pošta

PUT

/postoffices/{id}

Modifikuje daný BO Pošta

PUT

/postoffices/{id}/editlock

Vytvoří editační zámek na daném BO Pošta

PUT

/postoffices/{id}/editunlock

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

DELETE

/postoffices/{id}

Smaže BO Pošta

Metadata - Perzistentní položky

district_id string (district) relace

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

objversion integer

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

postcode string (10)

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

postname string (50)

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

regioncode string (10)

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

regionname string (50)

Název okresu, 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 (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/postoffices?take=1
GET
https://atd.abra.eu/demodata/postoffices/{id}
Response 
{
    "objversion": 3,
    "hidden": false,
    "postcode": "100 00",
    "postname": "Praha 10",
    "regioncode": "3100",
    "regionname": "Hlavní město Praha",
    "district_id": "7700000000"
}
Request POST 
POST
https://atd.abra.eu/demodata/query
{"class": "postoffices", "take": "1"}
POST
https://atd.abra.eu/demodata/postoffices/query
{"take": "1"}
Response 
{
    "objversion": 3,
    "hidden": false,
    "postcode": "100 00",
    "postname": "Praha 10",
    "regioncode": "3100",
    "regionname": "Hlavní město Praha",
    "district_id": "7700000000"
}
Request 
POST
https://atd.abra.eu/demodata/postoffices?select=id
Body 
{
    "district_id": "7700000000",
    "hidden": false,
    "postcode": "100 00",
    "postname": "Praha 10",
    "regioncode": "3100",
    "regionname": "Hlavní město Praha"
}
Response 
{
    "id": "1600000101"
}
Request 
PUT
https://atd.abra.eu/demodata/postoffices/{id}?select=id
Body 
{
    "district_id": "7700000000",
    "hidden": false,
    "postcode": "100 00",
    "postname": "Praha 10",
    "regioncode": "3100",
    "regionname": "Hlavní město Praha"
}
Response 
{
    "id": "1600000101"
}
DELETE
https://atd.abra.eu/demodata/postoffices/{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": "postoffices",
                "object_data": {
                    "district_id": "7700000000",
                    "hidden": false,
                    "postcode": "100 00",
                    "postname": "Praha 10",
                    "regioncode": "3100",
                    "regionname": "Hlavní město Praha"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "postoffices",
                "object_data": {
                    "district_id": "7700000000",
                    "hidden": false,
                    "postcode": "100 00",
                    "postname": "Praha 10",
                    "regioncode": "3100",
                    "regionname": "Hlavní město Praha"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "postoffices",
                "obj_id": "1600000100",
                "object_data": {
                    "district_id": "7700000000",
                    "hidden": false,
                    "postcode": "100 00",
                    "postname": "Praha 10",
                    "regioncode": "3100",
                    "regionname": "Hlavní město Praha"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "postoffices",
                "obj_id": "1600000101",
                "object_data": {
                    "district_id": "7700000000",
                    "hidden": false,
                    "postcode": "100 00",
                    "postname": "Praha 10",
                    "regioncode": "3100",
                    "regionname": "Hlavní město Praha"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "postoffices",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "postoffices",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "postoffices",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "postoffices",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "postoffices",
                "obj_id": "1600000104"
            }
        }
    ]
}