Zeitpläne sind ein Tool, mit dem Stapelsegmentierungsaufträge einmal täglich automatisch ausgeführt werden können. Mit dem /config/schedules
Endpunkt 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.
The endpoints used in this guide are part of the Adobe Experience Platform Segmentation Service API. Before continuing, please review the getting started guide for important information that you need to know in order to successfully make calls to the API, including required headers and how to read example API calls.
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.
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. |
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
}
You can retrieve detailed information about a specific schedule by making a GET request to the /config/schedules
endpoint and providing the ID of the schedule you wish to retrieve in the request path.
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 . |
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 Status oder den Cron-Zeitplan für einen bestimmten Zeitplan aktualisieren.
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 legen Sie value
entweder active
oder inactive
fest. Weitere Informationen zum JSON Patch finden Sie in der JSON Patch Dokumentation.
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 this case, since you are updating the schedule's state, you need to set the value of path to "/state". |
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.
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 legen Sie value
einen gültigen Cron-Zeitplan fest. Weitere Informationen zum JSON Patch finden Sie in der JSON Patch Dokumentation. 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 this case, since you are updating the cron schedule, you need to set the value of path to /schedule . |
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.
Sie können einen bestimmten Zeitplan löschen, indem Sie eine DELETE-Anforderung an den /config/schedules
Endpunkt senden 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.
Nach dem Lesen dieses Handbuchs haben Sie nun ein besseres Verständnis dafür, wie Zeitpläne funktionieren.