Období

GET

/periods

Získá kolekci BO Období

GET

/periods/meta/dataprotection

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

GET

/periods/views/{view}

Získá pohled nad BO Období

GET

/periods/{id}

Získá daný BO Období

GET

/periods/{id}/iseditlock

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

GET

/periods/{id}/meta/dataprotection

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

GET

/periods/{id}/userparameters

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

POST

/periods

Vytvoří nový BO Období

POST

/periods/query

Vyhodnotí query dotaz nad BO Období

PUT

/periods/{id}

Modifikuje daný BO Období

PUT

/periods/{id}/editlock

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

PUT

/periods/{id}/editunlock

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

DELETE

/periods/{id}

Smaže BO Období

Metadata - Perzistentní položky

beginnings boolean

Počátky, pole vlastněné tabulkou, možné řadit a filtrovat

closing boolean

Závěrka, pole vlastněné tabulkou, možné řadit a filtrovat

code string (4)

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

datefrom$date string

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

dateto$date string

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

name string (40)

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

sequencenumber integer

Pořadí, pole vlastněné tabulkou, možné řadit a filtrovat

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/periods?take=1
GET
https://atd.abra.eu/demodata/periods/{id}
Response 
{
    "objversion": 4,
    "code": "0000",
    "name": "Nulté období",
    "datefrom$date": "1999-12-31T23:00:00.000Z",
    "dateto$date": "2005-12-31T23:00:00.000Z",
    "closing": true,
    "beginnings": false,
    "sequencenumber": 1
}
Request POST 
POST
https://atd.abra.eu/demodata/query
{"class": "periods", "take": "1"}
POST
https://atd.abra.eu/demodata/periods/query
{"take": "1"}
Response 
{
    "objversion": 4,
    "code": "0000",
    "name": "Nulté období",
    "datefrom$date": "1999-12-31T23:00:00.000Z",
    "dateto$date": "2005-12-31T23:00:00.000Z",
    "closing": true,
    "beginnings": false,
    "sequencenumber": 1
}
Request 
POST
https://atd.abra.eu/demodata/periods?select=id
Body 
{
    "beginnings": false,
    "closing": true,
    "code": "0000",
    "datefrom$date": "1999-12-31T23:00:00.000Z",
    "dateto$date": "2005-12-31T23:00:00.000Z",
    "name": "Nulté období",
    "sequencenumber": 1
}
Response 
{
    "id": "1600000101"
}
Request 
PUT
https://atd.abra.eu/demodata/periods/{id}?select=id
Body 
{
    "beginnings": false,
    "closing": true,
    "code": "0000",
    "datefrom$date": "1999-12-31T23:00:00.000Z",
    "dateto$date": "2005-12-31T23:00:00.000Z",
    "name": "Nulté období",
    "sequencenumber": 1
}
Response 
{
    "id": "1600000101"
}
DELETE
https://atd.abra.eu/demodata/periods/{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": "periods",
                "object_data": {
                    "beginnings": false,
                    "closing": true,
                    "code": "0000",
                    "datefrom$date": "1999-12-31T23:00:00.000Z",
                    "dateto$date": "2005-12-31T23:00:00.000Z",
                    "name": "Nulté období",
                    "sequencenumber": 1
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "periods",
                "object_data": {
                    "beginnings": false,
                    "closing": true,
                    "code": "0000",
                    "datefrom$date": "1999-12-31T23:00:00.000Z",
                    "dateto$date": "2005-12-31T23:00:00.000Z",
                    "name": "Nulté období",
                    "sequencenumber": 1
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "periods",
                "obj_id": "1600000100",
                "object_data": {
                    "beginnings": false,
                    "closing": true,
                    "code": "0000",
                    "datefrom$date": "1999-12-31T23:00:00.000Z",
                    "dateto$date": "2005-12-31T23:00:00.000Z",
                    "name": "Nulté období",
                    "sequencenumber": 1
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "periods",
                "obj_id": "1600000101",
                "object_data": {
                    "beginnings": false,
                    "closing": true,
                    "code": "0000",
                    "datefrom$date": "1999-12-31T23:00:00.000Z",
                    "dateto$date": "2005-12-31T23:00:00.000Z",
                    "name": "Nulté období",
                    "sequencenumber": 1
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "periods",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "periods",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "periods",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "periods",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "periods",
                "obj_id": "1600000104"
            }
        }
    ]
}