Collection.md

Collection

Collection of scores

Properties

Name	Type	Description	Notes
id	str	Unique identifier of the collection
title	str	The title of the collection
html_url	str	The url where the collection can be viewed in a web browser
type	CollectionType
label_key	str	Product-specific translation key for the collection type. Only set for specific collection types: * For `regular` type: `playlist` (Flat) or `collection` (Flat for Education) * For `collaborations` type: `collaboration` (Flat) or `shared-scores` (Flat for Education) Not set for other collection types.	[optional]
privacy	CollectionPrivacy		[default to CollectionPrivacy.PRIVATE]
sharing_key	str	The private sharing key of the collection (available when the `privacy` mode is set to `privateLink`)	[optional]
app	CollectionApp		[optional]
creation_date	datetime	The date when the collection was created
modification_date	datetime	The date when the collection was last modified	[optional]
user	UserPublicSummary		[optional]
organization	str	If the score has been created in an organization, the identifier of this organization.	[optional]
rights	ResourceRights		[optional]
collaborators	List[ResourceCollaborator]	The list of the collaborators of the collection	[optional]
is_pinned	bool	Whether the collection is pinned by the owner	[optional]
contents	CollectionContents
capabilities	CollectionCapabilities
collections	List[str]	The list of parent collections this score is included in. Please note that you might not have access to all of them.	[optional]

Example

from flat_api.models.collection import Collection

# TODO update the JSON string below
json = "{}"
# create an instance of Collection from a JSON string
collection_instance = Collection.from_json(json)
# print the JSON string representation of the object
print(Collection.to_json())

# convert the object into a dict
collection_dict = collection_instance.to_dict()
# create an instance of Collection from a dict
collection_from_dict = Collection.from_dict(collection_dict)

[Back to Model list] [Back to API list] [Back to README]