Skip to content

CRUD Operations

Basic Create, Read, Update, Delete operations for ShotGrid entities.

create_entity

Create a new entity in ShotGrid.

Parameters

ParameterTypeRequiredDescription
entity_typestringYesEntity type (Shot, Asset, Task, etc.)
dataobjectYesEntity data

Example

Create a new shot called "SH001" in project 123

find_one_entity

Find a single entity by ID or filters.

Parameters

ParameterTypeRequiredDescription
entity_typestringYesEntity type
filtersarrayYesFilter conditions
fieldsarrayNoFields to return

Example

Find shot with ID 456

search_entities

Search for multiple entities matching criteria.

Parameters

ParameterTypeRequiredDescription
entity_typestringYesEntity type
filtersarrayNoFilter conditions
fieldsarrayNoFields to return
orderarrayNoSort order
limitnumberNoMax results

Example

Find all shots in project 123 with status "ip"

update_entity

Update an existing entity.

Parameters

ParameterTypeRequiredDescription
entity_typestringYesEntity type
entity_idnumberYesEntity ID
dataobjectYesFields to update

Example

Update shot 456 status to "fin"

delete_entity

Delete an entity (soft delete).

Parameters

ParameterTypeRequiredDescription
entity_typestringYesEntity type
entity_idnumberYesEntity ID

Example

Delete shot 456

Released under the MIT License.