shotgun.actions#

A list of ShotGrid specific actions.

Functions:

create_entity(entity_type, entity_name[, ...])

Creates a new ShotGrid entity linked to the currently active project.

create_project(server, job, root, entity_name)

Creates a new ShotGrid entity linked to the currently active project.

create_published_file(sg, version_entity, ...)

Creates a new PublishedFile entity on ShotGrid.

create_version(sg, file_name, file_path, ...)

Add a new Version entity to ShotGrid.

get_status_codes(sg)

Returns a list of status codes available in the current context.

save_entity_data_to_db(server, job, root, ...)

Save the selected entity data to the Bookmark Database.

upload_movie(sg, version_entity, version_movie)

Upload a movie file for the given version.

upload_thumbnail(sg_properties, thumbnail_path)

Uploads an item thumbnail to shotgun.

bookmarks.shotgun.actions.create_entity(entity_type, entity_name, request_data=None, create_data=None, verify_bookmark=True, verify_all=False)[source]#

Creates a new ShotGrid entity linked to the currently active project.

bookmarks.shotgun.actions.create_project(server, job, root, entity_name)[source]#

Creates a new ShotGrid entity linked to the currently active project.

bookmarks.shotgun.actions.create_published_file(sg, version_entity, name, file_name, file_path, version, description, project_entity, asset_entity, user_entity, task_entity, published_file_type_entity, local_storage_entity)[source]#

Creates a new PublishedFile entity on ShotGrid.

The data structure was taken from the ShotGrid API documentation https://developer.shotgunsoftware.com/tk-core/_modules/tank/util/shotgun/publish_creation.html#register_publish

bookmarks.shotgun.actions.create_version(sg, file_name, file_path, version_movie, version_sequence, version_cache, description, project_entity, asset_entity, task_entity, user_entity, status_entity)[source]#

Add a new Version entity to ShotGrid.

bookmarks.shotgun.actions.get_status_codes(sg)[source]#

Returns a list of status codes available in the current context.

bookmarks.shotgun.actions.save_entity_data_to_db(server, job, root, source, table, entity, value_map)[source]#

Save the selected entity data to the Bookmark Database.

bookmarks.shotgun.actions.upload_movie(sg, version_entity, version_movie, num_tries=3)[source]#

Upload a movie file for the given version.

bookmarks.shotgun.actions.upload_thumbnail(sg_properties, thumbnail_path)[source]#

Uploads an item thumbnail to shotgun.