끝점 예약

예약은 하루에 한 번 배치 세그먼테이션 작업을 자동으로 실행하는 데 사용할 수 있는 도구입니다. 를 사용할 수 있습니다 /config/schedules 종단점은 일정 목록을 검색하거나, 새 일정을 만들거나, 특정 예약의 세부 사항을 검색하거나, 특정 일정을 업데이트하거나, 특정 일정을 삭제하는 것입니다.

시작하기

이 안내서에서 사용되는 엔드포인트는 Adobe Experience Platform Segmentation Service API. 계속하기 전에 시작 안내서 필수 헤더 및 예제 API 호출을 읽는 방법을 포함하여 API를 성공적으로 호출하기 위해 알고 있어야 하는 중요한 정보입니다.

일정 목록 검색

IMS 조직에 대한 GET 요청을 수행하여 모든 스케줄 목록을 검색할 수 있습니다 /config/schedules 엔드포인트.

API 형식

다음 /config/schedules endpoint는 결과를 필터링하는 데 도움이 되는 몇 가지 쿼리 매개 변수를 지원합니다. 이러한 매개 변수는 선택 사항이지만 고가의 오버헤드를 줄이는 데 도움이 되도록 사용하는 것이 좋습니다. 매개 변수 없이 이 종단점을 호출하면 조직에서 사용할 수 있는 모든 일정을 검색합니다. 여러 매개 변수를 앰퍼샌드( )로 구분하여 포함할 수 있습니다&).

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

요청

다음 요청은 IMS 조직 내에 게시된 마지막 10개의 일정을 검색합니다.

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}'

응답

성공적인 응답은 지정된 IMS 조직에 대한 일정 목록이 HTTP 상태 200을 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": {}
    }
}

새 일정 만들기

에 POST 요청을 작성하여 새 일정을 만들 수 있습니다 /config/schedules 엔드포인트.

API 형식

POST /config/schedules

요청

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"
}'

응답

성공적인 응답은 새로 만든 예약의 세부 정보와 함께 HTTP 상태 200을 반환합니다.

{
    "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
}

특정 일정 검색

에 GET 요청을 수행하여 특정 예약에 대한 자세한 정보를 검색할 수 있습니다 /config/schedules 엔드포인트 및 요청 경로에서 검색할 예약의 ID를 제공합니다.

API 형식

GET /config/schedules/{SCHEDULE_ID}

요청

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}'

응답

성공적인 응답은 지정된 일정에 대한 세부 정보와 함께 HTTP 상태 200을 반환합니다.

{
    "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
}

특정 일정에 대한 세부 정보 업데이트

에 PATCH 요청을 작성하여 특정 일정을 업데이트할 수 있습니다 /config/schedules endpoint 및 제공 요청 경로에서 업데이트하려는 예약의 ID

PATCH 요청을 통해 state 또는 예약 을 참조하십시오.

예약 상태 업데이트

JSON 패치 작업을 사용하여 예약의 상태를 업데이트할 수 있습니다. 상태를 업데이트하려면 path property as /state 그리고 value 다음 중 하나를 수행합니다. active 또는 inactive. JSON 패치에 대한 자세한 내용은 JSON 패치 설명서.

API 형식

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"
    }
]'

응답

성공적인 응답은 HTTP 상태 204(컨텐츠 없음)를 반환합니다.

크론 일정 업데이트

JSON 패치 작업을 사용하여 콘 일정을 업데이트할 수 있습니다. 일정을 업데이트하려면 path property as /schedule 그리고 value 올바른 cron 일정에 따라 변경할 수 있습니다. JSON 패치에 대한 자세한 내용은 JSON 패치 설명서. 크론 스케줄에 대한 자세한 내용은 cron 식 형식.

API 형식

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":"/schedule",
        "value":"0 0 2 * *"
    }
]'

응답

성공적인 응답은 HTTP 상태 204(컨텐츠 없음)를 반환합니다.

특정 일정 삭제

에 DELETE 요청을 수행하여 특정 일정을 삭제하도록 요청할 수 있습니다 /config/schedules 엔드포인트 및 요청 경로에서 삭제할 예약의 ID를 제공합니다.

API 형식

DELETE /config/schedules/{SCHEDULE_ID}

요청

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}'

응답

성공적인 응답은 HTTP 상태 204(컨텐츠 없음)를 반환합니다.

다음 단계

이 안내서를 읽은 후에는 일정이 어떻게 작동하는지 더 잘 알 수 있습니다.

부록

다음 부록에서는 예약에 사용되는 크론 표현식의 형식을 설명합니다.

형식

크론 표현식은 6 또는 7 필드로 구성된 문자열입니다. 표현식은 다음과 비슷합니다.

0 0 12 * * ?

cron 표현식 문자열에서 첫 번째 필드는 초를 나타내고, 두 번째 필드는 분을 나타냅니다. 두 번째 필드는 시간을 나타내고, 세 번째 필드는 시간을 나타내고, 네 번째 필드는 월의 일을 나타내고, 다섯 번째 필드는 월을 나타내고, 여섯 번째 필드는 요일을 나타냅니다. 연도를 나타내는 7번째 필드를 선택적으로 포함할 수도 있습니다.

허용되는 특수 문자는 다음 의미를 나타냅니다.

예시

다음 표는 샘플 cron 표현식 문자열을 보여 주고 그 의미를 설명합니다.

Business.Adobe.com 리소스