Typ kampaně

GET

/crmcampaigntypes

Získá kolekci BO Typ kampaně

GET

/crmcampaigntypes/{id}

Získá konkrétní BO Typ kampaně

POST

/crmcampaigntypes

Vytvoří nový BO Typ kampaně a vrátí jeho kompletní reprezentaci

PUT

/crmcampaigntypes/{id}

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

DELETE

/crmcampaigntypes/{id}

Smaže BO Typ kampaně na základě jeho ID

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 (0)

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

ActivityProduct_ID string (crmproduct) relace

Produkt; ID objektu 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; ID objektu Řada aktivit, 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 (0)

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

Attachments array (emailsentattachment) relace

Přílohy; 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; 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

Obchodní 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

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

EmailAttachment string (0)

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

EmailBody string (0)

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 (0)

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; ID objektu 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 (0)

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; ID objektu Řada dokladů, 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; ID objektu Typy obsahů odeslané 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

PDMPostProvider_ID string (pdmpostprovider) relace

Poštovní poskytovatel; ID objektu Poskytovatel poštovních služeb, 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

PDMPriceList_ID string (pdmpricelist) relace

Ceník pošty; ID objektu 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

Řádky; 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; ID objektu Role, 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; ID objektu Uživatel, 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,
    "ID": null,
    "MassAnnouncement": null,
    "Name": null,
    "ObjVersion": null,
    "PDMCashOnDelivery": null,
    "PDMDescription": null,
    "PDMDocQueue_ID": null,
    "PDMInsuredValue": null,
    "PDMIssuedContent_ID": null,
    "PDMMultiplicator": null,
    "PDMPostProvider_ID": null,
    "PDMPostage": null,
    "PDMPostageInCash": 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,
    "ID": null,
    "MassAnnouncement": null,
    "Name": null,
    "ObjVersion": null,
    "PDMCashOnDelivery": null,
    "PDMDescription": null,
    "PDMDocQueue_ID": null,
    "PDMInsuredValue": null,
    "PDMIssuedContent_ID": null,
    "PDMMultiplicator": null,
    "PDMPostProvider_ID": null,
    "PDMPostage": null,
    "PDMPostageInCash": 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,
    "PDMPostProvider_ID": null,
    "PDMPostage": null,
    "PDMPostageInCash": 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,
    "PDMPostProvider_ID": null,
    "PDMPostage": null,
    "PDMPostageInCash": 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,
                    "PDMPostProvider_ID": null,
                    "PDMPostage": null,
                    "PDMPostageInCash": 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,
                    "PDMPostProvider_ID": null,
                    "PDMPostage": null,
                    "PDMPostageInCash": 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,
                    "PDMPostProvider_ID": null,
                    "PDMPostage": null,
                    "PDMPostageInCash": 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,
                    "PDMPostProvider_ID": null,
                    "PDMPostage": null,
                    "PDMPostageInCash": 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"
            }
        }
    ]
}