Zpracování kampaně

GET

/crmcampaignprocesses

Získá kolekci BO Zpracování kampaně

GET

/crmcampaignprocesses/{id}

Získá konkrétní BO Zpracování kampaně

POST

/crmcampaignprocesses

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

PUT

/crmcampaignprocesses/{id}

Provede aktualizaci BO Zpracování 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

/crmcampaignprocesses/{id}

Smaže BO Zpracování kampaně na základě jeho ID

Metadata - Perzistentní položky

Audience_ID string (crmcampaignaudience) relace

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

Campaign_ID string (crmcampaign) relace

Kampaň; ID objektu Kampaň, 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

Metadata - Neperzistentní položky

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

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

GET

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

GET

https://atd.abra.eu/demodata/crmcampaignprocesses/{id}
Response
{
    "Audience_ID": null,
    "Campaign_ID": null,
    "ID": null,
    "ObjVersion": null
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/crmcampaignprocesses/query
{"take": "1"}
Response
{
    "Audience_ID": null,
    "Campaign_ID": null,
    "ID": null,
    "ObjVersion": null
}
Request

POST

https://atd.abra.eu/demodata/crmcampaignprocesses?select=id
Body
{
    "Audience_ID": null,
    "Campaign_ID": null
}
Response
{
    "id": "1600000101"
}
Request

PUT

https://atd.abra.eu/demodata/crmcampaignprocesses/{id}?select=id
Body
{
    "Audience_ID": null,
    "Campaign_ID": null
}
Response
{
    "id": "1600000101"
}

DELETE

https://atd.abra.eu/demodata/crmcampaignprocesses/{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": "crmcampaignprocesses",
                "object_data": {
                    "Audience_ID": null,
                    "Campaign_ID": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "crmcampaignprocesses",
                "object_data": {
                    "Audience_ID": null,
                    "Campaign_ID": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "crmcampaignprocesses",
                "obj_id": "1600000100",
                "object_data": {
                    "Audience_ID": null,
                    "Campaign_ID": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "crmcampaignprocesses",
                "obj_id": "1600000101",
                "object_data": {
                    "Audience_ID": null,
                    "Campaign_ID": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "crmcampaignprocesses",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "crmcampaignprocesses",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "crmcampaignprocesses",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "crmcampaignprocesses",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "crmcampaignprocesses",
                "obj_id": "1600000104"
            }
        }
    ]
}