Flow Production Tracking Python API

When working with tasks that have splits, the relationship between start_date, due_date, duration, and the splits list is automated:

Date/Duration Priority

• If splits are provided, the supplied start_date, due_date, and duration fields are ignored for the initial update. Instead, start_date is inferred from the earliest split and due_date from the last split.

Automatic Adjustments

• Changing start_date: The first split moves to the new start_date, and all subsequent splits shift to maintain existing gap lengths and respect workday rules.
• Changing due_date: The last split moves to end on the new due_date, and all prior splits shift to maintain gap lengths and respect workday rules.
• Changing duration:
  • Longer duration: Additional days are added to the end of the last split.
  • Shorter duration: Starting from the latest splits, segments are either removed or shortened until the new duration is met.
• Setting due_date in a gap: If the due_date is set within a gap between splits, the later splits are removed, and the day of the new due_date becomes a work day.

When querying a field that contains a local file link, the returned dictionary contains several keys. Note that all keys are returned even if they are None (e.g., if a specific platform path is not set).

Available Keys:

• content_type (str): The MIME-type of the file (automatically guessed from extension unless overridden).
• link_type (str): Always 'local' for these fields.
• name (str): The display name of the file.
• local_path (str): The full path to the file on the current platform. The API automatically maps platform-specific keys to this field for convenience.
• local_path_linux (str): Read-only. Full path on Linux.
• local_path_mac (str): Read-only. Full path on macOS.
• local_path_windows (str): Read-only. Full path on Windows.
• local_storage (dict): Read-only. The LocalStorage entity applied to this link.
• relative_path (str): Read-only. The path relative to the local_storage root.
• url (str): Read-only. A file:// URI pointing to the local_path.

To reduce API round-trips and improve application speed, you can use "field hopping" (dot notation) to query or return data from linked entities in a single call. Instead of performing multiple queries to resolve relationships, you can traverse a single-entity relationship using the syntax field.EntityType.field_name.

Key Rules:

• Use dot notation to join field names to entity types in a chain.
• Limitation: Due to performance concerns, dot notation chains are only supported for single-entity relationships. You cannot pull data through a multi-entity field (e.g., a list of entities).
• This technique works with both sg.find() and sg.create() methods.

# Example 1: Querying via a linked entity's field
# Instead of finding the Project first, query Shots directly by Project name
project_name = 'Big Buck Bunny'
sg_shots = sg.find("Shot", [['project.Project.name', 'is', project_name]], ['code'])

# Example 2: Returning linked data in the results
# Retrieve the shot code AND the status of the associated Sequence
project_name = 'Big Buck Bunny'
sg_shots = sg.find(
    "Shot", 
    [['project.Project.name', 'is', project_name]],
    ['code', 'sg_sequence.Sequence.sg_status_list']
)

When using update() to modify Task dates, Flow Production Tracking performs automatic calculations for start_date, due_date, and duration. The system follows specific precedence rules to ensure schedule consistency:

• Updating start_date: Automatically updates due_date (keeping duration constant).
• Updating due_date: Automatically updates duration (keeping start_date constant).
• Updating duration: Automatically updates due_date (keeping start_date constant).
• Precedence of Fields: If both start_date and due_date are provided in a single update, duration is ignored. The system sets start_date first, then due_date, and calculates the new duration based on the difference.
• Milestones:
  • Set milestone to False before updating other schedule fields if you want to avoid losing start_date, due_date, or duration values.
  • If milestone is set to True, duration is ignored.
  • Setting milestone to True while providing conflicting start_date and due_date values will raise an Exception.
• Order of Operations: If due_date and duration are provided without a start_date, duration is set first, then due_date is updated to prevent the duration change from overwriting the due date.

Note: The duration field is stored in minutes.

In Flow Production Tracking, files are stored as Attachment entities. An Attachment can represent an uploaded file, a web link, or a local file reference.

Important Note: This documentation describes the structure of the Attachment entity. If you simply want to upload a file, use the Shotgun.upload or Shotgun.upload_thumbnail methods instead.

Default Fields

• description (str): Optional descriptive text.
• this_file (dict): The core file reference. This field cannot be modified after creation. It contains a link_type key which determines the file type.
• filename (str): Automatically assigned for uploads.
• file_size (int): Automatically assigned for uploads (in bytes).
• id (int): Internal ID.
• attachment_links (list): Entity dictionaries used for linking the attachment to multiple entities.
• attachment_reference_links (list): Similar to attachment_links, but used specifically for reference links.
• project (dict): Required. The Project entity this attachment belongs to.
• sg_status_list (str): Status short code.
• tag_list (list): List of string tags.
• image (str): URL to the thumbnail image.
• sg_type (str): Optional designation for attachment types.
• processing_status (str): Reflects processing state (e.g., 'Thumbnail Pending').