View

View information about one or more record schedules

This action requires a request with an active account.

Tokens

This action requires the following tokens:

  • recordschedule-read

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
recordschedule Hash   Only show the record schedule with the given hash
searchtitle String   Only show record schedules containing the given string somewhere in the title
startdatemin DateTime   Only show record schedules starting on or after the given date
startdatemax DateTime   Only show record schedules starting on or before the given date
untilmin DateTime   Only show record schedules ending on or after the given date
untilmax DateTime   Only show record schedules ending on or before the given date
livestream Hash   Only show record schedules of the given livestream
active Boolean   Only show record schedules with the given active status. If not given, show all record schedules
protected Boolean   Only show record schedules with the given protected status. If not given, show all record schedules
limit Integer 20 The maximum number of results to include in the output
offset Integer 0 The number of results to skip when outputting
orderfield String title

Defines the field to order the results by; can be any of the following:

  • title – Order lexicographically by title
order String asc Sort the results by the field given in orderfield in ascending or descending order, by using ‘asc‘ or ‘desc‘ respectively

Output

This action produces the following extra headers on success, besides the default headers:

Name Type Description
count Integer The total number of results that would be returned when pagination would be disabled

This action produces the following output on success:

An array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
id Hash Hash of this schedule
name String Name of this schedule
user

User who created this record schedule

The value of this field is an object containing the following fields:

Name Type Description
id Hash User ID
username String User name
account

Account of this schedule

The value of this field is an object containing the following fields:

Name Type Description
id Hash Account ID
name String Account name
source String The source of this record schedule
sourceproxy String The proxy for the source
livestream

The live stream of this record schedule

The value of this field is an object containing the following fields:

Name Type Description
id Hash Livestream ID
title String Title of the live stream
description String Description of the live stream
type Label The type of this livestream; for available livestream types, refer to the documentation of the Livestream command
title String Title for created items
description String Description for created items
author String Author for created items
copyright String Copyright for created items
keywords

Keywords for created items

The value of this field is an array containing zero or more elements, each one being one String: One keyword

categories

Categories for created items

The value of this field is an array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
id Hash Category ID
name String The name of this category
protected Boolean Whether items created with this schedule will be protected
active Boolean Whether this schedule is active
startdate DateTime Start date and time for this schedule
duration Duration Duration for this schedule
datecreated DateTime When this schedule was created
datemodified DateTime When this schedule was last modified
nextstart DateTime The next time this schedule will record
laststart DateTime The last time this schedule was started
repeatschedule

Information about how this schedule will repeat

The value of this field is an object containing the following fields:

Name Type Description
frequency String The frequency of this schedule
count Integer How many times this schedule will repeat
until DateTime Until when this schedule will repeat
interval Integer The interval of this schedule
bysecond

On which seconds this schedule will repeat

The value of this field is an array containing zero or more elements, each one being one Integer: A second on which this schedule will repeat

byminute

On which minutes this schedule will repeat

The value of this field is an array containing zero or more elements, each one being one Integer: A minute on which this schedule will repeat

byhour

On which hours this schedule will repeat

The value of this field is an array containing zero or more elements, each one being one Integer: An hour on which this schedule will repeat

byday

On which days of the week this schedule will repeat

The value of this field is an array containing zero or more elements, each one being one String: A day of the week on which this schedule will repeat

bymonthday

On which days of the month this schedule will repeat

The value of this field is an array containing zero or more elements, each one being one Integer: A day of the month on which this schedule will repeat

byyearday

On which day of the year this schedule will repeat

The value of this field is an array containing zero or more elements, each one being one Integer: A day of the year on which this schedule will repeat

byweekno

On which weeks of the year this schedule will repeat

The value of this field is an array containing zero or more elements, each one being one Integer: A week of the year on which this schedule will repeat

bymonth

On which months this schedule will repeat

The value of this field is an array containing zero or more elements, each one being one Integer: A month on which this schedule will repeat

bysetpos

On which occurrences in the result set this schedule will repeat

The value of this field is an array containing zero or more elements, each one being one Integer: A occurrence in the result set on which this schedule will repeat

Errors

This action will always return one of the default status codes.