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 a collection's metadata
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
{
"type": "object",
"description": "Edit the collection metadata",
"properties": {
"privacy": {
"type": "string",
"description": "The collection main privacy mode.\n- `private`: The collection is private and can be only accessed, modified and administred by specified collaborators users.\n",
"enum": [
"private"
]
},
"title": {
"type": "string",
"description": "The title of the collection"
}
}
}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
- 117
{
"type": "object",
"description": "Collection of scores",
"properties": {
"app": {
"type": "string",
"description": "If this directory is dedicated to an app, the unique idenfier of this app"
},
"capabilities": {
"type": "object",
"description": "Capabilities the current user has on this collection. Each capability corresponds to a fine-grained action that a user may take.",
"properties": {
"canAddScores": {
"type": "boolean",
"description": "Whether the current user can add scores to the collection\n\nIf this collection has the `type` `trash`, this property will be set to `false`. Use `DELETE /v2/scores/{score}` to trash a score.\n"
},
"canDelete": {
"type": "boolean",
"description": "Whether the current user can delete the collection\n"
},
"canDeleteScores": {
"type": "boolean",
"description": "Whether the current user can delete scores from the collection\n\nIf this collection has the `type` `trash`, this property will be set to `false`. Use `POST /v2/scores/{score}/untrash` to restore a score.\n"
},
"canEdit": {
"type": "boolean",
"description": "Whether the current user can modify the metadata for the collection\n"
},
"canShare": {
"type": "boolean",
"description": "Whether the current user can modify the sharing settings for the collection\n"
}
}
},
"collaborators": {
"type": "array",
"description": "The list of the collaborators of the collection",
"items": {
"description": "A collaborator of a score. The `userEmail` and `group` are only available if the requesting user is a collaborator of the related score (in this case these permissions will eventualy not be listed and exposed publicly).\n",
"type": "object"
}
},
"collections": {
"type": "array",
"description": "The List of parent collections, which includes all the collections this score is included. Please note that you might not have access to all of them.",
"items": {
"type": "string"
}
},
"creationDate": {
"type": "string",
"format": "date-time",
"description": "The date when the collection was created"
},
"htmlUrl": {
"type": "string",
"format": "url",
"description": "The url where the collection can be viewed in a web browser"
},
"id": {
"type": "string",
"description": "Unique identifier of the collection"
},
"privacy": {
"type": "string",
"description": "The collection main privacy mode.\n- `private`: The collection is private and can be only accessed, modified and administred by specified collaborators users.\n",
"enum": [
"private"
]
},
"rights": {
"type": "object",
"description": "The rights of the current user on a score or collection",
"properties": {
"aclAdmin": {
"type": "boolean",
"description": "`True` if the current user can manage the current document (i.e. share, delete)\n\nIf this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection.\n"
},
"aclRead": {
"type": "boolean",
"description": "`True` if the current user can read the current document\n"
},
"aclWrite": {
"type": "boolean",
"description": "`True` if the current user can modify the current document.\n\nIf this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection.\n"
},
"isCollaborator": {
"type": "boolean",
"description": "`True` if the current user is a collaborator of the current document (direct or via group).\n"
}
}
},
"sharingKey": {
"type": "string",
"description": "The private sharing key of the collection (available when the `privacy` mode is set to `privateLink`)"
},
"title": {
"type": "string",
"description": "The title of the collection"
},
"type": {
"type": "string",
"description": "Type of the collection.\nThe type will influence the capabilitied available on the collections and how this collection is/can be populated.\n",
"enum": [
"root",
"regular",
"sharedWithMe",
"sharedWithGroup",
"trash"
]
},
"user": {
"description": "Public User details summary",
"type": "object"
}
}
}