Pravidlo zpracování doručené e-mail. pošty

GET

/emailprocessingrules

Získá kolekci BO Pravidlo zpracování doručené e-mail. pošty

GET

/emailprocessingrules/{id}

Získá konkrétní BO Pravidlo zpracování doručené e-mail. pošty

POST

/emailprocessingrules

Vytvoří nový BO Pravidlo zpracování doručené e-mail. pošty a vrátí jeho kompletní reprezentaci

PUT

/emailprocessingrules/{id}

Provede aktualizaci BO Pravidlo zpracování doručené e-mail. 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

/emailprocessingrules/{id}

Smaže BO Pravidlo zpracování doručené e-mail. pošty na základě jeho ID

Metadata - Perzistentní položky

Description string (200)

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

EmailAccount_ID string (emailaccount) relace

E-mailový účet; ID objektu E-mailový účet, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

EmailCondition string (0)

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

FileNameMask string (40)

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

FileNameMaskIsRegEx boolean

Maska pro název přílohy je regulární výraz, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

GoOn boolean

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

IsForAttachment boolean

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

IsForEmail boolean

Pro e-mail, 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

PosIndex integer

Pořadí, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole nepodporuje ochranu dat/GDPR

RuleActions array (emailprocessingruleaction) relace

Akce; kolekce BO Akce pravidla pro zpracování doručené e-mail. pošty, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

SendToMask string (100)

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

SendToMaskIsRegEx boolean

Maska pro příjemce je regulární výraz, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

SenderMask string (100)

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

SenderMaskIsRegEx boolean

Maska pro odesílatele je regulární výraz, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

SubjectMask string (128)

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

SubjectMaskIsRegEx boolean

Maska pro předmět je regulární výraz, 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

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

GET

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

GET

https://atd.abra.eu/demodata/emailprocessingrules/{id}
Response
{
    "Description": null,
    "EmailAccount_ID": null,
    "EmailCondition": null,
    "FileNameMask": null,
    "FileNameMaskIsRegEx": null,
    "GoOn": null,
    "ID": null,
    "IsForAttachment": null,
    "IsForEmail": null,
    "ObjVersion": null,
    "PosIndex": null,
    "RuleActions": null,
    "SendToMask": null,
    "SendToMaskIsRegEx": null,
    "SenderMask": null,
    "SenderMaskIsRegEx": null,
    "SubjectMask": null,
    "SubjectMaskIsRegEx": null
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/emailprocessingrules/query
{"take": "1"}
Response
{
    "Description": null,
    "EmailAccount_ID": null,
    "EmailCondition": null,
    "FileNameMask": null,
    "FileNameMaskIsRegEx": null,
    "GoOn": null,
    "ID": null,
    "IsForAttachment": null,
    "IsForEmail": null,
    "ObjVersion": null,
    "PosIndex": null,
    "RuleActions": null,
    "SendToMask": null,
    "SendToMaskIsRegEx": null,
    "SenderMask": null,
    "SenderMaskIsRegEx": null,
    "SubjectMask": null,
    "SubjectMaskIsRegEx": null
}
Request

POST

https://atd.abra.eu/demodata/emailprocessingrules?select=id
Body
{
    "Description": null,
    "EmailAccount_ID": null,
    "EmailCondition": null,
    "FileNameMask": null,
    "FileNameMaskIsRegEx": null,
    "GoOn": null,
    "IsForAttachment": null,
    "IsForEmail": null,
    "PosIndex": null,
    "RuleActions": null,
    "SendToMask": null,
    "SendToMaskIsRegEx": null,
    "SenderMask": null,
    "SenderMaskIsRegEx": null,
    "SubjectMask": null,
    "SubjectMaskIsRegEx": null
}
Response
{
    "id": "1600000101"
}
Request

PUT

https://atd.abra.eu/demodata/emailprocessingrules/{id}?select=id
Body
{
    "Description": null,
    "EmailAccount_ID": null,
    "EmailCondition": null,
    "FileNameMask": null,
    "FileNameMaskIsRegEx": null,
    "GoOn": null,
    "IsForAttachment": null,
    "IsForEmail": null,
    "PosIndex": null,
    "RuleActions": null,
    "SendToMask": null,
    "SendToMaskIsRegEx": null,
    "SenderMask": null,
    "SenderMaskIsRegEx": null,
    "SubjectMask": null,
    "SubjectMaskIsRegEx": null
}
Response
{
    "id": "1600000101"
}

DELETE

https://atd.abra.eu/demodata/emailprocessingrules/{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": "emailprocessingrules",
                "object_data": {
                    "Description": null,
                    "EmailAccount_ID": null,
                    "EmailCondition": null,
                    "FileNameMask": null,
                    "FileNameMaskIsRegEx": null,
                    "GoOn": null,
                    "IsForAttachment": null,
                    "IsForEmail": null,
                    "PosIndex": null,
                    "RuleActions": null,
                    "SendToMask": null,
                    "SendToMaskIsRegEx": null,
                    "SenderMask": null,
                    "SenderMaskIsRegEx": null,
                    "SubjectMask": null,
                    "SubjectMaskIsRegEx": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "emailprocessingrules",
                "object_data": {
                    "Description": null,
                    "EmailAccount_ID": null,
                    "EmailCondition": null,
                    "FileNameMask": null,
                    "FileNameMaskIsRegEx": null,
                    "GoOn": null,
                    "IsForAttachment": null,
                    "IsForEmail": null,
                    "PosIndex": null,
                    "RuleActions": null,
                    "SendToMask": null,
                    "SendToMaskIsRegEx": null,
                    "SenderMask": null,
                    "SenderMaskIsRegEx": null,
                    "SubjectMask": null,
                    "SubjectMaskIsRegEx": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "emailprocessingrules",
                "obj_id": "1600000100",
                "object_data": {
                    "Description": null,
                    "EmailAccount_ID": null,
                    "EmailCondition": null,
                    "FileNameMask": null,
                    "FileNameMaskIsRegEx": null,
                    "GoOn": null,
                    "IsForAttachment": null,
                    "IsForEmail": null,
                    "PosIndex": null,
                    "RuleActions": null,
                    "SendToMask": null,
                    "SendToMaskIsRegEx": null,
                    "SenderMask": null,
                    "SenderMaskIsRegEx": null,
                    "SubjectMask": null,
                    "SubjectMaskIsRegEx": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "emailprocessingrules",
                "obj_id": "1600000101",
                "object_data": {
                    "Description": null,
                    "EmailAccount_ID": null,
                    "EmailCondition": null,
                    "FileNameMask": null,
                    "FileNameMaskIsRegEx": null,
                    "GoOn": null,
                    "IsForAttachment": null,
                    "IsForEmail": null,
                    "PosIndex": null,
                    "RuleActions": null,
                    "SendToMask": null,
                    "SendToMaskIsRegEx": null,
                    "SenderMask": null,
                    "SenderMaskIsRegEx": null,
                    "SubjectMask": null,
                    "SubjectMaskIsRegEx": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "emailprocessingrules",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "emailprocessingrules",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "emailprocessingrules",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "emailprocessingrules",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "emailprocessingrules",
                "obj_id": "1600000104"
            }
        }
    ]
}