All URIs are relative to https://api.flat.io/v2
| Method | HTTP request | Description |
|---|---|---|
| add_score_collaborator | POST /scores/{score}/collaborators | Add a new collaborator |
| add_score_track | POST /scores/{score}/tracks | Add a new video or audio track to the score |
| create_export_task | POST /scores/{score}/revisions/{revision}/{format}/task | Create a new score export task |
| create_score | POST /scores | Create a new score |
| create_score_revision | POST /scores/{score}/revisions | Create a new revision |
| delete_score | DELETE /scores/{score} | Delete a score |
| delete_score_comment | DELETE /scores/{score}/comments/{comment} | Delete a comment |
| delete_score_track | DELETE /scores/{score}/tracks/{track} | Remove an audio or video track linked to the score |
| edit_score | PUT /scores/{score} | Edit a score's metadata |
| fork_score | POST /scores/{score}/fork | Fork a score |
| get_group_scores | GET /groups/{group}/scores | List group's scores |
| get_score | GET /scores/{score} | Get a score's metadata |
| get_score_collaborator | GET /scores/{score}/collaborators/{collaborator} | Get a collaborator |
| get_score_collaborators | GET /scores/{score}/collaborators | List the collaborators |
| get_score_comments | GET /scores/{score}/comments | List comments |
| get_score_revision | GET /scores/{score}/revisions/{revision} | Get a score revision |
| get_score_revision_data | GET /scores/{score}/revisions/{revision}/{format} | Get a score revision data |
| get_score_revisions | GET /scores/{score}/revisions | List the revisions |
| get_score_submissions | GET /scores/{score}/submissions | List submissions related to the score |
| get_score_track | GET /scores/{score}/tracks/{track} | Retrieve the details of an audio or video track linked to a score |
| get_user_likes | GET /users/{user}/likes | List liked scores |
| get_user_scores | GET /users/{user}/scores | List user's scores |
| list_score_tracks | GET /scores/{score}/tracks | List the audio or video tracks linked to a score |
| mark_score_comment_resolved | PUT /scores/{score}/comments/{comment}/resolved | Mark the comment as resolved |
| mark_score_comment_unresolved | DELETE /scores/{score}/comments/{comment}/resolved | Mark the comment as unresolved |
| post_score_comment | POST /scores/{score}/comments | Post a new comment |
| remove_score_collaborator | DELETE /scores/{score}/collaborators/{collaborator} | Delete a collaborator |
| untrash_score | POST /scores/{score}/untrash | Untrash a score |
| update_score_comment | PUT /scores/{score}/comments/{comment} | Update an existing comment |
| update_score_track | PUT /scores/{score}/tracks/{track} | Update an audio or video track linked to a score |
ResourceCollaborator add_score_collaborator(score, body)
Add a new collaborator
Share a score with a single user or a group. This API call allows to add, invite and update the collaborators of a resource. - To add an existing Flat user to the resource, specify its unique identifier in the user property. - To invite an external user to the resource, specify its email in the userEmail property. - To add a Flat group to the resource, specify its unique identifier in the group property. - To update an existing collaborator, process the same request with different rights.
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.resource_collaborator import ResourceCollaborator
from flat_api.models.resource_collaborator_creation import ResourceCollaboratorCreation
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
body = flat_api.ResourceCollaboratorCreation() # ResourceCollaboratorCreation |
try:
# Add a new collaborator
api_response = api_instance.add_score_collaborator(score, body)
print("The response of ScoreApi->add_score_collaborator:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->add_score_collaborator: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| body | ResourceCollaboratorCreation |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The newly added collaborator metadata | - |
| 402 | Account overquota | - |
| 403 | Not granted to manage this score | - |
| 404 | Score not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScoreTrack add_score_track(score, body)
Add a new video or audio track to the score
Use this method to add new track to the score. This track can then be played on flat.io or in an embedded score. This API method support medias hosted on SoundCloud, YouTube and Vimeo.
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.score_track import ScoreTrack
from flat_api.models.score_track_creation import ScoreTrackCreation
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
body = flat_api.ScoreTrackCreation() # ScoreTrackCreation |
try:
# Add a new video or audio track to the score
api_response = api_instance.add_score_track(score, body)
print("The response of ScoreApi->add_score_track:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->add_score_track: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| body | ScoreTrackCreation |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Created track | - |
| 403 | Not granted to access to this score | - |
| 404 | Score not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Task create_export_task(score, revision, format, sharing_key=sharing_key, body=body)
Create a new score export task
Some of the exports of a score takes are longer to process than a simple API requests. Use this endpoint to launch a new export of one score hosted on Flat.
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.task import Task
from flat_api.models.task_export_options import TaskExportOptions
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
revision = 'revision_example' # str | Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created.
format = 'format_example' # str | The format of the file that will be generated or the target service name where the file will be exported
sharing_key = 'sharing_key_example' # str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. (optional)
body = flat_api.TaskExportOptions() # TaskExportOptions | (optional)
try:
# Create a new score export task
api_response = api_instance.create_export_task(score, revision, format, sharing_key=sharing_key, body=body)
print("The response of ScoreApi->create_export_task:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->create_export_task: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| revision | str | Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. | |
| format | str | The format of the file that will be generated or the target service name where the file will be exported | |
| sharing_key | str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] |
| body | TaskExportOptions | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Task associated to the generation of the file | - |
| 402 | Account overquota | - |
| 403 | Not granted to access to this score | - |
| 404 | Score or associated file not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScoreDetails create_score(body)
Create a new score
Use this API method to create a new music score in the current User account. This API endpoints provides 3 ways to create scores: * ScoreCreationBuilderData : Create a blank score by providing the list of instruments to use. You can optionally customize the initial key signature, time signature, enable TABs, Chord grids, as well as the page layout. * ScoreCreationFileImport: Import an existing MusicXML 3 file (vnd.recordare.musicxml or vnd.recordare.musicxml+xml), a MIDI file (audio/midi), Guitar Pro (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar, or MuseScore file to create the new Flat document. * ScoreCreationGoogleDriveImport: Import an existing Google Drive file from the connected Google Drive account. This API call will automatically create the first revision of the document, the score can be modified by the using our web application or by uploading a new revision of this file (POST /v2/scores/{score}/revisions/{revision}). The currently authenticated user will be granted owner of the file and will be able to add other collaborators (users and groups). If no collection is specified, the API will create the score in the most appropriate collection. When using an OAuth2 access token or a personal token, the score will be automatically added to your dedicated app collection in the account (/v2/collections/app). If a collection is specified and this one has more public privacy settings than the score (e.g. public vs private for the score), the privacy settings of the created score will be adjusted to the collection ones. You can check the adjusted privacy settings in the returned score privacy, and optionally adjust these settings if needed using PUT /scores/{score}.
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.score_creation import ScoreCreation
from flat_api.models.score_details import ScoreDetails
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
body = flat_api.ScoreCreation() # ScoreCreation |
try:
# Create a new score
api_response = api_instance.create_score(body)
print("The response of ScoreApi->create_score:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->create_score: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| body | ScoreCreation |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Score created | - |
| 400 | Bad score creation request | - |
| 402 | Account overquota | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScoreRevision create_score_revision(score, body)
Create a new revision
Update a score by uploading a new revision for this one.
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.score_revision import ScoreRevision
from flat_api.models.score_revision_creation import ScoreRevisionCreation
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
body = flat_api.ScoreRevisionCreation() # ScoreRevisionCreation |
try:
# Create a new revision
api_response = api_instance.create_score_revision(score, body)
print("The response of ScoreApi->create_score_revision:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->create_score_revision: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| body | ScoreRevisionCreation |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The new created revision metadata | - |
| 402 | Account overquota | - |
| 403 | Not granted to modify this score | - |
| 404 | Score not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_score(score, now=now)
Delete a score
This method can be used by the owner/admin (aclAdmin rights) of a score as well as regular collaborators. When called by an owner/admin, it will schedule the deletion of the score, its revisions, and complete history. The score won't be accessible anymore after calling this method and the user's quota will directly be updated. When called by a regular collaborator (aclRead / aclWrite), the score will be unshared (i.e. removed from the account & own collections).
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
now = False # bool | If `true`, the score deletion will be scheduled to be done ASAP (optional) (default to False)
try:
# Delete a score
api_instance.delete_score(score, now=now)
except Exception as e:
print("Exception when calling ScoreApi->delete_score: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| now | bool | If `true`, the score deletion will be scheduled to be done ASAP | [optional] [default to False] |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | The score has been removed | - |
| 403 | Not granted to manage this score | - |
| 404 | Score not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_score_comment(score, comment, sharing_key=sharing_key)
Delete a comment
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
comment = 'comment_example' # str | Unique identifier of a sheet music comment
sharing_key = 'sharing_key_example' # str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. (optional)
try:
# Delete a comment
api_instance.delete_score_comment(score, comment, sharing_key=sharing_key)
except Exception as e:
print("Exception when calling ScoreApi->delete_score_comment: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| comment | str | Unique identifier of a sheet music comment | |
| sharing_key | str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | The comment has been deleted | - |
| 403 | Not granted to access to this score or not the original comment creator | - |
| 404 | Score or comment not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_score_track(score, track)
Remove an audio or video track linked to the score
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
track = 'track_example' # str | Unique identifier of a score audio track
try:
# Remove an audio or video track linked to the score
api_instance.delete_score_track(score, track)
except Exception as e:
print("Exception when calling ScoreApi->delete_score_track: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| track | str | Unique identifier of a score audio track |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | Track removed | - |
| 403 | Not granted to access to this score | - |
| 404 | Score or Track not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScoreDetails edit_score(score, body)
Edit a score's metadata
This API method allows you to change the metadata of a score document (e.g. its title or privacy), all the properties are optional. To edit the file itself, create a new revision using the appropriate method (POST /v2/scores/{score}/revisions/{revision}). When editing the title, subtitle, composer, lyricist, arranger or licenseText, the metadatas will be instantly be updated, and a real-time action will be pushed to update the document lazily. This pending document modification will be automatically be saved as a new version by either a connected client or our internal versioning service.
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.score_details import ScoreDetails
from flat_api.models.score_modification import ScoreModification
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
body = flat_api.ScoreModification() # ScoreModification |
try:
# Edit a score's metadata
api_response = api_instance.edit_score(score, body)
print("The response of ScoreApi->edit_score:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->edit_score: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| body | ScoreModification |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Score details | - |
| 402 | Account overquota | - |
| 403 | Not granted to access to this score | - |
| 404 | Score not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScoreDetails fork_score(score, body, sharing_key=sharing_key)
Fork a score
This API call will make a copy of the last revision of the specified score and create a new score. The copy of the score will have a privacy set to private. When using a Flat for Education account, the inline and contextualized comments will be accessible in the child document.
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.score_details import ScoreDetails
from flat_api.models.score_fork import ScoreFork
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
body = flat_api.ScoreFork() # ScoreFork |
sharing_key = 'sharing_key_example' # str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. (optional)
try:
# Fork a score
api_response = api_instance.fork_score(score, body, sharing_key=sharing_key)
print("The response of ScoreApi->fork_score:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->fork_score: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| body | ScoreFork | ||
| sharing_key | str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Score details | - |
| 402 | Account overquota | - |
| 403 | Not granted to access to this score | - |
| 404 | Score not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
List[ScoreDetails] get_group_scores(group, parent=parent)
List group's scores
Get the list of scores shared with a group.
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.score_details import ScoreDetails
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
group = 'group_example' # str | Unique identifier of a Flat group
parent = 'parent_example' # str | Filter the score forked from the score id `parent` (optional)
try:
# List group's scores
api_response = api_instance.get_group_scores(group, parent=parent)
print("The response of ScoreApi->get_group_scores:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->get_group_scores: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| group | str | Unique identifier of a Flat group | |
| parent | str | Filter the score forked from the score id `parent` | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The group's scores | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScoreDetails get_score(score, sharing_key=sharing_key)
Get a score's metadata
Get the details of a score identified by the score parameter in the URL. The currently authenticated user must have at least a read access to the document to use this API call.
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.score_details import ScoreDetails
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
sharing_key = 'sharing_key_example' # str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. (optional)
try:
# Get a score's metadata
api_response = api_instance.get_score(score, sharing_key=sharing_key)
print("The response of ScoreApi->get_score:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->get_score: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| sharing_key | str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Score details | - |
| 402 | Account overquota and this document is out of the granted quota | - |
| 403 | Not granted to access to this score | - |
| 404 | Score not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResourceCollaborator get_score_collaborator(score, collaborator, sharing_key=sharing_key)
Get a collaborator
Get the information about a collaborator (User or Group).
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.resource_collaborator import ResourceCollaborator
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
collaborator = 'collaborator_example' # str | Unique identifier of a **collaborator permission**, or unique identifier of a **User**, or unique identifier of a **Group**
sharing_key = 'sharing_key_example' # str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. (optional)
try:
# Get a collaborator
api_response = api_instance.get_score_collaborator(score, collaborator, sharing_key=sharing_key)
print("The response of ScoreApi->get_score_collaborator:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->get_score_collaborator: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| collaborator | str | Unique identifier of a collaborator permission, or unique identifier of a User, or unique identifier of a Group | |
| sharing_key | str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Collaborator information | - |
| 402 | Account overquota | - |
| 403 | Not granted to access to this score | - |
| 404 | Score or collaborator not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
List[ResourceCollaborator] get_score_collaborators(score, sharing_key=sharing_key)
List the collaborators
This API call will list the different collaborators of a score and their rights on the document. The returned list will at least contain the owner of the document. Collaborators can be a single user (the object user will be populated) or a group (the object group will be populated).
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.resource_collaborator import ResourceCollaborator
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
sharing_key = 'sharing_key_example' # str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. (optional)
try:
# List the collaborators
api_response = api_instance.get_score_collaborators(score, sharing_key=sharing_key)
print("The response of ScoreApi->get_score_collaborators:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->get_score_collaborators: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| sharing_key | str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | List of collaborators | - |
| 402 | Account overquota | - |
| 403 | Not granted to access to this score | - |
| 404 | Score not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
List[ScoreComment] get_score_comments(score, sharing_key=sharing_key, type=type, sort=sort, direction=direction)
List comments
This method lists the different comments added on a music score (documents and inline) sorted by their post dates.
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.score_comment import ScoreComment
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
sharing_key = 'sharing_key_example' # str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. (optional)
type = 'type_example' # str | Filter the comments by type (optional)
sort = 'sort_example' # str | Sort (optional)
direction = 'direction_example' # str | Sort direction (optional)
try:
# List comments
api_response = api_instance.get_score_comments(score, sharing_key=sharing_key, type=type, sort=sort, direction=direction)
print("The response of ScoreApi->get_score_comments:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->get_score_comments: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| sharing_key | str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] |
| type | str | Filter the comments by type | [optional] |
| sort | str | Sort | [optional] |
| direction | str | Sort direction | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The comments of the score | - |
| 402 | Account overquota | - |
| 403 | Not granted to access to this score | - |
| 404 | Score not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScoreRevision get_score_revision(score, revision, sharing_key=sharing_key)
Get a score revision
When creating a score or saving a new version of a score, a revision is created in our storage. This method allows you to get a specific revision metadata.
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.score_revision import ScoreRevision
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
revision = 'revision_example' # str | Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created.
sharing_key = 'sharing_key_example' # str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. (optional)
try:
# Get a score revision
api_response = api_instance.get_score_revision(score, revision, sharing_key=sharing_key)
print("The response of ScoreApi->get_score_revision:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->get_score_revision: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| revision | str | Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. | |
| sharing_key | str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Revision metadata | - |
| 402 | Account overquota | - |
| 403 | Not granted to access to this score | - |
| 404 | Score not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
bytearray get_score_revision_data(score, revision, format, sharing_key=sharing_key, parts=parts, default_track=default_track, url=url)
Get a score revision data
Retrieve the file corresponding to a score revision (the following formats are available): Flat JSON/Adagio JSON json, MusicXML mxl/xml, MP3 mp3, WAV wav, MIDI midi, a tumbnail of the first page thumbnail.png or auto sync points synchronizationPoints.
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
revision = 'revision_example' # str | Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created.
format = 'format_example' # str | The format of the file you will retrieve
sharing_key = 'sharing_key_example' # str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. (optional)
parts = 'parts_example' # str | An optional a set of parts uuid to be exported. This parameter must be composed of parts uuids separated by commas. For example \"59df645f-bb1c-f1b4-b573-d2afc4491f94,34ef645f-1aef-f3bc-1564-34cca4492b87\". (optional)
default_track = True # bool | When `format` is `mp3`, this property is set to true and the score has a default `ScoreTrack` (mp3), this one will be returned instead of the playback file. (optional)
url = True # bool | Returns a json with the `url` in it instead of redirecting (optional)
try:
# Get a score revision data
api_response = api_instance.get_score_revision_data(score, revision, format, sharing_key=sharing_key, parts=parts, default_track=default_track, url=url)
print("The response of ScoreApi->get_score_revision_data:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->get_score_revision_data: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| revision | str | Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. | |
| format | str | The format of the file you will retrieve | |
| sharing_key | str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] |
| parts | str | An optional a set of parts uuid to be exported. This parameter must be composed of parts uuids separated by commas. For example "59df645f-bb1c-f1b4-b573-d2afc4491f94,34ef645f-1aef-f3bc-1564-34cca4492b87". | [optional] |
| default_track | bool | When `format` is `mp3`, this property is set to true and the score has a default `ScoreTrack` (mp3), this one will be returned instead of the playback file. | [optional] |
| url | bool | Returns a json with the `url` in it instead of redirecting | [optional] |
bytearray
- Content-Type: Not defined
- Accept: application/json, application/vnd.recordare.musicxml+xml, application/vnd.recordare.musicxml, audio/mp3, audio/wav, audio/midi, image/png
| Status code | Description | Response headers |
|---|---|---|
| 200 | Revision data | - |
| 402 | Account overquota | - |
| 403 | Not granted to access to this score | - |
| 404 | Score or associated file not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
List[ScoreRevision] get_score_revisions(score, sharing_key=sharing_key)
List the revisions
When creating a score or saving a new version of a score, a revision is created in our storage. This method allows you to list all of them, sorted by last modification. Depending the plan of the account, this list can be trunked to the few last revisions.
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.score_revision import ScoreRevision
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
sharing_key = 'sharing_key_example' # str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. (optional)
try:
# List the revisions
api_response = api_instance.get_score_revisions(score, sharing_key=sharing_key)
print("The response of ScoreApi->get_score_revisions:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->get_score_revisions: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| sharing_key | str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | List of revisions | - |
| 402 | Account overquota | - |
| 403 | Not granted to access to this score | - |
| 404 | Score not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
List[AssignmentSubmission] get_score_submissions(score)
List submissions related to the score
This API call will list the different assignments submissions where the score is attached. This method can be used by anyone that are part of the organization and have at least read access to the document.
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.assignment_submission import AssignmentSubmission
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
try:
# List submissions related to the score
api_response = api_instance.get_score_submissions(score)
print("The response of ScoreApi->get_score_submissions:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->get_score_submissions: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | List of submissions | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScoreTrack get_score_track(score, track, sharing_key=sharing_key)
Retrieve the details of an audio or video track linked to a score
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.score_track import ScoreTrack
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
track = 'track_example' # str | Unique identifier of a score audio track
sharing_key = 'sharing_key_example' # str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. (optional)
try:
# Retrieve the details of an audio or video track linked to a score
api_response = api_instance.get_score_track(score, track, sharing_key=sharing_key)
print("The response of ScoreApi->get_score_track:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->get_score_track: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| track | str | Unique identifier of a score audio track | |
| sharing_key | str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Track details | - |
| 403 | Not granted to access to this score | - |
| 404 | Score or Track not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
List[ScoreDetails] get_user_likes(user, next=next, previous=previous, limit=limit, ids=ids)
List liked scores
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.score_details import ScoreDetails
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
user = 'user_example' # str | Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user.
next = 'next_example' # str | An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. (optional)
previous = 'previous_example' # str | An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. (optional)
limit = 25 # int | This is the maximum number of objects that may be returned (optional) (default to 25)
ids = True # bool | Return only the identifiers of the scores (optional)
try:
# List liked scores
api_response = api_instance.get_user_likes(user, next=next, previous=previous, limit=limit, ids=ids)
print("The response of ScoreApi->get_user_likes:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->get_user_likes: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| user | str | Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user. | |
| next | str | An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. | [optional] |
| previous | str | An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. | [optional] |
| limit | int | This is the maximum number of objects that may be returned | [optional] [default to 25] |
| ids | bool | Return only the identifiers of the scores | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | List of liked scores | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
List[ScoreDetails] get_user_scores(user, parent=parent)
List user's scores
Get the list of public scores owned by a User. DEPRECATED: Please note that the current behavior will be deprecrated on 2019-01-01. This method will no longer list private and shared scores, but only public scores of a Flat account. If you want to access to private scores, please use the Collections API instead.
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.score_details import ScoreDetails
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
user = 'user_example' # str | Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user.
parent = 'parent_example' # str | Filter the score forked from the score id `parent` (optional)
try:
# List user's scores
api_response = api_instance.get_user_scores(user, parent=parent)
print("The response of ScoreApi->get_user_scores:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->get_user_scores: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| user | str | Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user. | |
| parent | str | Filter the score forked from the score id `parent` | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The user scores | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
List[ScoreTrack] list_score_tracks(score, sharing_key=sharing_key, assignment=assignment, list_auto_track=list_auto_track)
List the audio or video tracks linked to a score
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.score_track import ScoreTrack
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
sharing_key = 'sharing_key_example' # str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. (optional)
assignment = 'assignment_example' # str | An assignment id with which all the tracks returned will be related to (optional)
list_auto_track = True # bool | If true, and if available, return last automatically synchronized Flat's mp3 export as an additional track (optional)
try:
# List the audio or video tracks linked to a score
api_response = api_instance.list_score_tracks(score, sharing_key=sharing_key, assignment=assignment, list_auto_track=list_auto_track)
print("The response of ScoreApi->list_score_tracks:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->list_score_tracks: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| sharing_key | str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] |
| assignment | str | An assignment id with which all the tracks returned will be related to | [optional] |
| list_auto_track | bool | If true, and if available, return last automatically synchronized Flat's mp3 export as an additional track | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | List of tracks | - |
| 403 | Not granted to access to this score | - |
| 404 | Score not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
mark_score_comment_resolved(score, comment, sharing_key=sharing_key)
Mark the comment as resolved
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
comment = 'comment_example' # str | Unique identifier of a sheet music comment
sharing_key = 'sharing_key_example' # str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. (optional)
try:
# Mark the comment as resolved
api_instance.mark_score_comment_resolved(score, comment, sharing_key=sharing_key)
except Exception as e:
print("Exception when calling ScoreApi->mark_score_comment_resolved: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| comment | str | Unique identifier of a sheet music comment | |
| sharing_key | str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | The comment has been marked as resolved | - |
| 403 | Not granted to mark this comment as resolved | - |
| 404 | Score or comment not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
mark_score_comment_unresolved(score, comment, sharing_key=sharing_key)
Mark the comment as unresolved
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
comment = 'comment_example' # str | Unique identifier of a sheet music comment
sharing_key = 'sharing_key_example' # str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. (optional)
try:
# Mark the comment as unresolved
api_instance.mark_score_comment_unresolved(score, comment, sharing_key=sharing_key)
except Exception as e:
print("Exception when calling ScoreApi->mark_score_comment_unresolved: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| comment | str | Unique identifier of a sheet music comment | |
| sharing_key | str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | The comment has been unmarked as resolved | - |
| 403 | Not granted to unmark this comment as resolved | - |
| 404 | Score or comment not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScoreComment post_score_comment(score, body, sharing_key=sharing_key)
Post a new comment
Post a document or a contextualized comment on a document. Please note that this method includes an anti-spam system for public scores. We don't guarantee that your comments will be accepted and displayed to end-user. Comments are be blocked by returning a 403 HTTP error and hidden from other users when the spam property is true.
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.score_comment import ScoreComment
from flat_api.models.score_comment_creation import ScoreCommentCreation
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
body = flat_api.ScoreCommentCreation() # ScoreCommentCreation |
sharing_key = 'sharing_key_example' # str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. (optional)
try:
# Post a new comment
api_response = api_instance.post_score_comment(score, body, sharing_key=sharing_key)
print("The response of ScoreApi->post_score_comment:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->post_score_comment: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| body | ScoreCommentCreation | ||
| sharing_key | str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The new comment | - |
| 402 | Account overquota | - |
| 403 | Not granted to access to this score, to post a comment, or your API call triggered our spam filter. | - |
| 404 | Score not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
remove_score_collaborator(score, collaborator)
Delete a collaborator
Remove the specified collaborator from the score
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
collaborator = 'collaborator_example' # str | Unique identifier of a **collaborator permission**, or unique identifier of a **User**, or unique identifier of a **Group**
try:
# Delete a collaborator
api_instance.remove_score_collaborator(score, collaborator)
except Exception as e:
print("Exception when calling ScoreApi->remove_score_collaborator: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| collaborator | str | Unique identifier of a collaborator permission, or unique identifier of a User, or unique identifier of a Group |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | The collaborator has been removed | - |
| 403 | Not granted to manage this score | - |
| 404 | Score or collaborator not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
untrash_score(score)
Untrash a score
This method will remove the score from the trash collection and from the deletion queue, and add it back to the original collections.
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
try:
# Untrash a score
api_instance.untrash_score(score)
except Exception as e:
print("Exception when calling ScoreApi->untrash_score: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | The score has been untrashed | - |
| 403 | Not granted to manage this score | - |
| 404 | Score not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScoreComment update_score_comment(score, comment, body, sharing_key=sharing_key)
Update an existing comment
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.score_comment import ScoreComment
from flat_api.models.score_comment_update import ScoreCommentUpdate
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
comment = 'comment_example' # str | Unique identifier of a sheet music comment
body = flat_api.ScoreCommentUpdate() # ScoreCommentUpdate |
sharing_key = 'sharing_key_example' # str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. (optional)
try:
# Update an existing comment
api_response = api_instance.update_score_comment(score, comment, body, sharing_key=sharing_key)
print("The response of ScoreApi->update_score_comment:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->update_score_comment: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| comment | str | Unique identifier of a sheet music comment | |
| body | ScoreCommentUpdate | ||
| sharing_key | str | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The edited comment | - |
| 402 | Account overquota | - |
| 403 | Not granted to access to this score or not the original comment creator | - |
| 404 | Score not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScoreTrack update_score_track(score, track, body)
Update an audio or video track linked to a score
- OAuth Authentication (OAuth2):
import flat_api
from flat_api.models.score_track import ScoreTrack
from flat_api.models.score_track_update import ScoreTrackUpdate
from flat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.flat.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = flat_api.Configuration(
host = "https://api.flat.io/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = flat_api.ScoreApi(api_client)
score = 'score_example' # str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
track = 'track_example' # str | Unique identifier of a score audio track
body = flat_api.ScoreTrackUpdate() # ScoreTrackUpdate |
try:
# Update an audio or video track linked to a score
api_response = api_instance.update_score_track(score, track, body)
print("The response of ScoreApi->update_score_track:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScoreApi->update_score_track: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| score | str | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). | |
| track | str | Unique identifier of a score audio track | |
| body | ScoreTrackUpdate |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Updated track | - |
| 403 | Not granted to access to this score | - |
| 404 | Score or Track not found | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]