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-04-10T14:00:00Z",
    "createdBy": "a3f1c2d4-5678-4b9a-9f12-3456789abcde",
    "dayOfMonth": "15",
    "dayOfWeek": "Wednesday",
    "hour": "03",
    "isDefault": false,
    "minute": "30",
    "month": "April",
    "schemas": [
      "customer_data",
      "order_data"
    ],
    "selectiveMode": "incrementalFields",
    "syncId": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "syncMode": "normal",
    "updatedAt": "2024-04-15T14:30:00Z",
    "updatedBy": "b7e9f8a1-2345-4cde-8f90-123456789abc"
  }
}

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

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`](../../../../../../api-reference/bulk-sync/schedules/list). To update the schedule, use [`PUT /api/bulk/syncs/{sync_id}/schedules/{schedule_id}`](../../../../../../api-reference/bulk-sync/schedules/update).

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

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors