Adresát kampaně

GET
/crmcampaignaudiences

Získá kolekci BO Adresát kampaně

GET
/crmcampaignaudiences/meta/dataprotection

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

GET
/crmcampaignaudiences/views/{view}

Získá pohled nad BO Adresát kampaně

GET
/crmcampaignaudiences/{id}

Získá daný BO Adresát kampaně

GET
/crmcampaignaudiences/{id}/campaignvariableinstances

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

GET
/crmcampaignaudiences/{id}/campaignvariableinstances/{id1}

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

GET
/crmcampaignaudiences/{id}/iseditlock

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

GET
/crmcampaignaudiences/{id}/meta/dataprotection

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

GET
/crmcampaignaudiences/{id}/userparameters

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

POST
/crmcampaignaudiences

Vytvoří nový BO Adresát kampaně

POST
/crmcampaignaudiences/query

Vyhodnotí query dotaz nad BO Adresát kampaně

POST
/crmcampaignaudiences/{id}/campaignvariableinstances

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

PUT
/crmcampaignaudiences/{id}

Modifikuje daný BO Adresát kampaně

PUT
/crmcampaignaudiences/{id}/campaignvariableinstances/{id1}

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

PUT
/crmcampaignaudiences/{id}/editlock

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

PUT
/crmcampaignaudiences/{id}/editunlock

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

DELETE
/crmcampaignaudiences/{id}

Smaže BO Adresát kampaně

DELETE
/crmcampaignaudiences/{id}/campaignvariableinstances/{id1}

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

Metadata - Perzistentní položky

audiencestate integer

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

campaignfeedback_id string (crmcampaignfeedback) relace

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

campaignvariableinstances array (crmcampaignvariableinstance) relace

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

contacttime$date string

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

document_id string (datadocumentbusinessobject) relace

Založený doklad, pole vlastněné tabulkou, možné řadit a filtrovat

documenttype string (2)

Typ založeného dokladu, pole vlastněné tabulkou, možné řadit a filtrovat, fkAnsiCaseSensitive

email string (320)

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

firm_id string (firm) relace

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

firmoffice_id string (firmoffice) relace

Provozovna, 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

parent_id string (crmcampaign) relace

Vlastník, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je odkazem na vlastníka objektu, pole nepodporuje ochranu dat/GDPR

person_id string (person) relace

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

personspecification string (50)

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

targetaddresstype integer

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

Metadata - Neperzistentní položky

address_id string (address) relace

Adresa, pole je duplikováno při klonování objektu

classid string (26)

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

displayname string (100)

Název, pouze pro čtení

emailsentsendstatestr string (50)

Stav odeslané pošty

id string (10)

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

Příklady

GET
QUERY
PUT
DELETE
Builder

Request

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

GET
https://atd.abra.eu/demodata/crmcampaignaudiences/{id}

Response

{
    "audiencestate": null,
    "campaignfeedback_id": null,
    "campaignvariableinstances": null,
    "contacttime$date": null,
    "document_id": null,
    "documenttype": null,
    "email": null,
    "firm_id": null,
    "firmoffice_id": null,
    "objversion": null,
    "parent_id": null,
    "person_id": null,
    "personspecification": null,
    "targetaddresstype": null
}

Request POST

POST
https://atd.abra.eu/demodata/query

{"class": "P0WXCAK4AILOD4AYT2HT1WGI2K", "take": "1"}

Response

{
    "audiencestate": null,
    "campaignfeedback_id": null,
    "campaignvariableinstances": null,
    "contacttime$date": null,
    "document_id": null,
    "documenttype": null,
    "email": null,
    "firm_id": null,
    "firmoffice_id": null,
    "objversion": null,
    "parent_id": null,
    "person_id": null,
    "personspecification": null,
    "targetaddresstype": null
}

Request

PUT
https://atd.abra.eu/demodata/crmcampaignaudiences/{id}?select=id

Body

{
    "audiencestate": null,
    "campaignfeedback_id": null,
    "campaignvariableinstances": null,
    "contacttime$date": null,
    "document_id": null,
    "documenttype": null,
    "email": null,
    "firm_id": null,
    "firmoffice_id": null,
    "person_id": null,
    "personspecification": null,
    "targetaddresstype": null
}

Response

{
    "id": "1600000101"
}

DELETE
https://atd.abra.eu/demodata/crmcampaignaudiences/{id}

Response

200 - OK Everything worked as expected.