Get Bulk Sync Schedule | Polytomic Docs

curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schedules/248df4b7-aa70-47b8-a036-33ac447e668d \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>"

{
  "data": {
    "frequency": "weekly",
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "a3f1c2d4-5b6e-7f89-0123-456789abcdef",
    "dayOfMonth": "15",
    "dayOfWeek": "Monday",
    "deletedAt": null,
    "deletedBy": null,
    "hour": "14",
    "isDefault": false,
    "minute": "30",
    "month": "January",
    "schemas": [
      "customer_data",
      "order_data"
    ],
    "selectiveMode": "incrementalFields",
    "syncId": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "syncMode": "normal",
    "updatedAt": "2024-04-10T12:00:00Z",
    "updatedBy": "b7e8f9a0-1234-5678-9abc-def012345678"
  }
}

Returns a single schedule configured on a bulk sync.

Schedule times are returned in UTC.

To see all schedules on this sync, use GET /api/bulk/syncs/{sync_id}/schedules. To update the schedule, use PUT /api/bulk/syncs/{sync_id}/schedules/{schedule_id}.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Path parameters

sync_idstringRequiredformat: "uuid"

Unique identifier of the bulk sync.

schedule_idstringRequiredformat: "uuid"

Unique identifier of the schedule.

Response

dataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors