Scene

An EditorialObject with objectType="Scene", represents a single scene of a screenplay in the Limecraft Flow UI Screenplay Builder application.

In the image below, "1 EXT Beach Morning" is an example of a Scene.

EditorialObjects in Limecraft Flow UI

A Scene can only appear as a child of a Episode!

Deprecation warning. Episode and Scene 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	✘	String
categoryId	✘	Long	The id of the category we belong to	int64
content	✘	Object
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
includeCategoryName	✘	Boolean
includeChildren	✘	Boolean
includeContent	✘	Boolean
includeEdl	✘	Boolean
includeParent	✘	Boolean
includeSceneHeading	✘	Boolean
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	✘	EditorialObject
parentId	✘	Long	The id of the parent EditorialObject	int64
productionId	✘	Long		int64
sceneHeading	✘	String
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

Field Name

Required

Type

Description

Format

abstract

✘

String

alternativeTitle

✘

String

Can contain a second title (with the title field being the primary title)

category

✘

String

categoryId

✘

Long

The id of the category we belong to

int64

content

✘

Object

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.

✔

Long

The id of this resource

int64

includeCategoryName

✘

Boolean

includeChildren

✘

Boolean

includeContent

✘

Boolean

includeEdl

✘

Boolean

includeParent

✘

Boolean

includeSceneHeading

✘

Boolean

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

✘

EditorialObject

parentId

✘

Long

The id of the parent EditorialObject

int64

productionId

✘

Long

int64

sceneHeading

✘

String

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

sceneHeading

A string with the scene heading, e.g. "1. EXT Beach DAY".

content

The content of the scene, in a structured manner.

{
  "location": "TEST",
  "timeOfDay": "DAY",
  "locationType": "EXT",
  "sceneInstances": [
    {
      "dialogueInstances": [
        {
          "description": "I'm feeling lucky! We're going to catch a big fish today!",
          "type": "DIALOGUESPAN"
        }
      ],
      "type": "DIALOGUE",
      "character": {
        "name": "Ernesto"
      },
      "description": ""
    }
  ]
}