Available data
Model instances as dict
To make things simple and allow easy interoperability, all model instances are returned as Python dicts. When you perform a query through the client you retrieve either a list of dicts or a dict depending on the query.
Date format
Common fields
Each model instance provides at least the same three fields:
id: a unique id made of letters, hyphens and numbers
created_at: the creation date
updated_at: the update date
They share another field that is dynamically generated:
type: the model instance type
Models
Here is the list of all available data tables (and related fields) you can access through the Python client:
Assets (constituants of a shot scene)
name
code: Utility field for the pipeline to identify the asset
description: Asset Brief
canceled: True if the asset has been delete one time.
project_id: Project ID
entity_type_id: Asset type ID
source_id: Field uset to set the episode_id
preview_file_id: ID of preview file used as thumbnail
data: Free JSON field to add metadata
shotgun_id: Used for synchronization with a Shotgun instance
Asset instances (asset instance are instances of an asset in a layout scene)
asset_id: Instantiated asset
number
name (try to not use this field)
description
active: True if
data: Free JSON field to add metadata
scene_id: target scene
target_asset_id: Use when instantiating an asset in an asset is required.
Asset types
name
Comments
object_id: Unique ID of the commented model instance
object_type: Model type of the comment model instance
text
task_status_id: Task status attached to comment
person_id: The person who publishes the comment
previews: previews atached to the comment
data: Free JSON field to add metadata
shotgun_id: Used for synchronization with a Shotgun instance
Episodes
name
code: Utility field for the pipeline to identify the episode
description: Episode brief
canceled: True if the episode has been deleted one time.
project_id: Project ID
source_id: Field uset to set the episode_id
preview_file_id: ID of preview file used as thumbnail
data: Free JSON field to add metadata
shotgun_id: Used for synchronization with a Shotgun instance
Events
name
user_id: the user who made the action that emitted the event.
data: Free JSON field to add event data
File status
name
color
Metadata
project_id: project for which metadata are added
entity_type: ‘Asset’ or ‘Shot’
name: Field name for GUI
field_name: Technical field name
choices: Array of string that represents the available values for this metada (this metatada is considered as a free field if this array is empty).
Notifications
read: True if user read it.
person_id: The user to who the notification is aimed at.
change: True if there is status change related to this status
author_id: Author of the event to notify
comment_id: Comment related to the notification, if there is any.
task_id: Task related to the notification if there is any.
Output files
name
extension
revision
size
checksum
description
comment
representation: to tell what kind of output it is (abc, jpgs, pngs, etc.)
nb_elements: For image sequence
source: created by a script, a webgui or a desktop gui.
path: File path on the production hard drive
data: Free JSON field to add metadata
file_status_id
entity_id: Asset or Shot concerned by the output file
task_type_id: Task type relate to this output file (modeling, animation, etc.)
output_type_id: Type of output (geometry, cache, etc.)
person_id = Author of the file
source_file_id = Working file that led to create this output file
temporal_entity_id = Shot, scene or sequence, needed for output files related to an asset instance.
Output types
name
short_name
Persons
email: Serve as login
desktop_login: Login used on the desktop
first_name
last_name
phone
active: If the person is still in the studio or not
last_presence: Last time the person worked for the studio
shotgun_id: Used for synchronization with a Shotgun instance
timezone
locale
role
has_avatar: True if user has an avatar
data: Free JSON field to add metadata
Playlists
name
shots: JSON field describing shot and preview listed in the playlist
project_id
episode_id
Preview files
name
revision
extension: file extension
description
path: File path on the production hard drive
source: Webgui, desktop, script
annotations: Coordinates to display annotations in the preview player.
task_id: task related to the preview file
person_id: Autho of the preview
source_file_id: Working file that generated this preview
shotgun_id: Used for synchronization with a Shotgun instance
Projects
name
code
project_status_id
team: List of person working on the project
description
file_tree: templates to use to build file paths
has_avatar: True if project has an avatar
data: Free JSON field to add metadata
fps
ratio
resolution
production_type: short, featurefilm or tvshow
shotgun_id: Used for synchronization with a Shotgun instance
Search filters
list_type
entity_type
name
search_query
person_id
project_id
Sequences
name
code: Utility field for the pipeline to identify the asset
description: Sequence Brief
canceled: True if the asset has been delete one time.
project_id: Project ID
parent_id: Episode ID
source_id: Field uset to set the episode_id
preview_file_id: ID of preview file used as thumbnail
data: Free JSON field to add metadata
shotgun_id: Used for synchronization with a Shotgun instance
Shots
name
code: Utility field for the pipeline to identify the asset
description: Shot Brief
canceled: True if the asset has been delete one time.
project_id: Project ID
parent_id: Episode ID
entity_type_id: Shot type ID
source_id: Field uset to set the episode_id
preview_file_id: ID of preview file used as thumbnail
data: Free JSON field to add metadata
shotgun_id: Used for synchronization with a Shotgun instance
Software
name
short_name
file_extension: Main extension used for this software files
secondary_extensions: Other extensions used for this software files
Subscriptions to notifications
person_id
task_id
entity_id
task_type_id
Tasks
shotgun_id: Used for synchronization with a Shotgun instance
Task status
name
short_name
color
is_done
is_artist_allowed
is_retake
shotgun_id: Used for synchronization with a Shotgun instance
Task types
name
short_name
color
priority
allow_timelog
for_shots
for_entity
shotgun_id: Used for synchronization with a Shotgun instance
Time spents
duration
date
task_id: Related task
person_id: The person who performed the working time
Working files
name
description
comment
revision
size
checksum
path: File path on the production hard drive
task_id: Task for which the working file is made for
entity_id: Entity for which the working is made for
person_id: File author
software_id: Sofware used to build this working file
outputs: List of output files generated from this working file
data: Free JSON field to add metadata