civis (version 3.1.0)

predictions_list_schedules: Show the prediction schedule

Description

Show the prediction schedule

Usage

predictions_list_schedules(id)

Value

A list containing the following elements:

id

integer, ID of the prediction associated with this schedule.

schedule

list, A list containing the following elements:

• scheduled boolean, If the item is scheduled.

• scheduledDays array, Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth

• scheduledHours array, Hours of the day it is scheduled on.

• scheduledMinutes array, Minutes of the day it is scheduled on.

• scheduledRunsPerHour integer, Deprecated in favor of scheduled minutes.

• scheduledDaysOfMonth array, Days of the month it is scheduled on, mutually exclusive with scheduledDays.

scoreOnModelBuild

boolean, Whether the prediction will run after a rebuild of the associated model.

Arguments

id

integer required. ID of the prediction associated with this schedule.