Examples

Here are some examples to perform specific actions. Do not hesitate to directly consult the documentation of the classes to know the parameters you can use as well as the functions available.

Retrieve projects accessible by the user

projects=aq.project.get_all()

Create a folder in a project

# projects is defined on the previous example
project = projects[0]
reference_folder=project.append(type='Group', data={'name': 'References'})

Upload an image to a folder

# reference_folder is defined on the previous example
media = reference_folder.item.append(type='Media', path=r"/mnt/project/image.jpg")

Retrieve folders of a project

# project is defined on previous example

folders = project.get_children(types="Group")

Create a shot in a sequence

sequence_key = 123456
shot = aq.item(sequence_key).append(type="Shot", data={'name': 's010_p100', frameIn: '101', frameOut: '256'})

Retrieve tasks assigned to the current user

me=aq.get_current_user()
my_tasks=me.get_tasks()

Retrieve tasks assigned within a project of the current user

projectKey=123456
me=aq.get_current_user()
my_tasks=me.get_tasks(project_key=projectKey)

Retrieve shots or assets of a project

projectKey=123456
project=aq.project(123456).get()
shots=project.get_shots()

Retrieve available statuses for a task

me=aq.get_current_user()
tasks=me.get_tasks()
statuses=tasks[0].get_statuses()

Create a playlist with media uploaded today

# project is defined on the previous example
playlist = project.append(type="Playlist", data={'name': 'My playlist'})
medias = project.traverse(meshql="# -($Child, 5)> $Media AND item.updatedAt > DATE_ROUND(@now, 1, 'day') VIEW item")
medias = [aq.item(media) for media in medias]

for media in medias:
    aq.edge.create(type="Child", from_key=playlist.item._key, to_key=media._key)

imported_media = playlist.item.get_medias()

Listen to events

events = aq.events.listen()
callback = lambda event: print(event)

allEvents = events.subscribe('*', callback)
itemCreated = events.subscribe('item.created', callback)

events.unsubscribe('*', allEvents)

events.start()