Collection¶
-
class
vidispine.collections.Collection(client)¶ Collections
A collection is an ordered logical set of items, libraries and other collections.
-
create(params: Optional[dict] = None) → str¶ Creates a new collection.
- Parameters
params – Optional query parameters.
- Returns
id associated with the collection.
- Return type
str.
-
delete(collection_id: str) → None¶ Delete specified collection.
- Parameters
collection_id – The id of the collection to delete.
-
delete_multiple(collection_ids: list) → None¶ Delete multiple collections.
- Parameters
collection_ids – A list of collection ids to delete.
-
get(collection_id: str, params: Optional[dict] = None) → Dict[str, Any]¶ Return the ids of the objects contained within the collection
- Parameters
collection_id – The id of the collection to get.
params – Optional query parameters.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-
list(params: Optional[dict] = None, matrix_params: Optional[dict] = None) → Dict[str, Any]¶ Retrieves a list of all known collections.
- Parameters
params – Optional query parameters.
matrix_params – Optional matrix parameters.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-