Odeslaná datová zpráva

GET

/databoxmesssents

Získá kolekci BO Odeslaná datová zpráva

GET

/databoxmesssents/meta/dataprotection

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

GET

/databoxmesssents/views/{view}

Získá pohled nad BO Odeslaná datová zpráva

GET

/databoxmesssents/{id}

Získá daný BO Odeslaná datová zpráva

GET

/databoxmesssents/{id}/iseditlock

Otestuje, zda existuje editační zámek na daném BO Odeslaná datová zpráva

GET

/databoxmesssents/{id}/meta/dataprotection

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

GET

/databoxmesssents/{id}/userparameters

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

POST

/databoxmesssents

Vytvoří nový BO Odeslaná datová zpráva

POST

/databoxmesssents/query

Vyhodnotí query dotaz nad BO Odeslaná datová zpráva

PUT

/databoxmesssents/{id}

Modifikuje daný BO Odeslaná datová zpráva

PUT

/databoxmesssents/{id}/editlock

Vytvoří editační zámek na daném BO Odeslaná datová zpráva

PUT

/databoxmesssents/{id}/editunlock

Zruší editační zámek na daném BO Odeslaná datová zpráva

DELETE

/databoxmesssents/{id}

Smaže BO Odeslaná datová zpráva

Metadata - Perzistentní položky

ambiguousrecipient boolean

Adresát je ne-OVM povýšený na OVM, pole vlastněné tabulkou, možné řadit a filtrovat

dmtype integer

Typ datové zprávy, pole vlastněné tabulkou, možné řadit a filtrovat

idsender string (7)

ID datové schránky odesílatele, pole vlastněné tabulkou, možné řadit a filtrovat

legaltitlelaw integer

Zmocnění - číslo zákona, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

legaltitlepar string (2)

Zmocnění - odstavec v paragrafu, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

legaltitlepoint string (2)

Zmocnění - písmeno v odstavci, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

legaltitlesect string (20)

Zmocnění - paragraf v zákoně, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

legaltitleyear integer

Zmocnění - rok vydání zákona, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

messagestatus integer

Stav datové zprávy, pole vlastněné tabulkou, možné řadit a filtrovat

objversion integer

Verze objektu, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

ovm boolean

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

owner_id string (10)

Identifikace vlastníka datové zprávy, pole vlastněné tabulkou, možné řadit a filtrovat, fkAnsiCaseSensitive

personaldelivery boolean

Příznak do vlastních rukou, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

publishownid boolean

Přidat identifikaci odesílatele, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

qtimestamp string

Kvalifikované časové razítko, pole vlastněné tabulkou, možné řadit a filtrovat

recipient string (100)

Příjemce slovně, pole vlastněné tabulkou, možné řadit a filtrovat

recipientaddress string (100)

Poštovní adresa příjemce, pole vlastněné tabulkou, možné řadit a filtrovat

recipientident string (50)

Spisová značka ze strany příjemce, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

recipientorgunit string (100)

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

recipientorgunitnum integer

Organizační jednotka příjemce hodnotou, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

recipientrefnumber string (50)

Číslo jednací za strany příjemce, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

restrictiondeliveryfiction boolean

Zákaz doručení fikcí, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

sender string (100)

Název odesílatele, pole vlastněné tabulkou, možné řadit a filtrovat

senderaddress string (100)

Poštovní adresa odesílatele, pole vlastněné tabulkou, možné řadit a filtrovat

senderident string (50)

Spisová značka a strany odesílatele, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

senderorgunit string (100)

Organizační jednotka odesílatele, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

senderorgunitnum integer

Organizační jednotka odesílatele hodnotou, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

senderrefnumber string (50)

Číslo jednací za strany odesílatele, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

sendertype integer

Typ schránky odesílatele, pole vlastněné tabulkou, možné řadit a filtrovat

signeddeliveryinfo_id string (databoxmesssentcontent) relace

Odkaz na obsah doručenky, pole vlastněné tabulkou, možné řadit a filtrovat, objekt na který pole odkazuje je 'vlastněn'

signedmessage_id string (databoxmesssentcontent) relace

Odkaz na obsah zprávy, pole vlastněné tabulkou, možné řadit a filtrovat, objekt na který pole odkazuje je 'vlastněn'

tohands string (50)

K rukám, 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í

dmtypetext string (100)

Název typu datové zprávy, pouze pro čtení

id string (10)

Vlastní ID, pouze pro čtení, fkAnsiCaseSensitive, pole nepodporuje ochranu dat/GDPR

idrecipient string (7)

ID datové schránky příjemce, pouze pro čtení

messagestatustext string (100)

Stav datové zprávy textově

sendertypetext string (40)

Typ schránky odesílatele textově

signeddeliveryinfoloaded boolean

Obsah doručenky stažen

signedmessageloaded boolean

Obsah zprávy stažen

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

GET

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

GET

https://atd.abra.eu/demodata/databoxmesssents/{id}
Response
{
    "ambiguousrecipient": null,
    "dmtype": null,
    "idsender": null,
    "legaltitlelaw": null,
    "legaltitlepar": null,
    "legaltitlepoint": null,
    "legaltitlesect": null,
    "legaltitleyear": null,
    "messagestatus": null,
    "objversion": null,
    "ovm": null,
    "owner_id": null,
    "personaldelivery": null,
    "publishownid": null,
    "qtimestamp": null,
    "recipient": null,
    "recipientaddress": null,
    "recipientident": null,
    "recipientorgunit": null,
    "recipientorgunitnum": null,
    "recipientrefnumber": null,
    "restrictiondeliveryfiction": null,
    "sender": null,
    "senderaddress": null,
    "senderident": null,
    "senderorgunit": null,
    "senderorgunitnum": null,
    "senderrefnumber": null,
    "sendertype": null,
    "signeddeliveryinfo_id": null,
    "signedmessage_id": null,
    "tohands": null
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/databoxmesssents/query
{"take": "1"}
Response
{
    "ambiguousrecipient": null,
    "dmtype": null,
    "idsender": null,
    "legaltitlelaw": null,
    "legaltitlepar": null,
    "legaltitlepoint": null,
    "legaltitlesect": null,
    "legaltitleyear": null,
    "messagestatus": null,
    "objversion": null,
    "ovm": null,
    "owner_id": null,
    "personaldelivery": null,
    "publishownid": null,
    "qtimestamp": null,
    "recipient": null,
    "recipientaddress": null,
    "recipientident": null,
    "recipientorgunit": null,
    "recipientorgunitnum": null,
    "recipientrefnumber": null,
    "restrictiondeliveryfiction": null,
    "sender": null,
    "senderaddress": null,
    "senderident": null,
    "senderorgunit": null,
    "senderorgunitnum": null,
    "senderrefnumber": null,
    "sendertype": null,
    "signeddeliveryinfo_id": null,
    "signedmessage_id": null,
    "tohands": null
}
Request

POST

https://atd.abra.eu/demodata/databoxmesssents?select=id
Body
{
    "ambiguousrecipient": null,
    "dmtype": null,
    "idsender": null,
    "legaltitlelaw": null,
    "legaltitlepar": null,
    "legaltitlepoint": null,
    "legaltitlesect": null,
    "legaltitleyear": null,
    "messagestatus": null,
    "ovm": null,
    "owner_id": null,
    "personaldelivery": null,
    "publishownid": null,
    "qtimestamp": null,
    "recipient": null,
    "recipientaddress": null,
    "recipientident": null,
    "recipientorgunit": null,
    "recipientorgunitnum": null,
    "recipientrefnumber": null,
    "restrictiondeliveryfiction": null,
    "sender": null,
    "senderaddress": null,
    "senderident": null,
    "senderorgunit": null,
    "senderorgunitnum": null,
    "senderrefnumber": null,
    "sendertype": null,
    "signeddeliveryinfo_id": null,
    "signedmessage_id": null,
    "tohands": null
}
Response
{
    "id": "1600000101"
}
Request

PUT

https://atd.abra.eu/demodata/databoxmesssents/{id}?select=id
Body
{
    "ambiguousrecipient": null,
    "dmtype": null,
    "idsender": null,
    "legaltitlelaw": null,
    "legaltitlepar": null,
    "legaltitlepoint": null,
    "legaltitlesect": null,
    "legaltitleyear": null,
    "messagestatus": null,
    "ovm": null,
    "owner_id": null,
    "personaldelivery": null,
    "publishownid": null,
    "qtimestamp": null,
    "recipient": null,
    "recipientaddress": null,
    "recipientident": null,
    "recipientorgunit": null,
    "recipientorgunitnum": null,
    "recipientrefnumber": null,
    "restrictiondeliveryfiction": null,
    "sender": null,
    "senderaddress": null,
    "senderident": null,
    "senderorgunit": null,
    "senderorgunitnum": null,
    "senderrefnumber": null,
    "sendertype": null,
    "signeddeliveryinfo_id": null,
    "signedmessage_id": null,
    "tohands": null
}
Response
{
    "id": "1600000101"
}

DELETE

https://atd.abra.eu/demodata/databoxmesssents/{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": "databoxmesssents",
                "object_data": {
                    "ambiguousrecipient": null,
                    "dmtype": null,
                    "idsender": null,
                    "legaltitlelaw": null,
                    "legaltitlepar": null,
                    "legaltitlepoint": null,
                    "legaltitlesect": null,
                    "legaltitleyear": null,
                    "messagestatus": null,
                    "ovm": null,
                    "owner_id": null,
                    "personaldelivery": null,
                    "publishownid": null,
                    "qtimestamp": null,
                    "recipient": null,
                    "recipientaddress": null,
                    "recipientident": null,
                    "recipientorgunit": null,
                    "recipientorgunitnum": null,
                    "recipientrefnumber": null,
                    "restrictiondeliveryfiction": null,
                    "sender": null,
                    "senderaddress": null,
                    "senderident": null,
                    "senderorgunit": null,
                    "senderorgunitnum": null,
                    "senderrefnumber": null,
                    "sendertype": null,
                    "signeddeliveryinfo_id": null,
                    "signedmessage_id": null,
                    "tohands": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "databoxmesssents",
                "object_data": {
                    "ambiguousrecipient": null,
                    "dmtype": null,
                    "idsender": null,
                    "legaltitlelaw": null,
                    "legaltitlepar": null,
                    "legaltitlepoint": null,
                    "legaltitlesect": null,
                    "legaltitleyear": null,
                    "messagestatus": null,
                    "ovm": null,
                    "owner_id": null,
                    "personaldelivery": null,
                    "publishownid": null,
                    "qtimestamp": null,
                    "recipient": null,
                    "recipientaddress": null,
                    "recipientident": null,
                    "recipientorgunit": null,
                    "recipientorgunitnum": null,
                    "recipientrefnumber": null,
                    "restrictiondeliveryfiction": null,
                    "sender": null,
                    "senderaddress": null,
                    "senderident": null,
                    "senderorgunit": null,
                    "senderorgunitnum": null,
                    "senderrefnumber": null,
                    "sendertype": null,
                    "signeddeliveryinfo_id": null,
                    "signedmessage_id": null,
                    "tohands": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "databoxmesssents",
                "obj_id": "1600000100",
                "object_data": {
                    "ambiguousrecipient": null,
                    "dmtype": null,
                    "idsender": null,
                    "legaltitlelaw": null,
                    "legaltitlepar": null,
                    "legaltitlepoint": null,
                    "legaltitlesect": null,
                    "legaltitleyear": null,
                    "messagestatus": null,
                    "ovm": null,
                    "owner_id": null,
                    "personaldelivery": null,
                    "publishownid": null,
                    "qtimestamp": null,
                    "recipient": null,
                    "recipientaddress": null,
                    "recipientident": null,
                    "recipientorgunit": null,
                    "recipientorgunitnum": null,
                    "recipientrefnumber": null,
                    "restrictiondeliveryfiction": null,
                    "sender": null,
                    "senderaddress": null,
                    "senderident": null,
                    "senderorgunit": null,
                    "senderorgunitnum": null,
                    "senderrefnumber": null,
                    "sendertype": null,
                    "signeddeliveryinfo_id": null,
                    "signedmessage_id": null,
                    "tohands": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "databoxmesssents",
                "obj_id": "1600000101",
                "object_data": {
                    "ambiguousrecipient": null,
                    "dmtype": null,
                    "idsender": null,
                    "legaltitlelaw": null,
                    "legaltitlepar": null,
                    "legaltitlepoint": null,
                    "legaltitlesect": null,
                    "legaltitleyear": null,
                    "messagestatus": null,
                    "ovm": null,
                    "owner_id": null,
                    "personaldelivery": null,
                    "publishownid": null,
                    "qtimestamp": null,
                    "recipient": null,
                    "recipientaddress": null,
                    "recipientident": null,
                    "recipientorgunit": null,
                    "recipientorgunitnum": null,
                    "recipientrefnumber": null,
                    "restrictiondeliveryfiction": null,
                    "sender": null,
                    "senderaddress": null,
                    "senderident": null,
                    "senderorgunit": null,
                    "senderorgunitnum": null,
                    "senderrefnumber": null,
                    "sendertype": null,
                    "signeddeliveryinfo_id": null,
                    "signedmessage_id": null,
                    "tohands": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "databoxmesssents",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "databoxmesssents",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "databoxmesssents",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "databoxmesssents",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "databoxmesssents",
                "obj_id": "1600000104"
            }
        }
    ]
}