Slutpunkt för scheman

Scheman är ett verktyg som kan användas för att automatiskt köra batchsegmenteringsjobb en gång om dagen. Du kan använda slutpunkten /config/schedules för att hämta en lista med scheman, skapa ett nytt schema, hämta information om ett specifikt schema, uppdatera ett specifikt schema eller ta bort ett specifikt schema.

Komma igång

Slutpunkterna som används i den här guiden ingår i Adobe Experience Platform Segmentation Service-API:t. Innan du fortsätter bör du läsa kom igång-guiden för att få viktig information som du behöver känna till för att kunna ringa anrop till API:t, inklusive nödvändiga rubriker och hur du läser exempel-API-anrop.

Hämta en lista med scheman retrieve-list

Du kan hämta en lista över alla scheman för din organisation genom att göra en GET-förfrågan till slutpunkten /config/schedules.

API-format

Slutpunkten /config/schedules har stöd för flera frågeparametrar som kan hjälpa dig att filtrera dina resultat. Även om dessa parametrar är valfria rekommenderar vi starkt att de används för att minska dyra overheadkostnader. Om du anropar den här slutpunkten utan parametrar hämtas alla scheman som är tillgängliga för din organisation. Flera parametrar kan inkluderas, avgränsade med et-tecken (&).

GET /config/schedules
GET /config/schedules?{QUERY_PARAMETERS}

Frågeparametrar

Begäran

Följande förfrågan hämtar de tio senaste scheman som publicerats inom din organisation.

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: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Svar

Ett lyckat svar returnerar HTTP-status 200 med en lista över scheman för den angivna organisationen som JSON.

{
    "_page": {
        "totalCount": 10,
        "pageSize": 1
    },
    "children": [
        {
            "id": "4e538382-dbd8-449e-988a-4ac639ebe72b",
            "imsOrgId": "{ORG_ID}",
            "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": {}
    }
}

Skapa ett nytt schema create

Du kan skapa ett nytt schema genom att göra en POST-förfrågan till slutpunkten /config/schedules.

API-format

POST /config/schedules

Begäran

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: {ORG_ID}' \
 -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"
}'

Svar

Ett lyckat svar returnerar HTTP-status 200 med information om ditt nyligen skapade schema.

{
    "id": "4e538382-dbd8-449e-988a-4ac639ebe72b",
    "imsOrgId": "{ORG_ID}",
    "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
}

Hämta ett specifikt schema get

Du kan hämta detaljerad information om ett specifikt schema genom att göra en GET-förfrågan till slutpunkten /config/schedules och ange ID:t för det schema som du vill hämta i sökvägen till begäran.

API-format

GET /config/schedules/{SCHEDULE_ID}

Begäran

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: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Svar

Ett lyckat svar returnerar HTTP-status 200 med detaljerad information om det angivna schemat.

{
    "id": "4e538382-dbd8-449e-988a-4ac639ebe72b",
    "imsOrgId": "{ORG_ID}",
    "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
}

Uppdatera information för ett specifikt schema update

Du kan uppdatera ett specifikt schema genom att göra en PATCH-begäran till slutpunkten /config/schedules och ange ID:t för det schema som du försöker uppdatera i sökvägen till begäran.

Med PATCH-begäran kan du uppdatera antingen state eller cron schedule för ett enskilt schema.

API-format

PATCH /config/schedules/{SCHEDULE_ID}

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: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '
[
    {
        "op": "add",
        "path": "/state",
        "value": "active"
    }
]'

Begäran

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: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '
[
    {
        "op":"add",
        "path":"/schedule",
        "value":"0 0 2 * * ?"
    }
]'

Svar

Ett lyckat svar returnerar HTTP-status 204 (inget innehåll).

Ta bort ett specifikt schema

Du kan begära att ett visst schema ska tas bort genom att göra en DELETE-begäran till slutpunkten /config/schedules och ange ID:t för det schema som du vill ta bort i sökvägen till begäran.

API-format

DELETE /config/schedules/{SCHEDULE_ID}

Begäran

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: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Svar

Ett lyckat svar returnerar HTTP-status 204 (inget innehåll).

Nästa steg

När du har läst den här guiden får du nu en bättre förståelse för hur scheman fungerar.

Bilaga appendix

I följande bilaga förklaras formatet för de cron-uttryck som används i scheman.

Format

Ett cron-uttryck är en sträng som består av 6 eller 7 fält. Uttrycket skulle se ut ungefär så här:

0 0 12 * * ?

I en cron-uttryckssträng representerar det första fältet sekunder, det andra representerar minuter, det tredje representerar timmar, det fjärde fältet representerar dag i månaden, det femte fältet representerar månad och det sjätte fältet representerar veckodag. Du kan också inkludera ett sjunde fält som representerar året.

De specialtecken som tillåts har följande betydelse:

Exempel

I följande tabell visas exempel på strängar för cron-uttryck och en förklaring av vad de betyder.