Pojmenovaná maska

GET

/namedmasks

Získá kolekci BO Pojmenovaná maska

GET

/namedmasks/{id}

Získá konkrétní BO Pojmenovaná maska

POST

/namedmasks

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

PUT

/namedmasks/{id}

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

DELETE

/namedmasks/{id}

Smaže BO Pojmenovaná maska na základě jeho ID

Metadata - Perzistentní položky

Description string (100)

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

IsBasicMask boolean

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

Mask string (100)

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

MaskType integer

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

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

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/namedmasks?take=1

GET

https://atd.abra.eu/demodata/namedmasks/{id}
Response
{
    "ID": "0010000000",
    "ObjVersion": 1,
    "Name": "Basic",
    "Mask": "#########0.###",
    "Description": "Základní maska",
    "MaskType": 0,
    "IsBasicMask": true
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/namedmasks/query
{"take": "1"}
Response
{
    "ID": "0010000000",
    "ObjVersion": 1,
    "Name": "Basic",
    "Mask": "#########0.###",
    "Description": "Základní maska",
    "MaskType": 0,
    "IsBasicMask": true
}
Request

POST

https://atd.abra.eu/demodata/namedmasks?select=id
Body
{
    "Description": "Základní maska",
    "IsBasicMask": true,
    "Mask": "#########0.###",
    "MaskType": 0,
    "Name": "Basic"
}
Response
{
    "id": "0010000000"
}
Request

PUT

https://atd.abra.eu/demodata/namedmasks/{id}?select=id
Body
{
    "Description": "Základní maska",
    "IsBasicMask": true,
    "Mask": "#########0.###",
    "MaskType": 0,
    "Name": "Basic"
}
Response
{
    "id": "0010000000"
}

DELETE

https://atd.abra.eu/demodata/namedmasks/{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": "namedmasks",
                "object_data": {
                    "Description": "Základní maska",
                    "IsBasicMask": true,
                    "Mask": "#########0.###",
                    "MaskType": 0,
                    "Name": "Basic"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "namedmasks",
                "object_data": {
                    "Description": "Základní maska",
                    "IsBasicMask": true,
                    "Mask": "#########0.###",
                    "MaskType": 0,
                    "Name": "Basic"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "namedmasks",
                "obj_id": "0010000000",
                "object_data": {
                    "Description": "Základní maska",
                    "IsBasicMask": true,
                    "Mask": "#########0.###",
                    "MaskType": 0,
                    "Name": "Basic"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "namedmasks",
                "obj_id": "0010000001",
                "object_data": {
                    "Description": "Základní maska",
                    "IsBasicMask": true,
                    "Mask": "#########0.###",
                    "MaskType": 0,
                    "Name": "Basic"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "namedmasks",
                "obj_id": "0010000000"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "namedmasks",
                "obj_id": "0010000001"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "namedmasks",
                "obj_id": "0010000002"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "namedmasks",
                "obj_id": "0010000003"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "namedmasks",
                "obj_id": "0010000004"
            }
        }
    ]
}