Create¶
Create a new item
This action requires a request with an active account.
Arguments¶
Required arguments are marked in bold, and optional arguments are marked in italics.
Argument | Type | Default | Description |
---|---|---|---|
itemtype | Label | Label of the item type of this item | |
title | String | The title of the new item; defaults to the item hash | |
author | String | The author of the new item | |
copyright | String | The copyright notice for the new item | |
description | String | The description for the new item | |
dateaired | DateTime | The date at which the item was aired, for example on a telivision channels; defaults to not set | |
externalid | String | The external ID for the new item | |
externallink | URL | A link where this item can be found (i.e. where the video is embedded) | |
keywords | String | The comma-separated keywords for the new item | |
securityprofile | Hash | The security profile to use for the new item | |
livestream | Hash | The live stream from which this item originates; usually used to indicate that this item is a recording from the given live stream | |
archived | Boolean | false | Whether the new item is archived |
protected | Boolean | Whether the new item is protected; see Item documentation on protected items. If not supplied, use the account default | |
vrtype | Label | If given, the type of virtual reality rendering to use to play this item; otherwise, this item is displayed as an ordinary video This argument can only contain one of the following values:
|
Output¶
This action produces the following output on success:
An object containing the following fields:
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | Hash | Item ID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
title | String | Title of the item | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | String | Description of the item | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | Label | The type of this item; for available item types, refer to the documentation of the Item command | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account | The account that created this item The value of this field is an object containing the following fields:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
datecreated | DateTime | When this item was created; for recordings of live-events, this is the date when the item finished recording | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duration | Duration | Duration of this item | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
originalfilename | String | Original, human-readable name of the item | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
author | String | Author of the item | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keywords | Keywords associated with this item, as an array The value of this field is an array containing zero or more elements, each one being one String |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
copyright | String | Copyright notice of the item | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
externallink | String | A link to an external page, such as a page containing more information about this item, or the page where this item is embedded | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
externalid | String | An external ID which can be used by clients | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
protected | Boolean | True if signed links must be used to view this item, otherwise false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
archived | Boolean | True if this item has been archived | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
securityprofile | Security profile The value of this field is an object containing the following fields:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
datemodified | DateTime | When this item was last modified | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dateaired | DateTime | When this item was aired, e.g. on television | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user | The user that created this item The value of this field is an object containing the following fields:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
views | Integer | The total number of views recorded for this item; this is equal to the number of plays as reported by the Statistics command | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
videoaspect | Float | The aspect ratio of the video in this item, if applicable; the value is a float such as 1.333333 for an aspect ratio of 4:3 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
thumbnails | Links to the thumbnails for this item. See Posters for details on the format The value of this field is an array containing zero or more elements, each one being an object containing the following fields:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
selectedthumbnail | Integer | Which thumbnail is the selected one | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
selectedthumbnailurl | String | URL of the currently selected thumbnail | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
moviestripsurl | String | URL of the moviestrips file | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
medialink | The URLs at which this item is available for streaming The value of this field is an object containing the following fields:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transcodestatus | String | The current status of transcodes for this item | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transcodefailures | String | The current status of transcode failures for this item | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isplayable | Boolean | Whether or not this item is playable through a standard embedframe at this moment | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isbeingreplaced | Boolean | Whether or not this item is being replaced with a new source file at this moment | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
vrtype | Label | If this item is a virtual reality video, the type of virtual reality rendering to apply | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
livestream | Live stream from which this item originates The value of this field is an object containing the following fields:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replacementitemfile | File used for replacing original files The value of this field is an object containing the following fields:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
categories | Categories this item belongs to The value of this field is an array containing zero or more elements, each one being an object containing the following fields:
|
Errors¶
This action will always return one of the default status codes.