643 matches
79 actions
Flat
79 actions
- Activate the classPOSTv1.0.0
- Add a feedback comment to a submissionPOSTv1.0.0
- Add a new collaboratorPOSTv1.0.0
- Add a new video or audio track to the scorePOSTv1.0.0
- Add a score to the collectionPUTv1.0.0
- Add a user to the classPUTv1.0.0
- Archive the assignmentPOSTv1.0.0
- Archive the classPOSTv1.0.0
- Assignment creationPOSTv1.0.0
- Assignments listingGETv1.0.0
- Copy an assignmentPOSTv1.0.0
- Count the organization users using the provided filtersGETv1.0.0
- Create a new classPOSTv1.0.0
- Create a new collectionPOSTv1.0.0
- Create a new couple of LTI 1.x credentialsPOSTv1.0.0
- Create a new invitation to join the organizationPOSTv1.0.0
- Create a new revisionPOSTv1.0.0
- Create a new scorePOSTv1.0.0
- Create a new user accountPOSTv1.0.0
- Create or edit a submissionPUTv1.0.0
- Delete a collaboratorDELETEv1.0.0
- Delete a commentDELETEv1.0.0
- Delete a feedback comment to a submissionDELETEv1.0.0
- Delete a scoreDELETEv1.0.0
- Delete a score from the collectionDELETEv1.0.0
- Delete a submissionDELETEv1.0.0
- Delete the collectionDELETEv1.0.0
- Edit a score's metadataPUTv1.0.0
- Edit a submissionPUTv1.0.0
- Fork a scorePOSTv1.0.0
- Get a collaboratorGETv1.0.0
- Get a public user profileGETv1.0.0
- Get a score revisionGETv1.0.0
- Get a score revision dataGETv1.0.0
- Get a score's metadataGETv1.0.0
- Get a student submissionGETv1.0.0
- Get collection detailsGETv1.0.0
- Get current user profileGETv1.0.0
- Get group informationGETv1.0.0
- Get the details of a single classGETv1.0.0
- Get the history of the submissionGETv1.0.0
- Join a classPOSTv1.0.0
- List commentsGETv1.0.0
- List group's scoresGETv1.0.0
- List group's usersGETv1.0.0
- List liked scoresGETv1.0.0
- List LTI 1.x credentialsGETv1.0.0
- List submissions related to the scoreGETv1.0.0
- List the audio or video tracks linked to a scoreGETv1.0.0
- List the classes available for the current userGETv1.0.0
- List the collaboratorsGETv1.0.0
- List the collectionsGETv1.0.0
- List the feedback comments of a submissionGETv1.0.0
- List the organization invitationsGETv1.0.0
- List the organization usersGETv1.0.0
- List the revisionsGETv1.0.0
- List the scores contained in a collectionGETv1.0.0
- List the students' submissionsGETv1.0.0
- List the submissions for a studentGETv1.0.0
- List user's scoresGETv1.0.0
- Mark the comment as resolvedPUTv1.0.0
- Mark the comment as unresolvedDELETEv1.0.0
- Post a new commentPOSTv1.0.0
- Remove a user from the classDELETEv1.0.0
- Remove an account from FlatDELETEv1.0.0
- Remove an audio or video track linked to the scoreDELETEv1.0.0
- Remove an organization invitationDELETEv1.0.0
- Retrieve the details of an audio or video track linked to a scoreGETv1.0.0
- Revoke LTI 1.x credentialsDELETEv1.0.0
- Unarchive the assignment.DELETEv1.0.0
- Unarchive the classDELETEv1.0.0
- Untrash a collectionPOSTv1.0.0
- Untrash a scorePOSTv1.0.0
- Update a collection's metadataPUTv1.0.0
- Update a feedback comment to a submissionPUTv1.0.0
- Update account informationPUTv1.0.0
- Update an audio or video track linked to a scorePUTv1.0.0
- Update an existing commentPUTv1.0.0
- Update the classPUTv1.0.0
Other/Flat
Update an existing comment
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
{
"type": "object",
"description": "Update of a comment",
"properties": {
"comment": {
"type": "string",
"description": "The comment text that can includes mentions using the following format: `@[id:username]`.\n"
},
"context": {
"type": "object",
"description": "The context of the comment (for inline/contextualized comments). A context will include all the information related to the location of the comment (i.e. score parts, range of measure, time position).\n",
"required": [
"measureUuids",
"partUuid",
"startDpq",
"startTimePos",
"stopDpq",
"stopTimePos"
],
"properties": {
"measureUuids": {
"type": "array",
"description": "The list of measure UUIds",
"items": {
"type": "string"
}
},
"partUuid": {
"type": "string",
"description": "The unique identifier (UUID) of the score part"
},
"staffIdx": {
"type": "number",
"description": "(Deprecated, use `staffUuid`) The identififer of the staff"
},
"staffUuid": {
"type": "string",
"description": "The unique identififer (UUID) of the staff"
},
"startDpq": {
"type": "number"
},
"startTimePos": {
"type": "number"
},
"stopDpq": {
"type": "number"
},
"stopTimePos": {
"type": "number"
}
}
},
"rawComment": {
"type": "string",
"description": "A raw version of the comment, that can be displayed without the mentions. If you use mentions, this property must be set.\n"
},
"revision": {
"type": "string",
"description": "The unique indentifier of the revision of the score where the comment was added. If this property is unspecified or contains \"last\", the API will automatically take the last revision created.\n"
}
}
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
{
"type": "object",
"description": "Comment added on a sheet music",
"properties": {
"comment": {
"type": "string",
"description": "The comment text that can includes mentions using the following\nformat: `@[id:username]`.\n"
},
"context": {
"type": "object",
"description": "The context of the comment (for inline/contextualized comments). A context will include all the information related to the location of the comment (i.e. score parts, range of measure, time position).\n",
"required": [
"measureUuids",
"partUuid",
"startDpq",
"startTimePos",
"stopDpq",
"stopTimePos"
],
"properties": {
"measureUuids": {
"type": "array",
"description": "The list of measure UUIds",
"items": {
"type": "string"
}
},
"partUuid": {
"type": "string",
"description": "The unique identifier (UUID) of the score part"
},
"staffIdx": {
"type": "number",
"description": "(Deprecated, use `staffUuid`) The identififer of the staff"
},
"staffUuid": {
"type": "string",
"description": "The unique identififer (UUID) of the staff"
},
"startDpq": {
"type": "number"
},
"startTimePos": {
"type": "number"
},
"stopDpq": {
"type": "number"
},
"stopTimePos": {
"type": "number"
}
}
},
"date": {
"type": "string",
"format": "date-time",
"description": "The date when the comment was posted"
},
"id": {
"type": "string",
"description": "The comment unique identifier"
},
"mentions": {
"type": "array",
"description": "The list of user identifier mentioned on the score",
"items": {
"type": "string"
}
},
"modificationDate": {
"type": "string",
"format": "date-time",
"description": "The date of the last comment modification"
},
"rawComment": {
"type": "string",
"description": "A raw version of the comment, that can be displayed without parsing\nthe mentions.\n"
},
"replyTo": {
"type": "string",
"description": "When the comment is a reply to another comment, the unique identifier of the parent comment\n"
},
"resolved": {
"type": "boolean",
"description": "For inline comments, the comment can be marked as resolved and will be hidden in the future responses\n"
},
"resolvedBy": {
"type": "string",
"description": "If the user is marked as resolved, this will contain the unique identifier of the User who marked this comment as resolved\n"
},
"revision": {
"type": "string",
"description": "The unique identifier of revision the comment was posted"
},
"score": {
"type": "string",
"description": "The unique identifier of the score where the comment was posted"
},
"spam": {
"type": "boolean",
"description": "`true if the message has been detected as spam and hidden from other users\n"
},
"type": {
"type": "string",
"description": "The type of the comment",
"enum": [
"document",
"inline"
]
},
"user": {
"type": "string",
"description": "The author unique identifier"
}
}
}