Kampaň

GET

/crmcampaigns

Získá kolekci BO Kampaň

GET

/crmcampaigns/meta/dataprotection

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

GET

/crmcampaigns/views/{view}

Získá pohled nad BO Kampaň

GET

/crmcampaigns/{id}

Získá daný BO Kampaň

GET

/crmcampaigns/{id}/iseditlock

Otestuje, zda existuje editační zámek na daném BO Kampaň

GET

/crmcampaigns/{id}/meta/dataprotection

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

GET

/crmcampaigns/{id}/rows

Získá řádky kolekce Adresát kampaně

GET

/crmcampaigns/{id}/rows/{id1}

Získá daný řádek kolekce Adresát kampaně

GET

/crmcampaigns/{id}/rows/{id1}/campaignvariableinstances

Získá řádky kolekce Hodnota proměnné kampaně

GET

/crmcampaigns/{id}/rows/{id1}/campaignvariableinstances/{id2}

Získá daný řádek kolekce Hodnota proměnné kampaně

GET

/crmcampaigns/{id}/userparameters

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

POST

/crmcampaigns

Vytvoří nový BO Kampaň

POST

/crmcampaigns/query

Vyhodnotí query dotaz nad BO Kampaň

POST

/crmcampaigns/{id}/rows

Vytvoří nový řádek v kolekci Adresát kampaně

POST

/crmcampaigns/{id}/rows/{id1}/campaignvariableinstances

Vytvoří nový řádek v kolekci Hodnota proměnné kampaně

POST

/crmcampaigns/import/crmcampaigns

ZASTARALÉ! Provede import v těle specifikovaných zdrojových dokladů do nového cílového dokladu

POST

/crmcampaigns/import/crmcampaigns/{source_doc_id}

ZASTARALÉ! Provede import v url specifikovaného zdrojového dokladu do nového cílového dokladu

PUT

/crmcampaigns/{id}

Modifikuje daný BO Kampaň

PUT

/crmcampaigns/{id}/editlock

Vytvoří editační zámek na daném BO Kampaň

PUT

/crmcampaigns/{id}/editunlock

Zruší editační zámek na daném BO Kampaň

PUT

/crmcampaigns/{id}/rows/{id1}

Modifikuje řádek v kolekci Adresát kampaně

PUT

/crmcampaigns/{id}/rows/{id1}/campaignvariableinstances/{id2}

Modifikuje řádek v kolekci Hodnota proměnné kampaně

PUT

/crmcampaigns/{dest_doc_id}/import/crmcampaigns

ZASTARALÉ! Provede import v těle specifikovaných zdrojových dokladů do již existujícího cílového dokladu

PUT

/crmcampaigns/{dest_doc_id}/import/crmcampaigns/{source_doc_id}

ZASTARALÉ! Provede import v url specifikovaného zdrojového dokladu do již existujícího cílového dokladu

DELETE

/crmcampaigns/{id}

Smaže BO Kampaň

DELETE

/crmcampaigns/{id}/rows/{id1}

Smaže řádek z kolekce Adresát kampaně

DELETE

/crmcampaigns/{id}/rows/{id1}/campaignvariableinstances/{id2}

Smaže řádek z kolekce Hodnota proměnné kampaně

Metadata - Perzistentní položky

budget number

Rozpočet, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole obsahuje částku v lokální mě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

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

campaigncheckstate integer

Stav kontroly, pole vlastněné tabulkou, možné řadit a filtrovat

campaignerrors string

Chyby, pole vlastněné tabulkou, možné řadit a filtrovat

campaignname string (70)

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

campaignstate integer

Stav, pole vlastněné tabulkou, možné řadit a filtrovat

campaigntype_id string (crmcampaigntype) relace

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

correctedby_id string (securityuser) relace

Opravil, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

createdby_id string (securityuser) relace

Vytvořil, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

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

docdate$date string

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

docqueue_id string (docqueue) relace

Zdrojová řada, 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

ordnumber integer

Pořadové číslo, pole vlastněné tabulkou, možné řadit a filtrovat

period_id string (period) relace

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

realenddate$date string

Skutečný čas dokončení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

realexpenses number

Skutečné výdaje, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole obsahuje částku v lokální měně

realstartdate$date string

Skutečný čas zahájení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

rows array (crmcampaignaudience) relace

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

scheduledenddate$date string

Plánovaný čas dokončení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

scheduledstartdate$date string

Plánovaný čas zahájení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

Metadata - Neperzistentní položky

campaigncheckstatetext string (15)

Stav kontroly

classid string (26)

ID třídy, pouze pro čtení, fkAnsiCaseSensitive, pole nepodporuje ochranu dat/GDPR

displayname string (24)

Číslo dok., pouze pro čtení

id string (10)

Vlastní ID, pouze pro čtení, fkAnsiCaseSensitive, pole nepodporuje ochranu dat/GDPR

newrelateddocument_id string (10)

ID dokladu pro připojení, fkAnsiCaseSensitive

newrelatedtype integer

Typ relace

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

GET

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

GET

https://atd.abra.eu/demodata/crmcampaigns/{id}
Response
{
    "budget": null,
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "campaigncheckstate": null,
    "campaignerrors": null,
    "campaignname": null,
    "campaignstate": null,
    "campaigntype_id": null,
    "correctedby_id": null,
    "createdby_id": null,
    "division_id": null,
    "docdate$date": null,
    "docqueue_id": null,
    "objversion": null,
    "ordnumber": null,
    "period_id": null,
    "realenddate$date": null,
    "realexpenses": null,
    "realstartdate$date": null,
    "rows": null,
    "scheduledenddate$date": null,
    "scheduledstartdate$date": null
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/crmcampaigns/query
{"take": "1"}
Response
{
    "budget": null,
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "campaigncheckstate": null,
    "campaignerrors": null,
    "campaignname": null,
    "campaignstate": null,
    "campaigntype_id": null,
    "correctedby_id": null,
    "createdby_id": null,
    "division_id": null,
    "docdate$date": null,
    "docqueue_id": null,
    "objversion": null,
    "ordnumber": null,
    "period_id": null,
    "realenddate$date": null,
    "realexpenses": null,
    "realstartdate$date": null,
    "rows": null,
    "scheduledenddate$date": null,
    "scheduledstartdate$date": null
}
Request

POST

https://atd.abra.eu/demodata/crmcampaigns?select=id
Body
{
    "budget": null,
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "campaigncheckstate": null,
    "campaignerrors": null,
    "campaignname": null,
    "campaignstate": null,
    "campaigntype_id": null,
    "correctedby_id": null,
    "createdby_id": null,
    "division_id": null,
    "docdate$date": null,
    "docqueue_id": null,
    "ordnumber": null,
    "period_id": null,
    "realenddate$date": null,
    "realexpenses": null,
    "realstartdate$date": null,
    "rows": null,
    "scheduledenddate$date": null,
    "scheduledstartdate$date": null
}
Response
{
    "id": "1600000101"
}
Request

PUT

https://atd.abra.eu/demodata/crmcampaigns/{id}?select=id
Body
{
    "budget": null,
    "busorder_id": null,
    "busproject_id": null,
    "bustransaction_id": null,
    "campaigncheckstate": null,
    "campaignerrors": null,
    "campaignname": null,
    "campaignstate": null,
    "campaigntype_id": null,
    "correctedby_id": null,
    "createdby_id": null,
    "division_id": null,
    "docdate$date": null,
    "docqueue_id": null,
    "ordnumber": null,
    "period_id": null,
    "realenddate$date": null,
    "realexpenses": null,
    "realstartdate$date": null,
    "rows": null,
    "scheduledenddate$date": null,
    "scheduledstartdate$date": null
}
Response
{
    "id": "1600000101"
}

DELETE

https://atd.abra.eu/demodata/crmcampaigns/{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": "crmcampaigns",
                "object_data": {
                    "budget": null,
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "campaigncheckstate": null,
                    "campaignerrors": null,
                    "campaignname": null,
                    "campaignstate": null,
                    "campaigntype_id": null,
                    "correctedby_id": null,
                    "createdby_id": null,
                    "division_id": null,
                    "docdate$date": null,
                    "docqueue_id": null,
                    "ordnumber": null,
                    "period_id": null,
                    "realenddate$date": null,
                    "realexpenses": null,
                    "realstartdate$date": null,
                    "rows": null,
                    "scheduledenddate$date": null,
                    "scheduledstartdate$date": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "crmcampaigns",
                "object_data": {
                    "budget": null,
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "campaigncheckstate": null,
                    "campaignerrors": null,
                    "campaignname": null,
                    "campaignstate": null,
                    "campaigntype_id": null,
                    "correctedby_id": null,
                    "createdby_id": null,
                    "division_id": null,
                    "docdate$date": null,
                    "docqueue_id": null,
                    "ordnumber": null,
                    "period_id": null,
                    "realenddate$date": null,
                    "realexpenses": null,
                    "realstartdate$date": null,
                    "rows": null,
                    "scheduledenddate$date": null,
                    "scheduledstartdate$date": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "crmcampaigns",
                "obj_id": "1600000100",
                "object_data": {
                    "budget": null,
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "campaigncheckstate": null,
                    "campaignerrors": null,
                    "campaignname": null,
                    "campaignstate": null,
                    "campaigntype_id": null,
                    "correctedby_id": null,
                    "createdby_id": null,
                    "division_id": null,
                    "docdate$date": null,
                    "docqueue_id": null,
                    "ordnumber": null,
                    "period_id": null,
                    "realenddate$date": null,
                    "realexpenses": null,
                    "realstartdate$date": null,
                    "rows": null,
                    "scheduledenddate$date": null,
                    "scheduledstartdate$date": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "crmcampaigns",
                "obj_id": "1600000101",
                "object_data": {
                    "budget": null,
                    "busorder_id": null,
                    "busproject_id": null,
                    "bustransaction_id": null,
                    "campaigncheckstate": null,
                    "campaignerrors": null,
                    "campaignname": null,
                    "campaignstate": null,
                    "campaigntype_id": null,
                    "correctedby_id": null,
                    "createdby_id": null,
                    "division_id": null,
                    "docdate$date": null,
                    "docqueue_id": null,
                    "ordnumber": null,
                    "period_id": null,
                    "realenddate$date": null,
                    "realexpenses": null,
                    "realstartdate$date": null,
                    "rows": null,
                    "scheduledenddate$date": null,
                    "scheduledstartdate$date": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "crmcampaigns",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "crmcampaigns",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "crmcampaigns",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "crmcampaigns",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "crmcampaigns",
                "obj_id": "1600000104"
            }
        }
    ]
}