Vzkaz

GET

/msgssent

Získá kolekci BO Vzkaz

GET

/msgssent/{id}

Získá konkrétní BO Vzkaz

POST

/msgssent

Vytvoří nový BO Vzkaz a vrátí jeho kompletní reprezentaci

PUT

/msgssent/{id}

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

DELETE

/msgssent/{id}

Smaže BO Vzkaz na základě jeho ID

Metadata - Perzistentní položky

Attachments array (msgattachment) relace

Přílohy; kolekce BO Příloha, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

ConfirmReading boolean

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

DeleteAfterDeletingByAll boolean

Smazat po smazání všemi, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

Links array (msglink) relace

Odkazy; kolekce BO Odkaz, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

MsgBody string (0)

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

MsgSubject string (500)

Předmět, 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

Recipients array (msgrecipient) relace

Adresáti; kolekce BO Adresát vzkazu, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

SenderUser_ID string (securityuser) relace

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

SentDate$DATE string

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

ValidToDate$DATE string

Datum platnosti, 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

RecipientsInOneLine string (2048)

Souhrn adresátů

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request 
GET
https://atd.abra.eu/demodata/msgssent?take=1
GET
https://atd.abra.eu/demodata/msgssent/{id}
Response 
{
    "Attachments": null,
    "ConfirmReading": null,
    "DeleteAfterDeletingByAll": null,
    "ID": null,
    "Links": null,
    "MsgBody": null,
    "MsgSubject": null,
    "ObjVersion": null,
    "Recipients": null,
    "SenderUser_ID": null,
    "SentDate$DATE": null,
    "ValidToDate$DATE": null
}
Request POST 
POST
https://atd.abra.eu/demodata/query
{"class": "msgssent", "take": "1"}
POST
https://atd.abra.eu/demodata/msgssent/query
{"take": "1"}
Response 
{
    "Attachments": null,
    "ConfirmReading": null,
    "DeleteAfterDeletingByAll": null,
    "ID": null,
    "Links": null,
    "MsgBody": null,
    "MsgSubject": null,
    "ObjVersion": null,
    "Recipients": null,
    "SenderUser_ID": null,
    "SentDate$DATE": null,
    "ValidToDate$DATE": null
}
Request 
POST
https://atd.abra.eu/demodata/msgssent?select=id
Body 
{
    "Attachments": null,
    "ConfirmReading": null,
    "DeleteAfterDeletingByAll": null,
    "Links": null,
    "MsgBody": null,
    "MsgSubject": null,
    "Recipients": null,
    "SenderUser_ID": null,
    "SentDate$DATE": null,
    "ValidToDate$DATE": null
}
Response 
{
    "id": "1600000101"
}
Request 
PUT
https://atd.abra.eu/demodata/msgssent/{id}?select=id
Body 
{
    "Attachments": null,
    "ConfirmReading": null,
    "DeleteAfterDeletingByAll": null,
    "Links": null,
    "MsgBody": null,
    "MsgSubject": null,
    "Recipients": null,
    "SenderUser_ID": null,
    "SentDate$DATE": null,
    "ValidToDate$DATE": null
}
Response 
{
    "id": "1600000101"
}
DELETE
https://atd.abra.eu/demodata/msgssent/{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": "msgssent",
                "object_data": {
                    "Attachments": null,
                    "ConfirmReading": null,
                    "DeleteAfterDeletingByAll": null,
                    "Links": null,
                    "MsgBody": null,
                    "MsgSubject": null,
                    "Recipients": null,
                    "SenderUser_ID": null,
                    "SentDate$DATE": null,
                    "ValidToDate$DATE": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "msgssent",
                "object_data": {
                    "Attachments": null,
                    "ConfirmReading": null,
                    "DeleteAfterDeletingByAll": null,
                    "Links": null,
                    "MsgBody": null,
                    "MsgSubject": null,
                    "Recipients": null,
                    "SenderUser_ID": null,
                    "SentDate$DATE": null,
                    "ValidToDate$DATE": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "msgssent",
                "obj_id": "1600000100",
                "object_data": {
                    "Attachments": null,
                    "ConfirmReading": null,
                    "DeleteAfterDeletingByAll": null,
                    "Links": null,
                    "MsgBody": null,
                    "MsgSubject": null,
                    "Recipients": null,
                    "SenderUser_ID": null,
                    "SentDate$DATE": null,
                    "ValidToDate$DATE": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "msgssent",
                "obj_id": "1600000101",
                "object_data": {
                    "Attachments": null,
                    "ConfirmReading": null,
                    "DeleteAfterDeletingByAll": null,
                    "Links": null,
                    "MsgBody": null,
                    "MsgSubject": null,
                    "Recipients": null,
                    "SenderUser_ID": null,
                    "SentDate$DATE": null,
                    "ValidToDate$DATE": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "msgssent",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "msgssent",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "msgssent",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "msgssent",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "msgssent",
                "obj_id": "1600000104"
            }
        }
    ]
}