Business objekt barvy

GET

/UserRollWebAPI_Color

Získá kolekci BO Business objekt barvy

GET

/UserRollWebAPI_Color/{id}

Získá konkrétní BO Business objekt barvy

POST

/UserRollWebAPI_Color

Vytvoří nový BO Business objekt barvy a vrátí jeho kompletní reprezentaci

PUT

/UserRollWebAPI_Color/{id}

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

DELETE

/UserRollWebAPI_Color/{id}

Smaže BO Business objekt barvy na základě jeho ID

Metadata - Perzistentní položky

CLSID string (26)

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

Code string (40)

Kód, 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

Name string (100)

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

GET

https://atd.abra.eu/demodata/UserRollWebAPI_Color/{id}
Response
{
    "ID": "1000000101",
    "ObjVersion": 1,
    "Code": "B",
    "Name": "Bílá",
    "CLSID": "KVQ3D04J2WD4X2YZ014JL0J2GG",
    "Hidden": false
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/UserRollWebAPI_Color/query
{"take": "1"}
Response
{
    "ID": "1000000101",
    "ObjVersion": 1,
    "Code": "B",
    "Name": "Bílá",
    "CLSID": "KVQ3D04J2WD4X2YZ014JL0J2GG",
    "Hidden": false
}
Request

POST

https://atd.abra.eu/demodata/UserRollWebAPI_Color?select=id
Body
{
    "CLSID": "KVQ3D04J2WD4X2YZ014JL0J2GG",
    "Code": "B",
    "Hidden": false,
    "Name": "Bílá"
}
Response
{
    "id": "1000000101"
}
Request

PUT

https://atd.abra.eu/demodata/UserRollWebAPI_Color/{id}?select=id
Body
{
    "CLSID": "KVQ3D04J2WD4X2YZ014JL0J2GG",
    "Code": "B",
    "Hidden": false,
    "Name": "Bílá"
}
Response
{
    "id": "1000000101"
}

DELETE

https://atd.abra.eu/demodata/UserRollWebAPI_Color/{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": "UserRollWebAPI_Color",
                "object_data": {
                    "CLSID": "KVQ3D04J2WD4X2YZ014JL0J2GG",
                    "Code": "B",
                    "Hidden": false,
                    "Name": "Bílá"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "UserRollWebAPI_Color",
                "object_data": {
                    "CLSID": "KVQ3D04J2WD4X2YZ014JL0J2GG",
                    "Code": "B",
                    "Hidden": false,
                    "Name": "Bílá"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "UserRollWebAPI_Color",
                "obj_id": "1000000100",
                "object_data": {
                    "CLSID": "KVQ3D04J2WD4X2YZ014JL0J2GG",
                    "Code": "B",
                    "Hidden": false,
                    "Name": "Bílá"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "UserRollWebAPI_Color",
                "obj_id": "1000000101",
                "object_data": {
                    "CLSID": "KVQ3D04J2WD4X2YZ014JL0J2GG",
                    "Code": "B",
                    "Hidden": false,
                    "Name": "Bílá"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "UserRollWebAPI_Color",
                "obj_id": "1000000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "UserRollWebAPI_Color",
                "obj_id": "1000000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "UserRollWebAPI_Color",
                "obj_id": "1000000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "UserRollWebAPI_Color",
                "obj_id": "1000000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "UserRollWebAPI_Color",
                "obj_id": "1000000104"
            }
        }
    ]
}