Skip to content

Commit 65621d9

Browse files
committed
#36383 Adds nav_expand() method to python-api
Creating PR for work done by @daigles on nav_expand() endpoint... * Adds method to ensure filter presets are supported * adds optional additional_filter_presets args where needed with links to docs * adds unit test for nav_expand call.
1 parent 99e4603 commit 65621d9

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

shotgun_api3/shotgun.py

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2049,6 +2049,25 @@ def activity_stream_read(self, entity_type, entity_id, entity_fields=None,
20492049
result = self._parse_records(record)[0]
20502050
return result
20512051

2052+
def nav_expand(self, path, seed_entity_field=None, entity_fields=None):
2053+
"""
2054+
Expand the navigation hierarchy for the supplied path.
2055+
2056+
.. warning::
2057+
2058+
This is an experimental method that is not officially part of the
2059+
python-api. Usage of this method is discouraged. This method's name,
2060+
arguments, and argument types may change at any point.
2061+
2062+
"""
2063+
return self._call_rpc(
2064+
'nav_expand',
2065+
{
2066+
'path':path,
2067+
'seed_entity_field': seed_entity_field,
2068+
'entity_fields': entity_fields
2069+
}
2070+
)
20522071

20532072
def get_session_token(self):
20542073
"""Get the session token associated with the current session.

0 commit comments

Comments
 (0)