Erstellen von Kampagnen mithilfe der API

Sie können eine Kampagne erstellen, indem Sie den Namen des Datenmodells und die Kampagnenkonfiguration angeben. Den Namen der Kampagne können Sie einfügen. Er muss folgendem Muster entsprechen: ^[a-z][a-z\d\-]*$.

Die Antwort enthält das Feld id, das sich für die spätere Bearbeitung der Kampagne als hilfreich erweisen kann.

In diesem Beispiel wird Talend API Tester zum Senden von Requests verwendet.

Weitere Informationen zu Talend API Tester finden Sie im Nutzungshandbuch für Talend Cloud API Tester.

Vorbereitungen

Sie führen das Lesen von Datenmodellen mithilfe der API über den Vorgang GET https://tds.{region}.cloud.talend.com/schemaservice/api/v1/schemas/org.talend.schema/{dataModelName} durch.

Prozedur

Sofern Sie noch nicht über ein persönliches Zugriffstoken verfügen, erzeugen Sie eines. Weitere Informationen finden Sie unter „Generieren persönlicher Zugriffstoken“.
Öffnen Sie Talend API Tester in Ihrem Browser.
Wählen Sie auf der Registerkarte Repository die Methode Post in der Dropdown-Liste Method (Methode) aus.
Geben Sie folgende URL ein: https://tds.{region}.cloud.talend.com/data-stewardship/api/v1/campaigns/owned
Eine Liste der für die verschiedenen Rechenzentren zu verwendenden URLs finden Sie unter Zugriff auf Talend Cloud-Anwendungen.
Klicken Sie auf die Schaltfläche Add header (Header hinzufügen) und geben Sie Authorization (Autorisierung) in das Feld name (Name) und Bearer, gefolgt von einem Leerzeichen und Ihrem Token in das Feld value (Wert) ein.
Klicken Sie auf die Schaltfläche Add header (Header hinzufügen), geben Sie Cookie in das Feld name (Name) ein und lassen Sie das Feld value (Wert) leer.

Nehmen Sie in das Feld Body die Kampagnendetails in JSON auf.

Example

Um dieselbe Kampagne Demo - Improve product catalog data quality (Demo - Datenqualität des Produktkatalogs verbessern) wie in der Führung zu erstellen, verwenden Sie einen anderen Namen, beispielsweise my-campaign-resolution-created-via-api (Mein per API erstellte Kampagnenauflösung) und my_products_created_via_API (Meine per API erstellten Produkte). Geben Sie dazu Folgendes ein:

{
    "campaign": {
        "name": "my-campaign-resolution-created-via-api",
        "label": "Improve product catalog data quality (created via API)",
        "description": "Increase the level of data quality for each product catalog.",
        "owners": ["owner@account.com"],
        "taskType": "RESOLUTION",
        "schemaRef": {
            "namespace": "org.talend.schema",
            "name": "my_products_created_via_API",
            "version": 1,
            "displayName": "Product (created via API)"
        },
        "taskResolutionDelay": {
            "value": 10,
            "unit": "DAYS"
        },
        "workflow": {
            "name": "default workflow",
            "states": [{
                "name": "New",
                "label": "New",
                "transitions": [{
                    "name": "To validate",
                    "label": "To validate",
                    "targetStateName": "To validate",
                    "allowedRoles": ["Supervisor"]
                }],
                "allowedRoles": [],
                "translations": {}
            }, {
                "name": "To validate",
                "label": "To validate",
                "transitions": [{
                    "name": "Accept",
                    "label": "Accept",
                    "targetStateName": "Resolved",
                    "allowedRoles": ["Validator"]
                }, {
                    "name": "Reject",
                    "label": "Reject",
                    "targetStateName": "New",
                    "allowedRoles": ["Validator"]
                }],
                "allowedRoles": [],
                "translations": {}
            }, {
                "name": "Resolved",
                "label": "Resolved",
                "transitions": [],
                "allowedRoles": ["Validator"],
                "translations": {}
            }]
        }
    },
    "participants": {
        "Supervisor": ["steward1@account.com"],
        "Validator": ["steward1@account.com"]
    }
}

Der Wert "owners" (Verantwortliche) muss die Benutzernamen der Kampagnenverantwortlichen enthalten.

Das Objekt "schemaRef": (Schemaref.) muss die Werte "namespace", "name", "version" und "displayName" (Anzeigename) für das gewünschte Datenmodell enthalten. Informationen zum Abrufen dieser Informationen finden Sie unter Lesen von Datenmodellen mithilfe der API.

Die Werte "Supervisor" und "Validator" (Validierer) müssen die Benutzernamen der Data Stewards enthalten, die diese Rollen übernehmen sollen.

Klicken Sie auf Send (Senden).

Ergebnisse

Die API gibt den HTTP-Code 200 zurück, um Sie darüber zu informieren, dass der Request erfolgreich war. Die Antwort enthält eine aktualisierte JSON-Beschreibung der Datenmodellattribute.

{
    "id": "5f4694d651bfb7000154b5b2",
    "createdBy": "owner",
    "lastUpdatedBy": "owner@account.com",
    "creationDate": 1601831320,
    "lastUpdateDate": 1601831320,
    "name": "my-campaign-resolution-created-via-api",
    "label": "Improve product catalog data quality (created via API)",
    "description": "Increase the level of data quality for each product catalog.",
    "owners": [
        "owner@account.com"
    ],
    "ownersDetail": [
        {
            "firstName": "FIRSTNAME",
            "lastName": "LASTNAME",
            "username": "owner@account.com",
            "enabled": true,
            "preferredLanguage": "en",
            "email": "owner@account.com",
            "id": "6be3b335-05c9-4a3b-92d6-c5821f398bac"
        }
    ],
    "status": "STARTED",
    "startDate": 1598461142854,
    "endDate": null,
    "taskType": "RESOLUTION",
    "schemaRef": {
        "namespace": "org.talend.schema",
        "name": "demo_product",
        "version": 1,
        "displayName": "Demo - Product"
    },
    "impactAnalysisStatus": null,
    "fieldsAccess": null,
    "taskResolutionDelay": {
        "value": 10,
        "unit": "DAYS"
    },
    "workflow": {
        "id": null,
        "createdBy": "6be3b335-05c9-4a3b-92d6-c5821f398bac",
        "lastUpdatedBy": "6be3b335-05c9-4a3b-92d6-c5821f398bac",
        "creationDate": 1598461142855,
        "lastUpdateDate": 1598461142855,
        "tenantId": null,
        "name": "default workflow",
        "states": [
            {
                "name": "New",
                "label": "New",
                "transitionQuestion": null,
                "transitions": [
                    {
                        "name": "To validate",
                        "label": "To validate",
                        "targetStateName": "To validate",
                        "allowedRoles": [
                            "Supervisor"
                        ]
                    }
                ],
                "allowedRoles": [],
                "translations": {}
            },
            {
                "name": "To validate",
                "label": "To validate",
                "transitionQuestion": null,
                "transitions": [
                    {
                        "name": "Accept",
                        "label": "Accept",
                        "targetStateName": "Resolved",
                        "allowedRoles": [
                            "Validator"
                        ]
                    },
                    {
                        "name": "Reject",
                        "label": "Reject",
                        "targetStateName": "New",
                        "allowedRoles": [
                            "Validator"
                        ]
                    }
                ],
                "allowedRoles": [],
                "translations": {}
            },
            {
                "name": "Resolved",
                "label": "Resolved",
                "transitionQuestion": null,
                "transitions": [],
                "allowedRoles": [
                    "Validator"
                ],
                "translations": {}
            }
        ]
    }
}

Wenn Sie die Kampagne bearbeiten möchten, notieren Sie sich den Wert id in der Antwort.

Hat diese Seite Ihnen geholfen?

Wenn Sie ein Problem mit dieser Seite oder ihrem Inhalt feststellen, sei es ein Tippfehler, ein ausgelassener Schritt oder ein technischer Fehler, informieren Sie uns bitte!

Geben Sie hier Ihr Feedback ab