Pause

Pause a running record task.

Note that this will request the task to pause, but it will not be paused immediately.

This action requires a request with an active account.

Tokens

This action requires the following tokens:

  • recordtask-write

Arguments

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

Argument Type Default Description
recordtask Hash   The record task to pause

Output

This action produces the following output on success:

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 can return one of the default status codes, or one of the following status codes on error:

STATUS_RECORD_TASK_NOT_FOUND (410)
The record task could not be found
STATUS_RECORD_TASK_INVALID_STATUS (411)
The record task is not running, so it can not be paused