Typ kampaně

GET

/crmcampaigntypes

Získá kolekci BO Typ kampaně

GET

/crmcampaigntypes/meta/dataprotection

Získá seznam položek BO, které mohou být chráněny na BO Typ kampaně

GET

/crmcampaigntypes/views/{view}

Získá pohled nad BO Typ kampaně

GET

/crmcampaigntypes/{id}

Získá daný BO Typ kampaně

GET

/crmcampaigntypes/{id}/attachments

Získá řádky kolekce Odesílaná příloha

GET

/crmcampaigntypes/{id}/attachments/{id1}

Získá daný řádek kolekce Odesílaná příloha

GET

/crmcampaigntypes/{id}/iseditlock

Otestuje, zda existuje editační zámek na daném BO Typ kampaně

GET

/crmcampaigntypes/{id}/meta/dataprotection

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

GET

/crmcampaigntypes/{id}/rows

Získá řádky kolekce Proměnná kampaně na typu kampaně

GET

/crmcampaigntypes/{id}/rows/{id1}

Získá daný řádek kolekce Proměnná kampaně na typu kampaně

GET

/crmcampaigntypes/{id}/userparameters

Získá seznam uživatelských parametrů včetně jejich hodnot k danému BO Typ kampaně

POST

/crmcampaigntypes

Vytvoří nový BO Typ kampaně

POST

/crmcampaigntypes/query

Vyhodnotí query dotaz nad BO Typ kampaně

POST

/crmcampaigntypes/{id}/attachments

Vytvoří nový řádek v kolekci Odesílaná příloha

POST

/crmcampaigntypes/{id}/rows

Vytvoří nový řádek v kolekci Proměnná kampaně na typu kampaně

PUT

/crmcampaigntypes/{id}

Modifikuje daný BO Typ kampaně

PUT

/crmcampaigntypes/{id}/attachments/{id1}

Modifikuje řádek v kolekci Odesílaná příloha

PUT

/crmcampaigntypes/{id}/editlock

Vytvoří editační zámek na daném BO Typ kampaně

PUT

/crmcampaigntypes/{id}/editunlock

Zruší editační zámek na daném BO Typ kampaně

PUT

/crmcampaigntypes/{id}/rows/{id1}

Modifikuje řádek v kolekci Proměnná kampaně na typu kampaně

DELETE

/crmcampaigntypes/{id}

Smaže BO Typ kampaně

DELETE

/crmcampaigntypes/{id}/attachments/{id1}

Smaže řádek z kolekce Odesílaná příloha

DELETE

/crmcampaigntypes/{id}/rows/{id1}

Smaže řádek z kolekce Proměnná kampaně na typu kampaně

Metadata - Perzistentní položky

activitycreate boolean

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

activitydescription string

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

activitypriority integer

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

activityprocess_id string (crmactivityprocess) relace

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

activityproduct_id string (crmproduct) relace

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

activityqueue_id string (crmactivityqueue) relace

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

activitystate integer

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

activitysubject string

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

activitytype_id string (crmactivitytype) relace

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

attachments array (emailsentattachment) relace

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

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

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

channel integer

Komunikační kanál, 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

emailaccount_id string (emailaccount) relace

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

emailattachment string

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

emailbody string

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

emailformat integer

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

emailsubject string

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

hiddenemailaccount_id string (emailaccount) relace

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

massannouncement boolean

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

name string (200)

Název, 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

pdmcashondelivery number

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

pdmdescription string

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

pdmdocqueue_id string (docqueue) relace

Řada dokladů pošty, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

pdminsuredvalue number

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

pdmissuedcontent_id string (pdmissuedcontenttype) relace

Typ obsahu pošty, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

pdmmultiplicator integer

Počet zásilek, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

pdmpostage number

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

pdmpostageincash boolean

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

pdmpostprovider_id string (pdmpostprovider) relace

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

pdmpricelist_id string (pdmpricelist) relace

Ceník pošty, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

pdmweight number

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

pdmweightunit integer

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

rows array (crmcampaigntypevariable) relace

kolekce BO Proměnná kampaně na typu kampaně, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

screxecute boolean

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

scrlibraryname string (50)

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

scrmethodname string (50)

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

scrpackagename string (100)

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

solverrole_id string (securityrole) relace

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

solveruser_id string (securityuser) relace

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

useemailtemplate boolean

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

Metadata - Neperzistentní položky

cashondelivery number

Dobírečné

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

insuredvalue number

Cena zásilky

weight number

Hmotnost

weightunit integer

Jednotka hmotnosti

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

GET

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

GET

https://atd.abra.eu/demodata/crmcampaigntypes/{id}
Response
{
    "activitycreate": null,
    "activitydescription": null,
    "activitypriority": null,
    "activityprocess_id": null,
    "activityproduct_id": null,
    "activityqueue_id": null,
    "activitystate": null,
    "activitysubject": null,
    "activitytype_id": null,
    "attachments": null,
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "channel": null,
    "division_id": null,
    "emailaccount_id": null,
    "emailattachment": null,
    "emailbody": null,
    "emailformat": null,
    "emailsubject": null,
    "hiddenemailaccount_id": null,
    "massannouncement": null,
    "name": null,
    "objversion": null,
    "pdmcashondelivery": null,
    "pdmdescription": null,
    "pdmdocqueue_id": null,
    "pdminsuredvalue": null,
    "pdmissuedcontent_id": null,
    "pdmmultiplicator": null,
    "pdmpostage": null,
    "pdmpostageincash": null,
    "pdmpostprovider_id": null,
    "pdmpricelist_id": null,
    "pdmweight": null,
    "pdmweightunit": null,
    "rows": null,
    "screxecute": null,
    "scrlibraryname": null,
    "scrmethodname": null,
    "scrpackagename": null,
    "solverrole_id": null,
    "solveruser_id": null,
    "useemailtemplate": null
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/crmcampaigntypes/query
{"take": "1"}
Response
{
    "activitycreate": null,
    "activitydescription": null,
    "activitypriority": null,
    "activityprocess_id": null,
    "activityproduct_id": null,
    "activityqueue_id": null,
    "activitystate": null,
    "activitysubject": null,
    "activitytype_id": null,
    "attachments": null,
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "channel": null,
    "division_id": null,
    "emailaccount_id": null,
    "emailattachment": null,
    "emailbody": null,
    "emailformat": null,
    "emailsubject": null,
    "hiddenemailaccount_id": null,
    "massannouncement": null,
    "name": null,
    "objversion": null,
    "pdmcashondelivery": null,
    "pdmdescription": null,
    "pdmdocqueue_id": null,
    "pdminsuredvalue": null,
    "pdmissuedcontent_id": null,
    "pdmmultiplicator": null,
    "pdmpostage": null,
    "pdmpostageincash": null,
    "pdmpostprovider_id": null,
    "pdmpricelist_id": null,
    "pdmweight": null,
    "pdmweightunit": null,
    "rows": null,
    "screxecute": null,
    "scrlibraryname": null,
    "scrmethodname": null,
    "scrpackagename": null,
    "solverrole_id": null,
    "solveruser_id": null,
    "useemailtemplate": null
}
Request

POST

https://atd.abra.eu/demodata/crmcampaigntypes?select=id
Body
{
    "activitycreate": null,
    "activitydescription": null,
    "activitypriority": null,
    "activityprocess_id": null,
    "activityproduct_id": null,
    "activityqueue_id": null,
    "activitystate": null,
    "activitysubject": null,
    "activitytype_id": null,
    "attachments": null,
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "channel": null,
    "division_id": null,
    "emailaccount_id": null,
    "emailattachment": null,
    "emailbody": null,
    "emailformat": null,
    "emailsubject": null,
    "hiddenemailaccount_id": null,
    "massannouncement": null,
    "name": null,
    "pdmcashondelivery": null,
    "pdmdescription": null,
    "pdmdocqueue_id": null,
    "pdminsuredvalue": null,
    "pdmissuedcontent_id": null,
    "pdmmultiplicator": null,
    "pdmpostage": null,
    "pdmpostageincash": null,
    "pdmpostprovider_id": null,
    "pdmpricelist_id": null,
    "pdmweight": null,
    "pdmweightunit": null,
    "rows": null,
    "screxecute": null,
    "scrlibraryname": null,
    "scrmethodname": null,
    "scrpackagename": null,
    "solverrole_id": null,
    "solveruser_id": null,
    "useemailtemplate": null
}
Response
{
    "id": "1600000101"
}
Request

PUT

https://atd.abra.eu/demodata/crmcampaigntypes/{id}?select=id
Body
{
    "activitycreate": null,
    "activitydescription": null,
    "activitypriority": null,
    "activityprocess_id": null,
    "activityproduct_id": null,
    "activityqueue_id": null,
    "activitystate": null,
    "activitysubject": null,
    "activitytype_id": null,
    "attachments": null,
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "channel": null,
    "division_id": null,
    "emailaccount_id": null,
    "emailattachment": null,
    "emailbody": null,
    "emailformat": null,
    "emailsubject": null,
    "hiddenemailaccount_id": null,
    "massannouncement": null,
    "name": null,
    "pdmcashondelivery": null,
    "pdmdescription": null,
    "pdmdocqueue_id": null,
    "pdminsuredvalue": null,
    "pdmissuedcontent_id": null,
    "pdmmultiplicator": null,
    "pdmpostage": null,
    "pdmpostageincash": null,
    "pdmpostprovider_id": null,
    "pdmpricelist_id": null,
    "pdmweight": null,
    "pdmweightunit": null,
    "rows": null,
    "screxecute": null,
    "scrlibraryname": null,
    "scrmethodname": null,
    "scrpackagename": null,
    "solverrole_id": null,
    "solveruser_id": null,
    "useemailtemplate": null
}
Response
{
    "id": "1600000101"
}

DELETE

https://atd.abra.eu/demodata/crmcampaigntypes/{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": "crmcampaigntypes",
                "object_data": {
                    "activitycreate": null,
                    "activitydescription": null,
                    "activitypriority": null,
                    "activityprocess_id": null,
                    "activityproduct_id": null,
                    "activityqueue_id": null,
                    "activitystate": null,
                    "activitysubject": null,
                    "activitytype_id": null,
                    "attachments": null,
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "channel": null,
                    "division_id": null,
                    "emailaccount_id": null,
                    "emailattachment": null,
                    "emailbody": null,
                    "emailformat": null,
                    "emailsubject": null,
                    "hiddenemailaccount_id": null,
                    "massannouncement": null,
                    "name": null,
                    "pdmcashondelivery": null,
                    "pdmdescription": null,
                    "pdmdocqueue_id": null,
                    "pdminsuredvalue": null,
                    "pdmissuedcontent_id": null,
                    "pdmmultiplicator": null,
                    "pdmpostage": null,
                    "pdmpostageincash": null,
                    "pdmpostprovider_id": null,
                    "pdmpricelist_id": null,
                    "pdmweight": null,
                    "pdmweightunit": null,
                    "rows": null,
                    "screxecute": null,
                    "scrlibraryname": null,
                    "scrmethodname": null,
                    "scrpackagename": null,
                    "solverrole_id": null,
                    "solveruser_id": null,
                    "useemailtemplate": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "crmcampaigntypes",
                "object_data": {
                    "activitycreate": null,
                    "activitydescription": null,
                    "activitypriority": null,
                    "activityprocess_id": null,
                    "activityproduct_id": null,
                    "activityqueue_id": null,
                    "activitystate": null,
                    "activitysubject": null,
                    "activitytype_id": null,
                    "attachments": null,
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "channel": null,
                    "division_id": null,
                    "emailaccount_id": null,
                    "emailattachment": null,
                    "emailbody": null,
                    "emailformat": null,
                    "emailsubject": null,
                    "hiddenemailaccount_id": null,
                    "massannouncement": null,
                    "name": null,
                    "pdmcashondelivery": null,
                    "pdmdescription": null,
                    "pdmdocqueue_id": null,
                    "pdminsuredvalue": null,
                    "pdmissuedcontent_id": null,
                    "pdmmultiplicator": null,
                    "pdmpostage": null,
                    "pdmpostageincash": null,
                    "pdmpostprovider_id": null,
                    "pdmpricelist_id": null,
                    "pdmweight": null,
                    "pdmweightunit": null,
                    "rows": null,
                    "screxecute": null,
                    "scrlibraryname": null,
                    "scrmethodname": null,
                    "scrpackagename": null,
                    "solverrole_id": null,
                    "solveruser_id": null,
                    "useemailtemplate": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "crmcampaigntypes",
                "obj_id": "1600000100",
                "object_data": {
                    "activitycreate": null,
                    "activitydescription": null,
                    "activitypriority": null,
                    "activityprocess_id": null,
                    "activityproduct_id": null,
                    "activityqueue_id": null,
                    "activitystate": null,
                    "activitysubject": null,
                    "activitytype_id": null,
                    "attachments": null,
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "channel": null,
                    "division_id": null,
                    "emailaccount_id": null,
                    "emailattachment": null,
                    "emailbody": null,
                    "emailformat": null,
                    "emailsubject": null,
                    "hiddenemailaccount_id": null,
                    "massannouncement": null,
                    "name": null,
                    "pdmcashondelivery": null,
                    "pdmdescription": null,
                    "pdmdocqueue_id": null,
                    "pdminsuredvalue": null,
                    "pdmissuedcontent_id": null,
                    "pdmmultiplicator": null,
                    "pdmpostage": null,
                    "pdmpostageincash": null,
                    "pdmpostprovider_id": null,
                    "pdmpricelist_id": null,
                    "pdmweight": null,
                    "pdmweightunit": null,
                    "rows": null,
                    "screxecute": null,
                    "scrlibraryname": null,
                    "scrmethodname": null,
                    "scrpackagename": null,
                    "solverrole_id": null,
                    "solveruser_id": null,
                    "useemailtemplate": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "crmcampaigntypes",
                "obj_id": "1600000101",
                "object_data": {
                    "activitycreate": null,
                    "activitydescription": null,
                    "activitypriority": null,
                    "activityprocess_id": null,
                    "activityproduct_id": null,
                    "activityqueue_id": null,
                    "activitystate": null,
                    "activitysubject": null,
                    "activitytype_id": null,
                    "attachments": null,
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "channel": null,
                    "division_id": null,
                    "emailaccount_id": null,
                    "emailattachment": null,
                    "emailbody": null,
                    "emailformat": null,
                    "emailsubject": null,
                    "hiddenemailaccount_id": null,
                    "massannouncement": null,
                    "name": null,
                    "pdmcashondelivery": null,
                    "pdmdescription": null,
                    "pdmdocqueue_id": null,
                    "pdminsuredvalue": null,
                    "pdmissuedcontent_id": null,
                    "pdmmultiplicator": null,
                    "pdmpostage": null,
                    "pdmpostageincash": null,
                    "pdmpostprovider_id": null,
                    "pdmpricelist_id": null,
                    "pdmweight": null,
                    "pdmweightunit": null,
                    "rows": null,
                    "screxecute": null,
                    "scrlibraryname": null,
                    "scrmethodname": null,
                    "scrpackagename": null,
                    "solverrole_id": null,
                    "solveruser_id": null,
                    "useemailtemplate": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "crmcampaigntypes",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "crmcampaigntypes",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "crmcampaigntypes",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "crmcampaigntypes",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "crmcampaigntypes",
                "obj_id": "1600000104"
            }
        }
    ]
}