OMomni
Schema refresh schedules

Create schema refresh schedule

Changed on

Create a new schema refresh schedule for the specified connection. Multiple schedules can be created for the same connection.

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

Request

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

Path parameters

connectionIdstring uuid required

The unique identifier of the connection

Request body

schedulestring required

A 6-field cron expression in AWS EventBridge format defining when the schema refresh should run, specified as:

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

For example:

  • 00 09 * * ? * - Every day at 9:00 AM
  • 00 18 ? * MON-FRI * - Every weekday at 6:00 PM
  • 30 08 1 * ? * - First day of every month at 8:30 AM
timezonestring required

An IANA timezone identifier for when the schedule should run, such as America/New_York, Europe/London, Asia/Tokyo

hardRefreshboolean

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

Response

Schema refresh schedule created successfully

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

  • 43290040f88fRevision changes
    • breaking

      added the new required request property

    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status