Usage examples

The following examples show how to use the API to accomplish specific tasks using the default configuration.

Note

If you are using a server with a customised configuration you may need to alter the examples slightly to make them work correctly.

Most of the examples assume you have the ftrack_api package imported and have already constructed a Session:

import ftrack_api

session = ftrack_api.Session()

• Working with projects
  • Creating a project
• Working with components
• Using review sessions
• Using metadata
• Using custom attributes
  • Limitations
    • Set attributes on new entities
    • Expression attributes
    • Hierarchical attributes
  • Validation
• Managing custom attribute configurations
  • Global or project specific
  • Entity types
  • Custom attribute configuration types
  • Changing default
  • Security roles
  • Custom attribute groups
• Using link attributes
• Using scopes
• Managing jobs
  • Attachments
• Using notes
  • Attachments
• Using lists
• Using timers
• Working with assignments and allocations
• Working with thumbnails
  • Retrieving thumbnail URL
• Encoding media
• Using entity links
  • Using asset version link shortcut
• Publishing for web review
• Publishing versions
• Working with user security roles
• Working with Task Templates
  • Query task templates
  • “Apply” a task template
• Sync users with LDAP
• Invite user
• Creating workflow schemas