E-mailový účet

GET

/emailaccounts

Získá kolekci BO E-mailový účet

GET

/emailaccounts/meta/dataprotection

Získá seznam položek BO, které mohou být chráněny na BO E-mailový účet

GET

/emailaccounts/views/{view}

Získá pohled nad BO E-mailový účet

GET

/emailaccounts/{id}

Získá daný BO E-mailový účet

GET

/emailaccounts/{id}/iseditlock

Otestuje, zda existuje editační zámek na daném BO E-mailový účet

GET

/emailaccounts/{id}/meta/dataprotection

Získá seznam chráněných položek, které jsou na BO E-mailový účet aktuálnímu uživateli znepřístupněny

GET

/emailaccounts/{id}/userparameters

Získá seznam uživatelských parametrů včetně jejich hodnot k danému BO E-mailový účet

POST

/emailaccounts

Vytvoří nový BO E-mailový účet

POST

/emailaccounts/query

Vyhodnotí query dotaz nad BO E-mailový účet

PUT

/emailaccounts/{id}

Modifikuje daný BO E-mailový účet

PUT

/emailaccounts/{id}/editlock

Vytvoří editační zámek na daném BO E-mailový účet

PUT

/emailaccounts/{id}/editunlock

Zruší editační zámek na daném BO E-mailový účet

DELETE

/emailaccounts/{id}

Smaže BO E-mailový účet

Metadata - Perzistentní položky

accountaddress string (320)

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

accountname string (200)

Název účtu, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

accounttype integer

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

actualizationinterval integer

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

authentificationdata string

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

authentificationdriver_id string (emailauthentificationdriver) relace

Typ autentifikace, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole je přístupná pro hromadné změny

busorder_id string (busorder) relace

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

busproject_id string (busproject) relace

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

bustransaction_id string (bustransaction) relace

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

connectionsecurity integer

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

databoxtype integer

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

defaulttext string

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

defaulttextsavedas integer

Výchozí text uložit jako, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

division_id string (division) relace

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

effectiveovm boolean

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

emailsmtpaccount_id string (emailsmtpaccount) relace

Účet odchozího serveru SMTP, 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

lastactualization$date string

Datum a čas kompletní aktualizace doručených datových zpráv, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

leavemsgonserver boolean

Nemazat zprávy na serveru, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

login string (500)

Přihlašovací jméno, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

maxsizelimit integer

Max. velikost přílohy (MB), 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

owner_id string (securityuser) relace

Vlastník účtu, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

personaldeliverydocqueue_id string (docqueue) relace

Řada dokladů datových zpráv do vl. rukou, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

port integer

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

receivedmaildocqueue_id string (docqueue) relace

Řada dokladů doručených e-mailů, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

replyto string (320)

E-mailová adresa pro odpověď, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

reportemail boolean

Oznámit přečtení e-mailu, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

reportemaildelivery boolean

Oznámit doručení e-mailu, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

secpassword string (240)

Zakódované heslo, pole vlastněné tabulkou, možné řadit a filtrovat

sendmaildocqueue_id string (docqueue) relace

Řada dokladů odeslaných e-mailů, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

server string (500)

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

testdatabox boolean

Testovací účet datových schránek, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

usecredentialstoreceive boolean

Automaticky použít přihlašovací údaje pro příjem datových zpráv., pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

usecredentialstosending boolean

Automaticky použít přihlašovací údaje pro odeslání datových zpráv., pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

Metadata - Neperzistentní položky

accounttypename string (20)

Typ účtu - název

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

password string (115)

Heslo, pouze pro čtení

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

GET

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

GET

https://atd.abra.eu/demodata/emailaccounts/{id}
Response
{
    "accountaddress": null,
    "accountname": null,
    "accounttype": null,
    "actualizationinterval": null,
    "authentificationdata": null,
    "authentificationdriver_id": null,
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "connectionsecurity": null,
    "databoxtype": null,
    "defaulttext": null,
    "defaulttextsavedas": null,
    "division_id": null,
    "effectiveovm": null,
    "emailsmtpaccount_id": null,
    "hidden": null,
    "lastactualization$date": null,
    "leavemsgonserver": null,
    "login": null,
    "maxsizelimit": null,
    "objversion": null,
    "owner_id": null,
    "personaldeliverydocqueue_id": null,
    "port": null,
    "receivedmaildocqueue_id": null,
    "replyto": null,
    "reportemail": null,
    "reportemaildelivery": null,
    "secpassword": null,
    "sendmaildocqueue_id": null,
    "server": null,
    "testdatabox": null,
    "usecredentialstoreceive": null,
    "usecredentialstosending": null
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/emailaccounts/query
{"take": "1"}
Response
{
    "accountaddress": null,
    "accountname": null,
    "accounttype": null,
    "actualizationinterval": null,
    "authentificationdata": null,
    "authentificationdriver_id": null,
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "connectionsecurity": null,
    "databoxtype": null,
    "defaulttext": null,
    "defaulttextsavedas": null,
    "division_id": null,
    "effectiveovm": null,
    "emailsmtpaccount_id": null,
    "hidden": null,
    "lastactualization$date": null,
    "leavemsgonserver": null,
    "login": null,
    "maxsizelimit": null,
    "objversion": null,
    "owner_id": null,
    "personaldeliverydocqueue_id": null,
    "port": null,
    "receivedmaildocqueue_id": null,
    "replyto": null,
    "reportemail": null,
    "reportemaildelivery": null,
    "secpassword": null,
    "sendmaildocqueue_id": null,
    "server": null,
    "testdatabox": null,
    "usecredentialstoreceive": null,
    "usecredentialstosending": null
}
Request

POST

https://atd.abra.eu/demodata/emailaccounts?select=id
Body
{
    "accountaddress": null,
    "accountname": null,
    "accounttype": null,
    "actualizationinterval": null,
    "authentificationdata": null,
    "authentificationdriver_id": null,
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "connectionsecurity": null,
    "databoxtype": null,
    "defaulttext": null,
    "defaulttextsavedas": null,
    "division_id": null,
    "effectiveovm": null,
    "emailsmtpaccount_id": null,
    "hidden": null,
    "lastactualization$date": null,
    "leavemsgonserver": null,
    "login": null,
    "maxsizelimit": null,
    "owner_id": null,
    "personaldeliverydocqueue_id": null,
    "port": null,
    "receivedmaildocqueue_id": null,
    "replyto": null,
    "reportemail": null,
    "reportemaildelivery": null,
    "secpassword": null,
    "sendmaildocqueue_id": null,
    "server": null,
    "testdatabox": null,
    "usecredentialstoreceive": null,
    "usecredentialstosending": null
}
Response
{
    "id": "1600000101"
}
Request

PUT

https://atd.abra.eu/demodata/emailaccounts/{id}?select=id
Body
{
    "accountaddress": null,
    "accountname": null,
    "accounttype": null,
    "actualizationinterval": null,
    "authentificationdata": null,
    "authentificationdriver_id": null,
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "connectionsecurity": null,
    "databoxtype": null,
    "defaulttext": null,
    "defaulttextsavedas": null,
    "division_id": null,
    "effectiveovm": null,
    "emailsmtpaccount_id": null,
    "hidden": null,
    "lastactualization$date": null,
    "leavemsgonserver": null,
    "login": null,
    "maxsizelimit": null,
    "owner_id": null,
    "personaldeliverydocqueue_id": null,
    "port": null,
    "receivedmaildocqueue_id": null,
    "replyto": null,
    "reportemail": null,
    "reportemaildelivery": null,
    "secpassword": null,
    "sendmaildocqueue_id": null,
    "server": null,
    "testdatabox": null,
    "usecredentialstoreceive": null,
    "usecredentialstosending": null
}
Response
{
    "id": "1600000101"
}

DELETE

https://atd.abra.eu/demodata/emailaccounts/{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": "emailaccounts",
                "object_data": {
                    "accountaddress": null,
                    "accountname": null,
                    "accounttype": null,
                    "actualizationinterval": null,
                    "authentificationdata": null,
                    "authentificationdriver_id": null,
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "connectionsecurity": null,
                    "databoxtype": null,
                    "defaulttext": null,
                    "defaulttextsavedas": null,
                    "division_id": null,
                    "effectiveovm": null,
                    "emailsmtpaccount_id": null,
                    "hidden": null,
                    "lastactualization$date": null,
                    "leavemsgonserver": null,
                    "login": null,
                    "maxsizelimit": null,
                    "owner_id": null,
                    "personaldeliverydocqueue_id": null,
                    "port": null,
                    "receivedmaildocqueue_id": null,
                    "replyto": null,
                    "reportemail": null,
                    "reportemaildelivery": null,
                    "secpassword": null,
                    "sendmaildocqueue_id": null,
                    "server": null,
                    "testdatabox": null,
                    "usecredentialstoreceive": null,
                    "usecredentialstosending": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "emailaccounts",
                "object_data": {
                    "accountaddress": null,
                    "accountname": null,
                    "accounttype": null,
                    "actualizationinterval": null,
                    "authentificationdata": null,
                    "authentificationdriver_id": null,
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "connectionsecurity": null,
                    "databoxtype": null,
                    "defaulttext": null,
                    "defaulttextsavedas": null,
                    "division_id": null,
                    "effectiveovm": null,
                    "emailsmtpaccount_id": null,
                    "hidden": null,
                    "lastactualization$date": null,
                    "leavemsgonserver": null,
                    "login": null,
                    "maxsizelimit": null,
                    "owner_id": null,
                    "personaldeliverydocqueue_id": null,
                    "port": null,
                    "receivedmaildocqueue_id": null,
                    "replyto": null,
                    "reportemail": null,
                    "reportemaildelivery": null,
                    "secpassword": null,
                    "sendmaildocqueue_id": null,
                    "server": null,
                    "testdatabox": null,
                    "usecredentialstoreceive": null,
                    "usecredentialstosending": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "emailaccounts",
                "obj_id": "1600000100",
                "object_data": {
                    "accountaddress": null,
                    "accountname": null,
                    "accounttype": null,
                    "actualizationinterval": null,
                    "authentificationdata": null,
                    "authentificationdriver_id": null,
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "connectionsecurity": null,
                    "databoxtype": null,
                    "defaulttext": null,
                    "defaulttextsavedas": null,
                    "division_id": null,
                    "effectiveovm": null,
                    "emailsmtpaccount_id": null,
                    "hidden": null,
                    "lastactualization$date": null,
                    "leavemsgonserver": null,
                    "login": null,
                    "maxsizelimit": null,
                    "owner_id": null,
                    "personaldeliverydocqueue_id": null,
                    "port": null,
                    "receivedmaildocqueue_id": null,
                    "replyto": null,
                    "reportemail": null,
                    "reportemaildelivery": null,
                    "secpassword": null,
                    "sendmaildocqueue_id": null,
                    "server": null,
                    "testdatabox": null,
                    "usecredentialstoreceive": null,
                    "usecredentialstosending": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "emailaccounts",
                "obj_id": "1600000101",
                "object_data": {
                    "accountaddress": null,
                    "accountname": null,
                    "accounttype": null,
                    "actualizationinterval": null,
                    "authentificationdata": null,
                    "authentificationdriver_id": null,
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "connectionsecurity": null,
                    "databoxtype": null,
                    "defaulttext": null,
                    "defaulttextsavedas": null,
                    "division_id": null,
                    "effectiveovm": null,
                    "emailsmtpaccount_id": null,
                    "hidden": null,
                    "lastactualization$date": null,
                    "leavemsgonserver": null,
                    "login": null,
                    "maxsizelimit": null,
                    "owner_id": null,
                    "personaldeliverydocqueue_id": null,
                    "port": null,
                    "receivedmaildocqueue_id": null,
                    "replyto": null,
                    "reportemail": null,
                    "reportemaildelivery": null,
                    "secpassword": null,
                    "sendmaildocqueue_id": null,
                    "server": null,
                    "testdatabox": null,
                    "usecredentialstoreceive": null,
                    "usecredentialstosending": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "emailaccounts",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "emailaccounts",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "emailaccounts",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "emailaccounts",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "emailaccounts",
                "obj_id": "1600000104"
            }
        }
    ]
}