Kampaň

GET

/crmcampaigns

Získá kolekci BO Kampaň

GET

/crmcampaigns/{id}

Získá konkrétní BO Kampaň

POST

/crmcampaigns

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

POST

/crmcampaigns/import/crmcampaigns/{id}

Vytvoří nový BO Kampaň importem BO Kampaň. Pokud nejsou specifikovány parametry importního manažeru, dojde automaticky k importu všech nevyčerpaných řádků.

PUT

/crmcampaigns/{id}

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

PUT

/crmcampaigns/{crmcampaign_id}/crmcampaigns/{crmcampaign_id}

Vytvoří nový BO Kampaň importem BO Kampaň. Pokud nejsou specifikovány parametry importního manažeru, dojde automaticky k importu všech nevyčerpaných řádků.

DELETE

/crmcampaigns/{id}

Smaže BO Kampaň na základě jeho ID

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; 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

Obch. 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

CampaignCheckState integer

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

CampaignErrors string (0)

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ě; ID objektu 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; ID objektu Uživatel, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

CreatedBy_ID string (securityuser) relace

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

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

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; ID objektu Řada dokladů, 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í; ID objektu 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

Adresáti kampaní; 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,
    "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,
    "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"
            }
        }
    ]
}