Tags
Tags sind benutzerdefinierte Felder für Programme. Jedes Tag kann sich auf einen oder mehrere Programmtypen beziehen und kann entweder erforderlich oder optional sein, je nachdem, wie das Tag definiert wurde. Tags können auch eine Liste zulässiger Werte bereitstellen, aus denen Sie zur Verwendung auswählen müssen.
Abfrage
Tags werden mit dem Standard-Asset-Muster abgefragt, haben jedoch keinen Endpunkt für nach ID. Die Liste der zulässigen Werte für ein Tag wird nur zurückgegeben, wenn das Tag anhand des Namens abgefragt wird.
Tags abrufen
GET /rest/asset/v1/tagTypes.json
{
"success": true,
"warnings": [],
"errors": [],
"requestId": "1488a#1504ecfccf8",
"result": [
{
"tagType": "AAA1 Required Tag Type",
"applicableProgramTypes": "[program,email_batch,nurture,event,webinar]",
"required": true
},
{
"tagType": "AAA2 Required Event Tag Type",
"applicableProgramTypes": "[event]",
"required": true
},
{
"tagType": "AAA3 Not Required Tag Type",
"applicableProgramTypes": "[program,email_batch,nurture,event,webinar]",
"required": false
}
]
}
Nach Name
GET /rest/asset/v1/tagType/byName.json?name=AAA1 Required Tag Type
{
"success": true,
"warnings": [],
"errors": [],
"requestId": "8a44#1504ed0da2f",
"result": [
{
"tagType": "AAA1 Required Tag Type",
"applicableProgramTypes": "[program,email_batch,nurture,event,webinar]",
"required": true,
"allowableValues": "[AAA1 RT1, AAA1 RT2, AAA1 RT3, AAA1 RT4]"
}
]
}
Update
Der Endpunkt Programm-Tag ermöglicht es Ihnen, den Wert für einen bestimmten Tag-Typ zu aktualisieren. Der Endpunkt akzeptiert einen id und tagType Pfadparameter, die die Programm-ID und den zu aktualisierenden Tag-Typ angeben. Ein tagValue Abfrageparameter wird verwendet, um den neuen Wert für den Tag-Typ anzugeben. Alle Parameter sind erforderlich.
POST /rest/asset/v1/program/{id}/tag/{tagType}.json?tagValue=David
{
"success": true,
"errors": [],
"requestId": "fd84#17f84a885a6",
"warnings": [],
"result": [
{
"id": 1067
}
]
}
Tags können massenweise mit dem Endpunkt Programmmetadaten aktualisieren aktualisiert werden. Ein Beispiel finden Sie im Abschnitt Programmaktualisierung.
Löschen
Mit Endpunkt Programm-Tag löschen“ können Sie einen nicht erforderlichen Tag-Typ löschen. Der Endpunkt akzeptiert id und tagType Pfadparameter, die die Programm-ID und den zu löschenden Tag-Typ angeben.
POST /rest/asset/v1/program/{id}/tag/{tagType}/delete.json
{
"success": true,
"errors": [],
"requestId": "d998#17f84ad36a7",
"warnings": [],
"result": [
{
"id": 1067
}
]
}