OMomni
Schema refresh schedules

Get schema refresh schedule

Retrieve the details of a connection's specific schema refresh schedule.

<Note> This endpoint requires Connection Admin permissions for the connection. </Note>
get/v1/connections/{connectionId}/schedules/{scheduleId}

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/connections/{connectionId}/schedules/{scheduleId}
  • Auth
    HTTP bearer

Path parameters

connectionIdstring uuid required

The unique identifier of the connection

scheduleIdstring uuid required

The unique identifier of the schema refresh schedule

Response

Successfully retrieved schema refresh schedule

scheduleIdstring uuid

The unique identifier of the schema refresh schedule

connectionIdstring uuid

The unique identifier of the connection this schedule belongs to

schedulestring

A 6-field cron expression in AWS EventBridge format defining when the schema refresh should run.

Format: minute hour day-of-month month day-of-week year

timezonestring

The IANA timezone identifier for when the schedule should run

descriptionstring

A human-readable description of the schedule, automatically generated from the cron expression and timezone

hardRefreshboolean

Whether the scheduled refresh performs a hard refresh (removes dropped objects) or soft refresh (additive only). Defaults to false (soft refresh).

createdAtstring date-time

The timestamp when the schedule was created

updatedAtstring date-time

The timestamp when the schedule was last updated

disabledAtstring date-time nullable

The timestamp when the schedule was disabled, or null if active

Changes

No recorded changes to this operation across all 2 revisions of this API.