OMomniapp
Schedules

Get schedule

Changed on
get/api/v1/schedules/{scheduleId}

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/schedules/{scheduleId}
  • Auth
    HTTP bearer

Path parameters

scheduleIdstring uuid required

The UUID of the scheduled task. Can be found in the schedule's URL after /schedules/.

Example:123e4567-e89b-12d3-a456-426614174000

Query parameters

userIdstring uuid

User ID of the user whose access should be checked (org API keys only). When provided, that user must be able to view and schedule the document the schedule delivers. User-scoped API keys cannot use this parameter.

Example:987fcdeb-51a2-43d7-9b56-254415f67890

Response

Schedule details

conditionQueryMapKeystring nullable required

Query key used for alert condition (null for standard schedules)

conditionTypestring nullable required

Alert condition type: RESULTS_CHANGED, RESULTS_PRESENT, RESULTS_MISSING

createdAtstring date-time required

Creation timestamp

deletedAtstring date-time nullable required

Always null: a schedule in the trash returns 404. List schedules with includeDeleted to find it.

disabledAtstring date-time nullable required

Timestamp when the schedule was paused (null if active)

documentIdentifierstring required

Identifier of the document the schedule delivers, shared by the document's dashboard and workbook

entity'dashboard' | 'workbook' required

What the schedule delivers: the dashboard, or a tab of the workbook

entityIdstring required

Deprecated — use documentIdentifier. Internal ID of the dashboard, or of the document for a workbook delivery. A dashboard's changes when it is published.

fanOutboolean required

Whether personalized fan-out delivery is enabled. Personalized deliveries on connections that use OAuth sign-in fail instead of sending.

filterConfigunknown
idstring uuid required

Schedule UUID

killJobsOnFailureboolean required

Whether to stop the job if any queries fail

metadataunknown
namestring required

Schedule name

organizationIdstring uuid required

Organization UUID

ownerIdstring uuid required

User ID of the schedule owner

schedulestring required

AWS EventBridge cron expression (minute hour day-of-month month day-of-week year)

systemDisabledAtstring date-time nullable required

Timestamp when the system disabled the schedule

systemDisabledReasonstring nullable required

Reason for system disabling: contentRemoved, credentialMissing, destinationDisabled, missingQuery, noAccess, orphanedFilterConfigKeys, ownerRevoked

timezonestring required

IANA timezone for the schedule

updatedAtstring date-time required

Last update timestamp

Example response

{
  "destinations": [
    {
      "format": "pdf"
    }
  ],
  "documentIdentifier": "12db1a0a",
  "entity": "dashboard",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Weekly Sales Report",
  "schedule": "0 9 ? * MON *",
  "timezone": "America/New_York"
}

Changes

  • 6c4d29f19093Revision changes
    • info

      added the required property to the response with the status

  • 95080ca011e2Revision changes
    • info

      response property entityId deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status