# FlatApi.ScoreApi All URIs are relative to *https://api.flat.io/v2* Method | HTTP request | Description ------------- | ------------- | ------------- [**addScoreCollaborator**](ScoreApi.md#addScoreCollaborator) | **POST** /scores/{score}/collaborators | Add a new collaborator [**addScoreTrack**](ScoreApi.md#addScoreTrack) | **POST** /scores/{score}/tracks | Add a new video or audio track to the score [**createScore**](ScoreApi.md#createScore) | **POST** /scores | Create a new score [**createScoreRevision**](ScoreApi.md#createScoreRevision) | **POST** /scores/{score}/revisions | Create a new revision [**deleteScore**](ScoreApi.md#deleteScore) | **DELETE** /scores/{score} | Delete a score [**deleteScoreComment**](ScoreApi.md#deleteScoreComment) | **DELETE** /scores/{score}/comments/{comment} | Delete a comment [**deleteScoreTrack**](ScoreApi.md#deleteScoreTrack) | **DELETE** /scores/{score}/tracks/{track} | Remove an audio or video track linked to the score [**editScore**](ScoreApi.md#editScore) | **PUT** /scores/{score} | Edit a score's metadata [**forkScore**](ScoreApi.md#forkScore) | **POST** /scores/{score}/fork | Fork a score [**gerUserLikes**](ScoreApi.md#gerUserLikes) | **GET** /users/{user}/likes | List liked scores [**getGroupScores**](ScoreApi.md#getGroupScores) | **GET** /groups/{group}/scores | List group's scores [**getScore**](ScoreApi.md#getScore) | **GET** /scores/{score} | Get a score's metadata [**getScoreCollaborator**](ScoreApi.md#getScoreCollaborator) | **GET** /scores/{score}/collaborators/{collaborator} | Get a collaborator [**getScoreCollaborators**](ScoreApi.md#getScoreCollaborators) | **GET** /scores/{score}/collaborators | List the collaborators [**getScoreComments**](ScoreApi.md#getScoreComments) | **GET** /scores/{score}/comments | List comments [**getScoreRevision**](ScoreApi.md#getScoreRevision) | **GET** /scores/{score}/revisions/{revision} | Get a score revision [**getScoreRevisionData**](ScoreApi.md#getScoreRevisionData) | **GET** /scores/{score}/revisions/{revision}/{format} | Get a score revision data [**getScoreRevisions**](ScoreApi.md#getScoreRevisions) | **GET** /scores/{score}/revisions | List the revisions [**getScoreSubmissions**](ScoreApi.md#getScoreSubmissions) | **GET** /scores/{score}/submissions | List submissions related to the score [**getScoreTrack**](ScoreApi.md#getScoreTrack) | **GET** /scores/{score}/tracks/{track} | Retrieve the details of an audio or video track linked to a score [**getUserScores**](ScoreApi.md#getUserScores) | **GET** /users/{user}/scores | List user's scores [**listScoreTracks**](ScoreApi.md#listScoreTracks) | **GET** /scores/{score}/tracks | List the audio or video tracks linked to a score [**markScoreCommentResolved**](ScoreApi.md#markScoreCommentResolved) | **PUT** /scores/{score}/comments/{comment}/resolved | Mark the comment as resolved [**markScoreCommentUnresolved**](ScoreApi.md#markScoreCommentUnresolved) | **DELETE** /scores/{score}/comments/{comment}/resolved | Mark the comment as unresolved [**postScoreComment**](ScoreApi.md#postScoreComment) | **POST** /scores/{score}/comments | Post a new comment [**removeScoreCollaborator**](ScoreApi.md#removeScoreCollaborator) | **DELETE** /scores/{score}/collaborators/{collaborator} | Delete a collaborator [**untrashScore**](ScoreApi.md#untrashScore) | **POST** /scores/{score}/untrash | Untrash a score [**updateScoreComment**](ScoreApi.md#updateScoreComment) | **PUT** /scores/{score}/comments/{comment} | Update an existing comment [**updateScoreTrack**](ScoreApi.md#updateScoreTrack) | **PUT** /scores/{score}/tracks/{track} | Update an audio or video track linked to a score # **addScoreCollaborator** > ResourceCollaborator addScoreCollaborator(scorebody) 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. ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var body = new FlatApi.ResourceCollaboratorCreation(); // ResourceCollaboratorCreation | var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.addScoreCollaborator(scorebody, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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**](ResourceCollaboratorCreation.md)| | ### Return type [**ResourceCollaborator**](ResourceCollaborator.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **addScoreTrack** > ScoreTrack addScoreTrack(scorebody) 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. ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var body = new FlatApi.ScoreTrackCreation(); // ScoreTrackCreation | var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.addScoreTrack(scorebody, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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**](ScoreTrackCreation.md)| | ### Return type [**ScoreTrack**](ScoreTrack.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **createScore** > ScoreDetails createScore(body) Create a new score Use this API method to **create a new music score in the current User account**. You will need a MusicXML 3 (`vnd.recordare.musicxml` or `vnd.recordare.musicxml+xml`) or a MIDI (`audio/midi`) file to create the new Flat document. 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. This can be the `root` collection or a different collection based on the user's settings or API authentication method. 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}`. ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var body = new FlatApi.ScoreCreation(); // ScoreCreation | var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.createScore(body, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**ScoreCreation**](ScoreCreation.md)| | ### Return type [**ScoreDetails**](ScoreDetails.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **createScoreRevision** > ScoreRevision createScoreRevision(scorebody) Create a new revision Update a score by uploading a new revision for this one. ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var body = new FlatApi.ScoreRevisionCreation(); // ScoreRevisionCreation | var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.createScoreRevision(scorebody, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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**](ScoreRevisionCreation.md)| | ### Return type [**ScoreRevision**](ScoreRevision.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **deleteScore** > deleteScore(score) 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). ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.deleteScore(score, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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`). | ### Return type null (empty response body) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **deleteScoreComment** > deleteScoreComment(scorecomment, opts) Delete a comment ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var comment = "comment_example"; // String | Unique identifier of a sheet music comment var opts = { 'sharingKey': "sharingKey_example" // String | 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. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.deleteScoreComment(scorecomment, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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** | **String**| Unique identifier of a sheet music comment | **sharingKey** | **String**| 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] ### Return type null (empty response body) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **deleteScoreTrack** > deleteScoreTrack(scoretrack) Remove an audio or video track linked to the score ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var track = "track_example"; // String | Unique identifier of a score audio track var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.deleteScoreTrack(scoretrack, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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** | **String**| Unique identifier of a score audio track | ### Return type null (empty response body) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **editScore** > ScoreDetails editScore(score, opts) 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` of the score, the API metadata are updated directly when calling this method, unlike the data itself. The title in the score data will be \"lazy\" updated at the next score save with the editor or our internal save. ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var opts = { 'body': new FlatApi.ScoreModification() // ScoreModification | }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.editScore(score, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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**](ScoreModification.md)| | [optional] ### Return type [**ScoreDetails**](ScoreDetails.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **forkScore** > ScoreDetails forkScore(scorebody, opts) 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](https://flat.io/edu) account, the inline and contextualized comments will be accessible in the child document. ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var body = new FlatApi.ScoreFork(); // ScoreFork | var opts = { 'sharingKey': "sharingKey_example" // String | 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. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.forkScore(scorebody, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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**](ScoreFork.md)| | **sharingKey** | **String**| 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] ### Return type [**ScoreDetails**](ScoreDetails.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **gerUserLikes** > [ScoreDetails] gerUserLikes(user, opts) List liked scores ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var user = "user_example"; // String | Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user. var opts = { 'ids': true // Boolean | Return only the identifiers of the scores }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.gerUserLikes(user, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user** | **String**| Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user. | **ids** | **Boolean**| Return only the identifiers of the scores | [optional] ### Return type [**[ScoreDetails]**](ScoreDetails.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **getGroupScores** > [ScoreDetails] getGroupScores(group, opts) List group's scores Get the list of scores shared with a group. ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var group = "group_example"; // String | Unique identifier of a Flat group var opts = { 'parent': "parent_example" // String | Filter the score forked from the score id `parent` }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getGroupScores(group, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **group** | **String**| Unique identifier of a Flat group | **parent** | **String**| Filter the score forked from the score id `parent` | [optional] ### Return type [**[ScoreDetails]**](ScoreDetails.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **getScore** > ScoreDetails getScore(score, opts) 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. ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var opts = { 'sharingKey': "sharingKey_example" // String | 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. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getScore(score, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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`). | **sharingKey** | **String**| 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] ### Return type [**ScoreDetails**](ScoreDetails.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **getScoreCollaborator** > ResourceCollaborator getScoreCollaborator(scorecollaborator, opts) Get a collaborator Get the information about a collaborator (User or Group). ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var collaborator = "collaborator_example"; // String | Unique identifier of a **collaborator permission**, or unique identifier of a **User**, or unique identifier of a **Group** var opts = { 'sharingKey': "sharingKey_example" // String | 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. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getScoreCollaborator(scorecollaborator, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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** | **String**| Unique identifier of a **collaborator permission**, or unique identifier of a **User**, or unique identifier of a **Group** | **sharingKey** | **String**| 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] ### Return type [**ResourceCollaborator**](ResourceCollaborator.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **getScoreCollaborators** > [ResourceCollaborator] getScoreCollaborators(score, opts) 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). ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var opts = { 'sharingKey': "sharingKey_example" // String | 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. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getScoreCollaborators(score, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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`). | **sharingKey** | **String**| 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] ### Return type [**[ResourceCollaborator]**](ResourceCollaborator.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **getScoreComments** > [ScoreComment] getScoreComments(score, opts) List comments This method lists the different comments added on a music score (documents and inline) sorted by their post dates. ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var opts = { 'sharingKey': "sharingKey_example" // String | 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. 'type': "type_example", // String | Filter the comments by type 'sort': "sort_example", // String | Sort 'direction': "direction_example", // String | Sort direction }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getScoreComments(score, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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`). | **sharingKey** | **String**| 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** | **String**| Filter the comments by type | [optional] **sort** | **String**| Sort | [optional] **direction** | **String**| Sort direction | [optional] ### Return type [**[ScoreComment]**](ScoreComment.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **getScoreRevision** > ScoreRevision getScoreRevision(scorerevision, , opts) 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. ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var revision = "revision_example"; // String | Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. var opts = { 'sharingKey': "sharingKey_example" // String | 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. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getScoreRevision(scorerevision, , opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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** | **String**| Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. | **sharingKey** | **String**| 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] ### Return type [**ScoreRevision**](ScoreRevision.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **getScoreRevisionData** > 'Blob' getScoreRevisionData(scorerevision, format, opts) 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`, or a tumbnail of the first page `thumbnail.png`). ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var revision = "revision_example"; // String | Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. var format = "format_example"; // String | The format of the file you will retrieve var opts = { 'sharingKey': "sharingKey_example" // String | 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. 'parts': "parts_example", // String | An optional a set of parts to be exported. This parameter must be specified with a list of integers. For example \"1,2,5\". 'onlyCached': true // Boolean | Only return files already generated and cached in Flat's production cache. If the file is not availabe, a 404 will be returned }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getScoreRevisionData(scorerevision, format, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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** | **String**| Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. | **format** | **String**| The format of the file you will retrieve | **sharingKey** | **String**| 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** | **String**| An optional a set of parts to be exported. This parameter must be specified with a list of integers. For example \"1,2,5\". | [optional] **onlyCached** | **Boolean**| Only return files already generated and cached in Flat's production cache. If the file is not availabe, a 404 will be returned | [optional] ### Return type **'Blob'** ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json, application/vnd.recordare.musicxml+xml, application/vnd.recordare.musicxml, audio/mp3, audio/wav, audio/midi, image/png # **getScoreRevisions** > [ScoreRevision] getScoreRevisions(score, opts) 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. ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var opts = { 'sharingKey': "sharingKey_example" // String | 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. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getScoreRevisions(score, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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`). | **sharingKey** | **String**| 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] ### Return type [**[ScoreRevision]**](ScoreRevision.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **getScoreSubmissions** > [AssignmentSubmission] getScoreSubmissions(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. ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getScoreSubmissions(score, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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`). | ### Return type [**[AssignmentSubmission]**](AssignmentSubmission.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **getScoreTrack** > ScoreTrack getScoreTrack(scoretrack, opts) Retrieve the details of an audio or video track linked to a score ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var track = "track_example"; // String | Unique identifier of a score audio track var opts = { 'sharingKey': "sharingKey_example" // String | 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. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getScoreTrack(scoretrack, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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** | **String**| Unique identifier of a score audio track | **sharingKey** | **String**| 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] ### Return type [**ScoreTrack**](ScoreTrack.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **getUserScores** > [ScoreDetails] getUserScores(user, opts) 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](#tag/Collection) instead. ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var user = "user_example"; // String | Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user. var opts = { 'parent': "parent_example" // String | Filter the score forked from the score id `parent` }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getUserScores(user, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user** | **String**| Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user. | **parent** | **String**| Filter the score forked from the score id `parent` | [optional] ### Return type [**[ScoreDetails]**](ScoreDetails.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **listScoreTracks** > [ScoreTrack] listScoreTracks(score, opts) List the audio or video tracks linked to a score ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var opts = { 'sharingKey': "sharingKey_example" // String | 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. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.listScoreTracks(score, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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`). | **sharingKey** | **String**| 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] ### Return type [**[ScoreTrack]**](ScoreTrack.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **markScoreCommentResolved** > markScoreCommentResolved(scorecomment, opts) Mark the comment as resolved ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var comment = "comment_example"; // String | Unique identifier of a sheet music comment var opts = { 'sharingKey': "sharingKey_example" // String | 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. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.markScoreCommentResolved(scorecomment, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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** | **String**| Unique identifier of a sheet music comment | **sharingKey** | **String**| 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] ### Return type null (empty response body) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **markScoreCommentUnresolved** > markScoreCommentUnresolved(scorecomment, opts) Mark the comment as unresolved ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var comment = "comment_example"; // String | Unique identifier of a sheet music comment var opts = { 'sharingKey': "sharingKey_example" // String | 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. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.markScoreCommentUnresolved(scorecomment, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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** | **String**| Unique identifier of a sheet music comment | **sharingKey** | **String**| 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] ### Return type null (empty response body) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **postScoreComment** > ScoreComment postScoreComment(scorebody, opts) 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`. ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var body = new FlatApi.ScoreCommentCreation(); // ScoreCommentCreation | var opts = { 'sharingKey': "sharingKey_example" // String | 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. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.postScoreComment(scorebody, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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**](ScoreCommentCreation.md)| | **sharingKey** | **String**| 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] ### Return type [**ScoreComment**](ScoreComment.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **removeScoreCollaborator** > removeScoreCollaborator(scorecollaborator) Delete a collaborator Remove the specified collaborator from the score ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var collaborator = "collaborator_example"; // String | Unique identifier of a **collaborator permission**, or unique identifier of a **User**, or unique identifier of a **Group** var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.removeScoreCollaborator(scorecollaborator, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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** | **String**| Unique identifier of a **collaborator permission**, or unique identifier of a **User**, or unique identifier of a **Group** | ### Return type null (empty response body) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **untrashScore** > untrashScore(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. ### Example ```javascript var FlatApi = require('flat-api'); var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.untrashScore(score, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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`). | ### Return type null (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **updateScoreComment** > ScoreComment updateScoreComment(scorecommentbody, opts) Update an existing comment ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var comment = "comment_example"; // String | Unique identifier of a sheet music comment var body = new FlatApi.ScoreCommentUpdate(); // ScoreCommentUpdate | var opts = { 'sharingKey': "sharingKey_example" // String | 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. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.updateScoreComment(scorecommentbody, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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** | **String**| Unique identifier of a sheet music comment | **body** | [**ScoreCommentUpdate**](ScoreCommentUpdate.md)| | **sharingKey** | **String**| 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] ### Return type [**ScoreComment**](ScoreComment.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **updateScoreTrack** > ScoreTrack updateScoreTrack(scoretrackbody) Update an audio or video track linked to a score ### Example ```javascript var FlatApi = require('flat-api'); var defaultClient = FlatApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 var OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new FlatApi.ScoreApi(); var score = "score_example"; // String | 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`). var track = "track_example"; // String | Unique identifier of a score audio track var body = new FlatApi.ScoreTrackUpdate(); // ScoreTrackUpdate | var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.updateScoreTrack(scoretrackbody, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **score** | **String**| 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** | **String**| Unique identifier of a score audio track | **body** | [**ScoreTrackUpdate**](ScoreTrackUpdate.md)| | ### Return type [**ScoreTrack**](ScoreTrack.md) ### Authorization [OAuth2](../README.md#OAuth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json