StoryPart
An EditorialObject with objectType="StoryPart", represents a part of a story in the Limecraft Flow UI Story Builder application.
In the image below, "Growing up" and "Life on the boat" are examples of a StoryPart.
A StoryPart can only appear as a child of a Story!
Deprecation warning. Story and StoryPart could be removed from API and UI in the near future.
|
Property Reference
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
abstract |
✘ |
String |
||
alternativeTitle |
✘ |
String |
Can contain a second title (with the title field being the primary title) |
|
category |
✘ |
category |
||
categoryId |
✘ |
Long |
The id of the category we belong to |
int64 |
categoryName |
✘ |
String |
||
clipDescriptions |
✘ |
String |
||
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
customFields |
✘ |
CustomFields |
||
description |
✘ |
String |
Plain text description |
|
extent |
✘ |
String |
||
funnel |
✘ |
String |
Field which can be interpreted as a subtype (besides objectType). Only the objectType determines the structure of the EditorialObject, the funnel does not. It is meant for applications to indicate the EditorialObject is to be interpreted in a specific way. |
|
id |
✔ |
Long |
The id of this resource |
int64 |
lastUpdated |
✘ |
Date |
The time when this resource was last updated |
date-time |
modifiedBy |
✔ |
String |
The request or process responsible for the last update of this resource |
|
objectType |
✘ |
String |
The data model type or class name of this resource |
|
parent |
✘ |
parent |
||
parentId |
✘ |
Long |
The id of the parent EditorialObject |
int64 |
productionId |
✘ |
Long |
int64 |
|
status |
✘ |
String |
Status of the EditorialObject. Application-specific implementation. |
|
subObjects_index |
✘ |
Integer |
Order of this EditorialObject inside its parent. Gaps are allowed. |
int32 |
systemFields |
✘ |
CustomFields |
||
title |
✘ |
String |
Contains the primary title of the EditorialObject. |
|
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |
clipDescriptions
JSON stringified string of an array with objects. The objects have auditory and visual String properties.
[
{
"auditory": "something with audio",
"visual": "something visual"
},
{
"auditory": "",
"visual": ""
}
]Results in
{
"clipDescriptions": "[{\"auditory\":\"something with audio\",\"visual\":\"something visual\"},{\"auditory\":\"\",\"visual\":\"\"}]"
}