View

This action will show information about record tasks

Tokens

This action requires the following tokens:

  • recordtask-read

Arguments

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

Argument Type Default Description
recordtask Hash   Only show the live task with this hash
status String   Only show record tasks with specific statuses. Comma-separated list. Possible values are: queued, running, pauserequested, paused, resumerequested, completed, stoprequested, canceled, cancelrequested, and failed
mindatecreated DateTime   Only show record tasks that are created on or after this date/time
maxdatecreated DateTime   Only show record tasks that are created on or before this date/time
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 start

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

  • start – Order on when the record task should start
  • end – Order on when the record task should end
  • status – Order on status of the record task
  • created – Order on when the record task was created
  • started – Order on when the record task was created
  • stopped – Order on when the record task was created
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 ID of this record task
source String The source of this record task
sourceproxy String The proxy for the source
livestream

The live stream of this record task

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
start DateTime Date and time this task will start
end DateTime Date and time this task will end
status String Status of this record task; one of queued, running, pauserequested, paused, resumerequested, completed, stoprequested, canceled, cancelrequested, failed
statusreason String If the task failed, a reason why it failed
datecreated DateTime When this record task has been created
datestarted DateTime If known, when this record task has been started; is always set if the current status is not queued
datestopped DateTime If known, when this record task has stopped; is always set if the current status is completed, canceled or failed

Errors

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