E-mailový účet

GET
/emailaccounts

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

GET
/emailaccounts/{id}

Získá konkrétní BO E-mailový účet

POST
/emailaccounts

Vytvoří nový BO E-mailový účet a vrátí jeho kompletní reprezentaci

PUT
/emailaccounts/{id}

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

DELETE
/emailaccounts/{id}

Smaže BO E-mailový účet na základě jeho ID

Metadata - Perzistentní položky

AccountAddress string (50)

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

AccountName string (50)

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

BusOrder_ID string (busorder) relace

Zakázka; ID objektu 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; ID objektu 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; ID objektu Obchodní 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 (0)

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; ID objektu 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; ID objektu E-mailový úč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 (50)

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; ID objektu Uživatel, 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; ID objektu Řada dokladů, 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ů; ID objektu Řada dokladů, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

ReplyTo string (100)

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ů; ID objektu Řada dokladů, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

Server string (50)

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,
    "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,
    "ID": 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,
    "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,
    "ID": 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,
    "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,
    "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,
                    "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,
                    "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,
                    "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,
                    "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"
            }
        }
    ]
}