CLcloudbeds
Schedules

Get schedule

get/datainsights/v1.1/schedules/{schedule_id}

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Headers

X-PROPERTY-IDinteger required

Property id of the client

Response

OK

idinteger

Schedule ID

frequencystring required

Schedule frequency in cron format.

Needs to match the following pattern:

(0)\                                                                        # minutes ~ 0
(\*|([0-9]|1[0-9]|2[0-3])|\*)\                                              # hours ~ * OR 0-23
(\*|([1-9]|[1-2][0-9]?|3[0-1]))?(,(\*|([1-9]|[1-2][0-9]?|3[0-1]))){0,30}\   # day of month ~ * OR 1-31
(\*|([1-9]|1[0-2]?))?(,(\*|([1-9]|1[0-2]?))){0,12}\                         # month ~ * OR 1-12
(\*|[0-6])(,(\*|[0-6])){0,7}                                                # day of week ~ * OR 0-6
$                                                                           # matches the end of the string
  • 0 10 * * 0,1,2,4,5 - At 10:00 on Sunday, Monday, Tuesday, Thursday, and Friday
  • 0 10 * * 2 - At 10:00 on Tuesday
  • 0 23 * 12 * - At 23:00 in December
  • 0 23 1,31 1,2,5,6,7,10,11 1,3 - At 08:00 on day-of-month 1 and 31 and on Monday and Wednesday in January, February, May, June, July, October, and November
view'formatted' | 'details'

Scheduled report view. Should be either 'formatted' or 'details'

format'xlsx' | 'csv' | 'json'

Scheduled report format. Should be either 'xlsx', 'csv' or 'json'

subjectstring

Subject of the email

recipientsstring[] required

List of emails that will receive the report

created_atstring

Schedule created at

updated_atstring

Schedule updated at

upcoming_atstring %Y-%m-%dT%H:00:00Z

Schedule upcoming at

report_idsinteger[] required

Report schedule ids

property_idinteger

Property ID

user_idinteger

User ID

Example response

{
  "id": 1,
  "frequency": "0 10 15 * *",
  "view": "formatted",
  "format": "xlsx",
  "created_at": "2022-01-01T12:00:00Z",
  "updated_at": "2022-01-02T10:00:00Z",
  "upcoming_at": "2022-01-02T18:00:00Z",
  "property_id": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.