Uživatel modulu evidence pošty

GET

/pdmusers

Získá kolekci BO Uživatel modulu evidence pošty

GET

/pdmusers/{id}

Získá konkrétní BO Uživatel modulu evidence pošty

POST

/pdmusers

Vytvoří nový BO Uživatel modulu evidence pošty a vrátí jeho kompletní reprezentaci

PUT

/pdmusers/{id}

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

DELETE

/pdmusers/{id}

Smaže BO Uživatel modulu evidence pošty na základě jeho ID

Metadata - Perzistentní položky

Division_ID string (division) relace

Středisko; ID objektu Středisko, 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

Person_ID string (person) relace

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

PostProvider_ID string (pdmpostprovider) relace

Poštovní poskytovatel; ID objektu Poskytovatel poštovních služeb, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

SecurityUser_ID string (securityuser) relace

Uživatel systému; ID objektu Uživatel, 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

PersonName string (30)

Jméno osoby

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request

GET

https://atd.abra.eu/demodata/pdmusers?take=1

GET

https://atd.abra.eu/demodata/pdmusers/{id}
Response
{
    "ID": "2000000101",
    "ObjVersion": 1,
    "Hidden": false,
    "SecurityUser_ID": "SUPER00000",
    "Person_ID": "X000000101",
    "Division_ID": "2100000101",
    "PostProvider_ID": "1000000000"
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/pdmusers/query
{"take": "1"}
Response
{
    "ID": "2000000101",
    "ObjVersion": 1,
    "Hidden": false,
    "SecurityUser_ID": "SUPER00000",
    "Person_ID": "X000000101",
    "Division_ID": "2100000101",
    "PostProvider_ID": "1000000000"
}
Request

POST

https://atd.abra.eu/demodata/pdmusers?select=id
Body
{
    "Division_ID": "2100000101",
    "Hidden": false,
    "Person_ID": "X000000101",
    "PostProvider_ID": "1000000000",
    "SecurityUser_ID": "SUPER00000"
}
Response
{
    "id": "2000000101"
}
Request

PUT

https://atd.abra.eu/demodata/pdmusers/{id}?select=id
Body
{
    "Division_ID": "2100000101",
    "Hidden": false,
    "Person_ID": "X000000101",
    "PostProvider_ID": "1000000000",
    "SecurityUser_ID": "SUPER00000"
}
Response
{
    "id": "2000000101"
}

DELETE

https://atd.abra.eu/demodata/pdmusers/{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": "pdmusers",
                "object_data": {
                    "Division_ID": "2100000101",
                    "Hidden": false,
                    "Person_ID": "X000000101",
                    "PostProvider_ID": "1000000000",
                    "SecurityUser_ID": "SUPER00000"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "pdmusers",
                "object_data": {
                    "Division_ID": "2100000101",
                    "Hidden": false,
                    "Person_ID": "X000000101",
                    "PostProvider_ID": "1000000000",
                    "SecurityUser_ID": "SUPER00000"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "pdmusers",
                "obj_id": "2000000100",
                "object_data": {
                    "Division_ID": "2100000101",
                    "Hidden": false,
                    "Person_ID": "X000000101",
                    "PostProvider_ID": "1000000000",
                    "SecurityUser_ID": "SUPER00000"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "pdmusers",
                "obj_id": "2000000101",
                "object_data": {
                    "Division_ID": "2100000101",
                    "Hidden": false,
                    "Person_ID": "X000000101",
                    "PostProvider_ID": "1000000000",
                    "SecurityUser_ID": "SUPER00000"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "pdmusers",
                "obj_id": "2000000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "pdmusers",
                "obj_id": "2000000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "pdmusers",
                "obj_id": "2000000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "pdmusers",
                "obj_id": "2000000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "pdmusers",
                "obj_id": "2000000104"
            }
        }
    ]
}