Období

GET

/periods

Získá kolekci BO Období

GET

/periods/{id}

Získá konkrétní BO Období

POST

/periods

Vytvoří nový BO Období a vrátí jeho kompletní reprezentaci

PUT

/periods/{id}

Provede aktualizaci BO Období a vrátí jeho kompletní, aktualizovanou reprezentaci. Operaci PUT je možné využívat i k částečným aktualizacím zdrojů (PATCH).

DELETE

/periods/{id}

Smaže BO Období na základě jeho ID

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 
{
    "ID": "2200000101",
    "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 
{
    "ID": "2200000101",
    "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": "2200000101"
}
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": "2200000101"
}
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": "2200000100",
                "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": "2200000101",
                "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": "2200000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "periods",
                "obj_id": "2200000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "periods",
                "obj_id": "2200000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "periods",
                "obj_id": "2200000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "periods",
                "obj_id": "2200000104"
            }
        }
    ]
}