Endpunkt des Zeitplans

Zeitpläne sind ein Tool, mit dem Stapelsegmentierungsaufträge einmal täglich automatisch ausgeführt werden können. Mit dem Endpunkt /config/schedules können Sie eine Liste von Zeitplänen abrufen, einen neuen Zeitplan erstellen, Details zu einem bestimmten Zeitplan abrufen, einen bestimmten Zeitplan aktualisieren oder einen bestimmten Zeitplan löschen.

Erste Schritte

Die in diesem Handbuch verwendeten Endpunkte sind Teil der API Adobe Experience Platform Segmentation Service. Bevor Sie fortfahren, lesen Sie bitte im Handbuch Erste Schritte nach wichtigen Informationen, die Sie kennen müssen, um die API erfolgreich aufzurufen, einschließlich erforderlicher Kopfzeilen und Anleitungen zum Lesen von Beispiel-API-Aufrufen.

Abrufen einer Liste von Zeitplänen

Sie können eine Liste aller Zeitpläne Ihrer IMS-Organisation abrufen, indem Sie eine GET-Anfrage an den Endpunkt /config/schedules stellen.

API-Format

Der /config/schedules-Endpunkt unterstützt mehrere Abfragen-Parameter, um die Ergebnisse zu filtern. Diese Parameter sind optional, ihre Verwendung wird jedoch dringend empfohlen, um den kostspieligen Aufwand zu reduzieren. Beim Aufruf dieses Endpunkts ohne Angabe von Parametern werden alle für Ihr Unternehmen verfügbaren Zeitpläne abgerufen. Es können mehrere Parameter eingeschlossen werden, die durch kaufmännische Und-Zeichen (&) voneinander getrennt werden.

GET /config/schedules
GET /config/schedules?start={START}
GET /config/schedules?limit={LIMIT}

Parameter	Beschreibung
`{START}`	Gibt an, von welcher Seite der Offset beginnt. Der Standardwert ist 0.
`{LIMIT}`	Gibt die Anzahl der Zeitpläne an, die zurückgegeben werden. Der Standardwert ist 100.

Anfrage

Die folgende Anfrage wird die letzten zehn Zeitpläne abrufen, die in Ihrer IMS-Organisation veröffentlicht wurden.

curl -X GET https://platform.adobe.io/data/core/ups/config/schedules?limit=10 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort

Bei erfolgreicher Antwort wird der HTTP-Status-Code 200 mit einer Liste der für die angegebene IMS-Organisation abgerufenen Zeitpläne als JSON zurückgegeben.

HINWEIS

Die folgende Antwort wurde für Leerzeichen abgeschnitten und zeigt nur den ersten zurückgegebenen Zeitplan an.

{
    "_page": {
        "totalCount": 10,
        "pageSize": 1
    },
    "children": [
        {
            "id": "4e538382-dbd8-449e-988a-4ac639ebe72b",
            "imsOrgId": "{IMS_ORG}",
            "sandbox": {
                "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "name": "Batch Segmentation",
            "state": "active",
            "type": "batch_segmentation",
            "schedule": "0 0 1 * * ?",
            "properties": {
                "segments": []
            },
            "createEpoch": 1573158851,
            "updateEpoch": 1574365202
        }
    ],
    "_links": {
        "next": {}
    }
}

Eigenschaft	Beschreibung
`_page.totalCount`	Die Gesamtzahl der zurückgegebenen Zeitpläne.
`_page.pageSize`	Die Größe der Seite der Zeitpläne.
`children.name`	Der Name des Zeitplans als Zeichenfolge.
`children.type`	Der Auftragstyp als Zeichenfolge. Die beiden unterstützten Typen sind "batch_segmentation"und "export".
`children.properties`	Ein Objekt, das zusätzliche dem Zeitplan zugehörige Eigenschaften enthält.
`children.properties.segments`	Mit `["*"]` wird sichergestellt, dass alle Segmente einbezogen werden.
`children.schedule`	Eine Zeichenfolge, die den Zeitplan für den Auftrag enthält. Aufträge können nur einmal pro Tag ausgeführt werden, d. h., Sie können nicht planen, dass ein Auftrag während eines Zeitraums von 24 Stunden mehrmals ausgeführt wird. Weitere Informationen zu Cron-Zeitplänen finden Sie in der Dokumentation zum Format von Cron-Ausdrücken. Die in diesem Bespiel verwendete Eingabe „0 0 1 * *“ legt fest, dass dieser Zeitplan am ersten jedes Monats um 0:00 Uhr ausgeführt wird.
`children.state`	Eine Zeichenfolge, die den Status des Zeitplans enthält. Die beiden unterstützten Status sind "aktiv"und "inaktiv". Standardmäßig ist der Status auf "inaktiv"festgelegt.

Erstellen neuer Zeitpläne

Sie können einen neuen Zeitplan erstellen, indem Sie eine POST-Anfrage an den Endpunkt /config/schedules senden.

API-Format

POST /config/schedules

Anfrage

curl -X POST https://platform.adobe.io/data/core/ups/config/schedules \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '
{
    "name":"profile-default",
    "type":"batch_segmentation",
    "properties":{
        "segments":[
            "*"
        ]
    },
    "schedule":"0 0 1 * * ?",
    "state":"inactive"
}'

Eigenschaft	Beschreibung
`name`	Erforderlich. Der Name des Zeitplans als Zeichenfolge.
`type`	Erforderlich. Der Auftragstyp als Zeichenfolge. Die beiden unterstützten Typen sind "batch_segmentation"und "export".
`properties`	Erforderlich. Ein Objekt, das zusätzliche dem Zeitplan zugehörige Eigenschaften enthält.
`properties.segments`	Erforderlich, wenn `type` gleich “batch_segmentation”. Mit `["*"]` wird sichergestellt, dass alle Segmente einbezogen werden.
`schedule`	Optional. Eine Zeichenfolge, die den Zeitplan für den Auftrag enthält. Aufträge können nur einmal pro Tag ausgeführt werden, d. h., Sie können nicht planen, dass ein Auftrag während eines Zeitraums von 24 Stunden mehrmals ausgeführt wird. Weitere Informationen zu Cron-Zeitplänen finden Sie in der Dokumentation zum Format von Cron-Ausdrücken. Die in diesem Bespiel verwendete Eingabe „0 0 1 * *“ legt fest, dass dieser Zeitplan am ersten jedes Monats um 0:00 Uhr ausgeführt wird. Wenn diese Zeichenfolge nicht angegeben wird, wird automatisch ein systemgenerierter Zeitplan generiert.
`state`	Optional. Eine Zeichenfolge, die den Status des Zeitplans enthält. Die beiden unterstützten Status sind "aktiv"und "inaktiv". Standardmäßig ist der Status auf "inaktiv"festgelegt.

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status-Code 200 mit Details zum von Ihnen neu erstellten Zeitplan zurück.

{
    "id": "4e538382-dbd8-449e-988a-4ac639ebe72b",
    "imsOrgId": "{IMS_ORG}",
    "sandbox": {
        "sandboxId": "e7e17720-c5bb-11e9-aafb-87c71c35cac8",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "name": "{SCHEDULE_NAME}",
    "state": "inactive",
    "type": "batch_segmentation",
    "schedule": "0 0 1 * * ?",
    "properties": {
        "segments": [
            "*"
        ]
    },
    "createEpoch": 1568267948,
    "updateEpoch": 1568267948
}

Abrufen einzelner Zeitpläne

Sie können detaillierte Informationen zu einem bestimmten Zeitplan abrufen, indem Sie eine GET an den Endpunkt /config/schedules anfordern und die ID des Zeitplans angeben, den Sie im Anforderungspfad abrufen möchten.

API-Format

GET /config/schedules/{SCHEDULE_ID}

Parameter	Beschreibung
`{SCHEDULE_ID}`	Der `id`-Wert des Zeitplans, den Sie abrufen möchten.

Anfrage

curl -X GET https://platform.adobe.io/data/core/ups/config/schedules/4e538382-dbd8-449e-988a-4ac639ebe72b
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status-Code 200 mit Details zum angegebenen Zeitplan zurück.

{
    "id": "4e538382-dbd8-449e-988a-4ac639ebe72b",
    "imsOrgId": "{IMS_ORG}",
    "sandbox": {
        "sandboxId": "e7e17720-c5bb-11e9-aafb-87c71c35cac8",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "name": "{SCHEDULE_NAME}",
    "state": "inactive",
    "type": "batch_segmentation",
    "schedule": "0 0 1 * * ?",
    "properties": {
        "segments": [
            "*"
        ]
    },
    "createEpoch": 1568267948,
    "updateEpoch": 1568267948
}

Eigenschaft	Beschreibung
`name`	Der Name des Zeitplans als Zeichenfolge.
`type`	Der Auftragstyp als Zeichenfolge. Unterstützt werden die Typen `batch_segmentation` und `export`.
`properties`	Ein Objekt, das zusätzliche dem Zeitplan zugehörige Eigenschaften enthält.
`properties.segments`	Mit `["*"]` wird sichergestellt, dass alle Segmente einbezogen werden.
`schedule`	Eine Zeichenfolge, die den Zeitplan für den Auftrag enthält. Aufträge können nur einmal pro Tag ausgeführt werden, d. h., Sie können einen Auftrag nicht so planen, dass er während eines Zeitraums von 24 Stunden mehr als einmal ausgeführt wird. Weitere Informationen zu Cron-Zeitplänen finden Sie in der Dokumentation zum Format von Cron-Ausdrücken. Die in diesem Bespiel verwendete Eingabe „0 0 1 * *“ legt fest, dass dieser Zeitplan am ersten jedes Monats um 0:00 Uhr ausgeführt wird.
`state`	Eine Zeichenfolge, die den Status des Zeitplans enthält. Unterstützt werden die Status `active` und `inactive`. Standardmäßig lautet der Status `inactive`.

Details für einen bestimmten Zeitplan aktualisieren

Sie können einen bestimmten Zeitplan aktualisieren, indem Sie eine PATCH an den /config/schedules-Endpunkt anfordern und die ID des Zeitplans angeben, den Sie im Anforderungspfad aktualisieren möchten.

Mit der PATCH-Anforderung können Sie entweder den state oder den cron schedule für einen bestimmten Zeitplan aktualisieren.

Aktualisieren des Status eines Zeitplans

Sie können einen JSON-Patch-Vorgang verwenden, um den Status des Zeitplans zu aktualisieren. Um den Status zu aktualisieren, deklarieren Sie die path-Eigenschaft als /state und setzen value auf active oder inactive. Weitere Informationen zum JSON Patch finden Sie in der Dokumentation zum JSON Patch.

API-Format

PATCH /config/schedules/{SCHEDULE_ID}

Parameter	Beschreibung
`{SCHEDULE_ID}`	Der `id`-Wert des Zeitplans, den Sie aktualisieren möchten.

Anfrage

curl -X DELETE https://platform.adobe.io/data/core/ups/config/schedules/4e538382-dbd8-449e-988a-4ac639ebe72b \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '
[
    {
        "op": "add",
        "path": "/state",
        "value": "active"
    }
]'

Eigenschaft	Beschreibung
`path`	Der Pfad des Werts, den Sie ändern möchten. In diesem Fall müssen Sie, da Sie den Status des Zeitplans aktualisieren, den Wert von `path` auf "/state"setzen.
`value`	Der aktualisierte Wert des Zeitplanstatus. Dieser Wert kann entweder als "aktiv"oder als "inaktiv"eingestellt werden, um den Zeitplan zu aktivieren oder zu deaktivieren.

Antwort

Bei erfolgreicher Antwort wird der HTTP-Status-Code 204 (kein Inhalt) zurückgegeben.

Cron-Plan aktualisieren

Sie können einen JSON-Patch-Vorgang verwenden, um den Cron-Plan zu aktualisieren. Um den Zeitplan zu aktualisieren, deklarieren Sie die path-Eigenschaft als /schedule und setzen value auf einen gültigen Cron-Zeitplan. Weitere Informationen zum JSON Patch finden Sie in der Dokumentation zum JSON Patch. Weitere Informationen zu Cron-Zeitplänen finden Sie in der Dokumentation zum Format von Cron-Ausdrücken.

API-Format

PATCH /config/schedules/{SCHEDULE_ID}

Parameter	Beschreibung
`{SCHEDULE_ID}`	Der `id`-Wert des Zeitplans, den Sie aktualisieren möchten.

Anfrage

curl -X PATCH https://platform.adobe.io/data/core/ups/config/schedules/4e538382-dbd8-449e-988a-4ac639ebe72b \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '
[
    {
        "op":"add",
        "path":"/schedule",
        "value":"0 0 2 * *"
    }
]'

Eigenschaft	Beschreibung
`path`	Der Pfad des Werts, den Sie aktualisieren möchten. In diesem Fall müssen Sie, da Sie den Cron-Zeitplan aktualisieren, den Wert von `path` auf `/schedule` setzen.
`value`	Der aktualisierte Wert des Cron-Zeitplans. Dieser Wert muss in Form eines Cron-Zeitplans angegeben werden. In diesem Beispiel wird der Zeitplan am zweiten Tag jedes Monats ausgeführt.

Antwort

Bei erfolgreicher Antwort wird der HTTP-Status-Code 204 (kein Inhalt) zurückgegeben.

Löschen einzelner Zeitpläne

Sie können einen bestimmten Zeitplan löschen, indem Sie eine DELETE-Anforderung an den Endpunkt /config/schedules stellen und die ID des Zeitplans angeben, den Sie im Anforderungspfad löschen möchten.

API-Format

DELETE /config/schedules/{SCHEDULE_ID}

Parameter	Beschreibung
`{SCHEDULE_ID}`	Der `id`-Wert des Zeitplans, den Sie löschen möchten.

Anfrage

curl -X DELETE https://platform.adobe.io/data/core/ups/config/schedules/4e538382-dbd8-449e-988a-4ac639ebe72b \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort

Bei erfolgreicher Antwort wird der HTTP-Status-Code 204 (kein Inhalt) zurückgegeben.