{ "uuid": "7b8b9be2-4c4c-4701-be10-9c1a63ae6996", "lastMigration": 29, "name": "Flat API", "endpointPrefix": "v2", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "a19138e4-86b9-410e-a9e8-fc0ce14ace52", "documentation": "List the classes available for the current user", "method": "get", "endpoint": "classes", "responses": [ { "uuid": "eb5bc725-29ea-4b1c-8618-de319c715c87", "body": "[\n {\n \"assignmentsCount\": 10,\n \"canvas\": {\n \"id\": \"000000000\"\n },\n \"creationTime\": \"2017-01-25T09:47:34.544000Z\",\n \"enrollmentCode\": \"jm447ear\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory\",\n \"id\": \"00000000\"\n },\n \"googleDrive\": {\n \"teacherFolderAlternateLink\": \"https://drive.google.com/drive/folders/0B-0000000000000000\",\n \"teacherFolderId\": \"0B-0000000000000000\"\n },\n \"id\": \"100000000000000000000001\",\n \"lti\": {\n \"contextId\": \"042\",\n \"contextLabel\": \"MUSIC\",\n \"contextTitle\": \"Music Theory 101\"\n },\n \"microsoftGraph\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n },\n \"name\": \"Music Theory 101\",\n \"organization\": \"100000000000000000000002\",\n \"owner\": \"100000000000000000000003\",\n \"section\": \"Music Theory 101\",\n \"state\": \"active\",\n \"theme\": \"blue-8\"\n }\n]", "latency": 0, "statusCode": 200, "label": "The list of classes", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c9602e00-8149-4d83-b1ec-c0778c84b0d7", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2258897b-ce3d-4798-a834-b26b6e0265a6", "documentation": "Create a new class", "method": "post", "endpoint": "classes", "responses": [ { "uuid": "bc4663a3-f491-4ee7-9b66-a8f9c83a4898", "body": "{\n \"assignmentsCount\": 10,\n \"canvas\": {\n \"id\": \"000000000\"\n },\n \"creationTime\": \"2017-01-25T09:47:34.544000Z\",\n \"enrollmentCode\": \"jm447ear\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory\",\n \"id\": \"00000000\"\n },\n \"googleDrive\": {\n \"teacherFolderAlternateLink\": \"https://drive.google.com/drive/folders/0B-0000000000000000\",\n \"teacherFolderId\": \"0B-0000000000000000\"\n },\n \"id\": \"100000000000000000000001\",\n \"lti\": {\n \"contextId\": \"042\",\n \"contextLabel\": \"MUSIC\",\n \"contextTitle\": \"Music Theory 101\"\n },\n \"microsoftGraph\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n },\n \"name\": \"Music Theory 101\",\n \"organization\": \"100000000000000000000002\",\n \"owner\": \"100000000000000000000003\",\n \"section\": \"Music Theory 101\",\n \"state\": \"active\",\n \"theme\": \"blue-8\"\n}", "latency": 0, "statusCode": 200, "label": "The new class details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "253c96fd-04da-413e-a529-6d89dd8242f2", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 402, "label": "Account overquota", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "316a3f40-47b5-4bbb-8510-cb3654dec18b", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e7bde909-39d8-460d-a016-c397f1daa68d", "documentation": "Join a class", "method": "post", "endpoint": "classes/enroll/:enrollmentCode", "responses": [ { "uuid": "9c706157-e7bb-49f8-a5b3-cff25dee5315", "body": "{\n \"assignmentsCount\": 10,\n \"canvas\": {\n \"id\": \"000000000\"\n },\n \"creationTime\": \"2017-01-25T09:47:34.544000Z\",\n \"enrollmentCode\": \"jm447ear\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory\",\n \"id\": \"00000000\"\n },\n \"googleDrive\": {\n \"teacherFolderAlternateLink\": \"https://drive.google.com/drive/folders/0B-0000000000000000\",\n \"teacherFolderId\": \"0B-0000000000000000\"\n },\n \"id\": \"100000000000000000000001\",\n \"lti\": {\n \"contextId\": \"042\",\n \"contextLabel\": \"MUSIC\",\n \"contextTitle\": \"Music Theory 101\"\n },\n \"microsoftGraph\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n },\n \"name\": \"Music Theory 101\",\n \"organization\": \"100000000000000000000002\",\n \"owner\": \"100000000000000000000003\",\n \"section\": \"Music Theory 101\",\n \"state\": \"active\",\n \"theme\": \"blue-8\"\n}", "latency": 0, "statusCode": 200, "label": "The new class details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "35a8746b-24be-4077-8069-529225629caa", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "42064aeb-8845-4a0a-8992-694dec397d36", "documentation": "Get the details of a single class", "method": "get", "endpoint": "classes/:class", "responses": [ { "uuid": "8cc2f8b4-6044-4a28-910a-2c16375636c2", "body": "{\n \"assignmentsCount\": 10,\n \"canvas\": {\n \"id\": \"000000000\"\n },\n \"creationTime\": \"2017-01-25T09:47:34.544000Z\",\n \"enrollmentCode\": \"jm447ear\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory\",\n \"id\": \"00000000\"\n },\n \"googleDrive\": {\n \"teacherFolderAlternateLink\": \"https://drive.google.com/drive/folders/0B-0000000000000000\",\n \"teacherFolderId\": \"0B-0000000000000000\"\n },\n \"id\": \"100000000000000000000001\",\n \"lti\": {\n \"contextId\": \"042\",\n \"contextLabel\": \"MUSIC\",\n \"contextTitle\": \"Music Theory 101\"\n },\n \"microsoftGraph\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n },\n \"name\": \"Music Theory 101\",\n \"organization\": \"100000000000000000000002\",\n \"owner\": \"100000000000000000000003\",\n \"section\": \"Music Theory 101\",\n \"state\": \"active\",\n \"theme\": \"blue-8\"\n}", "latency": 0, "statusCode": 200, "label": "The new class details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d3ee2f08-cb84-4e18-92e3-7e7c428fc935", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0183f0ed-cb83-4620-a045-d913083c7a15", "documentation": "Update the class", "method": "put", "endpoint": "classes/:class", "responses": [ { "uuid": "9b68d9ba-090a-488d-866f-2c66a8331fda", "body": "{\n \"assignmentsCount\": 10,\n \"canvas\": {\n \"id\": \"000000000\"\n },\n \"creationTime\": \"2017-01-25T09:47:34.544000Z\",\n \"enrollmentCode\": \"jm447ear\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory\",\n \"id\": \"00000000\"\n },\n \"googleDrive\": {\n \"teacherFolderAlternateLink\": \"https://drive.google.com/drive/folders/0B-0000000000000000\",\n \"teacherFolderId\": \"0B-0000000000000000\"\n },\n \"id\": \"100000000000000000000001\",\n \"lti\": {\n \"contextId\": \"042\",\n \"contextLabel\": \"MUSIC\",\n \"contextTitle\": \"Music Theory 101\"\n },\n \"microsoftGraph\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n },\n \"name\": \"Music Theory 101\",\n \"organization\": \"100000000000000000000002\",\n \"owner\": \"100000000000000000000003\",\n \"section\": \"Music Theory 101\",\n \"state\": \"active\",\n \"theme\": \"blue-8\"\n}", "latency": 0, "statusCode": 200, "label": "The new class details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2e1d3e54-0155-4047-a45d-642af3c03029", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b74375b5-c119-40a9-abb1-bfa3e19fb77b", "documentation": "Activate the class", "method": "post", "endpoint": "classes/:class/activate", "responses": [ { "uuid": "a453f7cb-9a8c-4460-b548-407d9989a5c0", "body": "{\n \"assignmentsCount\": 10,\n \"canvas\": {\n \"id\": \"000000000\"\n },\n \"creationTime\": \"2017-01-25T09:47:34.544000Z\",\n \"enrollmentCode\": \"jm447ear\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory\",\n \"id\": \"00000000\"\n },\n \"googleDrive\": {\n \"teacherFolderAlternateLink\": \"https://drive.google.com/drive/folders/0B-0000000000000000\",\n \"teacherFolderId\": \"0B-0000000000000000\"\n },\n \"id\": \"100000000000000000000001\",\n \"lti\": {\n \"contextId\": \"042\",\n \"contextLabel\": \"MUSIC\",\n \"contextTitle\": \"Music Theory 101\"\n },\n \"microsoftGraph\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n },\n \"name\": \"Music Theory 101\",\n \"organization\": \"100000000000000000000002\",\n \"owner\": \"100000000000000000000003\",\n \"section\": \"Music Theory 101\",\n \"state\": \"active\",\n \"theme\": \"blue-8\"\n}", "latency": 0, "statusCode": 200, "label": "The class details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a2f9c583-2f85-4fb5-88d9-0b6598a2eba7", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "39d6a9c9-62f8-4135-b3fa-0b6d0992174d", "documentation": "Unarchive the class", "method": "delete", "endpoint": "classes/:class/archive", "responses": [ { "uuid": "83222fa3-b907-4d32-81cf-ef85bf9a98f5", "body": "{\n \"assignmentsCount\": 10,\n \"canvas\": {\n \"id\": \"000000000\"\n },\n \"creationTime\": \"2017-01-25T09:47:34.544000Z\",\n \"enrollmentCode\": \"jm447ear\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory\",\n \"id\": \"00000000\"\n },\n \"googleDrive\": {\n \"teacherFolderAlternateLink\": \"https://drive.google.com/drive/folders/0B-0000000000000000\",\n \"teacherFolderId\": \"0B-0000000000000000\"\n },\n \"id\": \"100000000000000000000001\",\n \"lti\": {\n \"contextId\": \"042\",\n \"contextLabel\": \"MUSIC\",\n \"contextTitle\": \"Music Theory 101\"\n },\n \"microsoftGraph\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n },\n \"name\": \"Music Theory 101\",\n \"organization\": \"100000000000000000000002\",\n \"owner\": \"100000000000000000000003\",\n \"section\": \"Music Theory 101\",\n \"state\": \"active\",\n \"theme\": \"blue-8\"\n}", "latency": 0, "statusCode": 200, "label": "The class details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bf756ad6-41a9-4d28-9e8b-b5d93dafd431", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3149cdc7-311a-4a76-937e-d9801be27a7d", "documentation": "Archive the class", "method": "post", "endpoint": "classes/:class/archive", "responses": [ { "uuid": "9658fed7-21dd-41f2-8543-996ace946551", "body": "{\n \"assignmentsCount\": 10,\n \"canvas\": {\n \"id\": \"000000000\"\n },\n \"creationTime\": \"2017-01-25T09:47:34.544000Z\",\n \"enrollmentCode\": \"jm447ear\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory\",\n \"id\": \"00000000\"\n },\n \"googleDrive\": {\n \"teacherFolderAlternateLink\": \"https://drive.google.com/drive/folders/0B-0000000000000000\",\n \"teacherFolderId\": \"0B-0000000000000000\"\n },\n \"id\": \"100000000000000000000001\",\n \"lti\": {\n \"contextId\": \"042\",\n \"contextLabel\": \"MUSIC\",\n \"contextTitle\": \"Music Theory 101\"\n },\n \"microsoftGraph\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n },\n \"name\": \"Music Theory 101\",\n \"organization\": \"100000000000000000000002\",\n \"owner\": \"100000000000000000000003\",\n \"section\": \"Music Theory 101\",\n \"state\": \"active\",\n \"theme\": \"blue-8\"\n}", "latency": 0, "statusCode": 200, "label": "The class details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0abf67bf-8b47-493b-8d9d-079034be0739", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f57c7aee-6137-48d3-86a9-4df5f2a05286", "documentation": "Assignments listing", "method": "get", "endpoint": "classes/:class/assignments", "responses": [ { "uuid": "3b3a241f-e021-47fa-9547-8699e39839f8", "body": "[\n {\n \"attachments\": [\n {\n \"score\": \"0000000000000000\",\n \"type\": \"flat\"\n },\n {\n \"type\": \"link\",\n \"url\": \"https://flat.io/developers\"\n },\n {\n \"authorName\": \"Flat\",\n \"authorUrl\": \"https://www.youtube.com/channel/UCEUIbEP9Rba_g0r4eeGhmXw\",\n \"description\": \"Discover Flat on https://flat.io\",\n \"html\": \"\",\n \"thumbnailHeight\": 1052,\n \"thumbnailUrl\": \"https://i.ytimg.com/vi/SNbRUiBZ4Uw/maxresdefault.jpg\",\n \"thumbnailWidth\": 1868,\n \"title\": \"Flat - The online collaborative music notation software\",\n \"type\": \"video\",\n \"url\": \"https://www.youtube.com/watch?v=SNbRUiBZ4Uw\"\n }\n ],\n \"canvas\": {\n \"alternateLink\": \"https://canvas.instructure.com/courses/00000/assignments/12345\",\n \"id\": \"12345\"\n },\n \"classroom\": \"58c4725345cd836264f0b29e\",\n \"creationDate\": \"2017-06-12T13:56:19.613000Z\",\n \"creator\": \"5832bf149995c4024bd6de7d\",\n \"description\": \"Get started with Flat\",\n \"dueDate\": \"2017-07-12T13:56:19.613000Z\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory/a/first-assignment/detail\",\n \"id\": \"1235665432\"\n },\n \"lti\": {\n \"id\": \"12345\"\n },\n \"maxPoints\": 100,\n \"scheduledDate\": \"2017-06-18T13:56:19.613000Z\",\n \"state\": \"active\",\n \"submissions\": [\n {\n \"assignment\": \"58c49068524c03ec576ca43c\",\n \"attachments\": [\n {\n \"score\": \"58c4955a226ffff257211a8d\",\n \"title\": \"Hello - Student\",\n \"type\": \"flat\"\n }\n ],\n \"classroom\": \"58c4725345cd836264f0b29e\",\n \"creationDate\": \"2017-03-12T00:25:00.748000Z\",\n \"creator\": \"559eb5c7f0d4d5e46d03781d\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory/a/first-assignment/submissions/student/my-submission\",\n \"id\": \"CgsI-00000000000\",\n \"state\": \"turned_in\"\n },\n \"id\": \"58c4955c226ffff257211a90\",\n \"submissionDate\": \"2017-03-12T00:25:22.748000Z\"\n }\n ],\n \"title\": \"My first assignment\"\n }\n]", "latency": 0, "statusCode": 200, "label": "List of assignments for the class", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "37f1d633-008c-49b0-b24f-5db851022bf0", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c7675ee8-94e9-44be-9c62-cc51eabad4be", "documentation": "Assignment creation", "method": "post", "endpoint": "classes/:class/assignments", "responses": [ { "uuid": "8bdf3c76-1c51-4520-9948-ec73391571e5", "body": "{\n \"attachments\": [\n {\n \"score\": \"0000000000000000\",\n \"type\": \"flat\"\n },\n {\n \"type\": \"link\",\n \"url\": \"https://flat.io/developers\"\n },\n {\n \"authorName\": \"Flat\",\n \"authorUrl\": \"https://www.youtube.com/channel/UCEUIbEP9Rba_g0r4eeGhmXw\",\n \"description\": \"Discover Flat on https://flat.io\",\n \"html\": \"\",\n \"thumbnailHeight\": 1052,\n \"thumbnailUrl\": \"https://i.ytimg.com/vi/SNbRUiBZ4Uw/maxresdefault.jpg\",\n \"thumbnailWidth\": 1868,\n \"title\": \"Flat - The online collaborative music notation software\",\n \"type\": \"video\",\n \"url\": \"https://www.youtube.com/watch?v=SNbRUiBZ4Uw\"\n }\n ],\n \"canvas\": {\n \"alternateLink\": \"https://canvas.instructure.com/courses/00000/assignments/12345\",\n \"id\": \"12345\"\n },\n \"classroom\": \"58c4725345cd836264f0b29e\",\n \"creationDate\": \"2017-06-12T13:56:19.613000Z\",\n \"creator\": \"5832bf149995c4024bd6de7d\",\n \"description\": \"Get started with Flat\",\n \"dueDate\": \"2017-07-12T13:56:19.613000Z\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory/a/first-assignment/detail\",\n \"id\": \"1235665432\"\n },\n \"lti\": {\n \"id\": \"12345\"\n },\n \"maxPoints\": 100,\n \"scheduledDate\": \"2017-06-18T13:56:19.613000Z\",\n \"state\": \"active\",\n \"submissions\": [\n {\n \"assignment\": \"58c49068524c03ec576ca43c\",\n \"attachments\": [\n {\n \"score\": \"58c4955a226ffff257211a8d\",\n \"title\": \"Hello - Student\",\n \"type\": \"flat\"\n }\n ],\n \"classroom\": \"58c4725345cd836264f0b29e\",\n \"creationDate\": \"2017-03-12T00:25:00.748000Z\",\n \"creator\": \"559eb5c7f0d4d5e46d03781d\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory/a/first-assignment/submissions/student/my-submission\",\n \"id\": \"CgsI-00000000000\",\n \"state\": \"turned_in\"\n },\n \"id\": \"58c4955c226ffff257211a90\",\n \"submissionDate\": \"2017-03-12T00:25:22.748000Z\"\n }\n ],\n \"title\": \"My first assignment\"\n}", "latency": 0, "statusCode": 200, "label": "The assignment has been created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0714c762-e8c2-4989-afcf-be0e9acd67a8", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "549e6a3e-3562-4a11-94d7-a0c3c909adad", "documentation": "Unarchive the assignment.", "method": "delete", "endpoint": "classes/:class/assignments/:assignment/archive", "responses": [ { "uuid": "d80be1eb-d12b-4d9b-9756-68f3b3a8a007", "body": "{\n \"attachments\": [\n {\n \"score\": \"0000000000000000\",\n \"type\": \"flat\"\n },\n {\n \"type\": \"link\",\n \"url\": \"https://flat.io/developers\"\n },\n {\n \"authorName\": \"Flat\",\n \"authorUrl\": \"https://www.youtube.com/channel/UCEUIbEP9Rba_g0r4eeGhmXw\",\n \"description\": \"Discover Flat on https://flat.io\",\n \"html\": \"\",\n \"thumbnailHeight\": 1052,\n \"thumbnailUrl\": \"https://i.ytimg.com/vi/SNbRUiBZ4Uw/maxresdefault.jpg\",\n \"thumbnailWidth\": 1868,\n \"title\": \"Flat - The online collaborative music notation software\",\n \"type\": \"video\",\n \"url\": \"https://www.youtube.com/watch?v=SNbRUiBZ4Uw\"\n }\n ],\n \"canvas\": {\n \"alternateLink\": \"https://canvas.instructure.com/courses/00000/assignments/12345\",\n \"id\": \"12345\"\n },\n \"classroom\": \"58c4725345cd836264f0b29e\",\n \"creationDate\": \"2017-06-12T13:56:19.613000Z\",\n \"creator\": \"5832bf149995c4024bd6de7d\",\n \"description\": \"Get started with Flat\",\n \"dueDate\": \"2017-07-12T13:56:19.613000Z\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory/a/first-assignment/detail\",\n \"id\": \"1235665432\"\n },\n \"lti\": {\n \"id\": \"12345\"\n },\n \"maxPoints\": 100,\n \"scheduledDate\": \"2017-06-18T13:56:19.613000Z\",\n \"state\": \"active\",\n \"submissions\": [\n {\n \"assignment\": \"58c49068524c03ec576ca43c\",\n \"attachments\": [\n {\n \"score\": \"58c4955a226ffff257211a8d\",\n \"title\": \"Hello - Student\",\n \"type\": \"flat\"\n }\n ],\n \"classroom\": \"58c4725345cd836264f0b29e\",\n \"creationDate\": \"2017-03-12T00:25:00.748000Z\",\n \"creator\": \"559eb5c7f0d4d5e46d03781d\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory/a/first-assignment/submissions/student/my-submission\",\n \"id\": \"CgsI-00000000000\",\n \"state\": \"turned_in\"\n },\n \"id\": \"58c4955c226ffff257211a90\",\n \"submissionDate\": \"2017-03-12T00:25:22.748000Z\"\n }\n ],\n \"title\": \"My first assignment\"\n}", "latency": 0, "statusCode": 200, "label": "The assignment details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a4747b77-c097-4042-9090-389e53aee7ea", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e3834c52-cc74-4afc-9ed5-20a65e27b42e", "documentation": "Archive the assignment", "method": "post", "endpoint": "classes/:class/assignments/:assignment/archive", "responses": [ { "uuid": "ae88adb4-66f3-47a7-aef1-95c71f936b7b", "body": "{\n \"attachments\": [\n {\n \"score\": \"0000000000000000\",\n \"type\": \"flat\"\n },\n {\n \"type\": \"link\",\n \"url\": \"https://flat.io/developers\"\n },\n {\n \"authorName\": \"Flat\",\n \"authorUrl\": \"https://www.youtube.com/channel/UCEUIbEP9Rba_g0r4eeGhmXw\",\n \"description\": \"Discover Flat on https://flat.io\",\n \"html\": \"\",\n \"thumbnailHeight\": 1052,\n \"thumbnailUrl\": \"https://i.ytimg.com/vi/SNbRUiBZ4Uw/maxresdefault.jpg\",\n \"thumbnailWidth\": 1868,\n \"title\": \"Flat - The online collaborative music notation software\",\n \"type\": \"video\",\n \"url\": \"https://www.youtube.com/watch?v=SNbRUiBZ4Uw\"\n }\n ],\n \"canvas\": {\n \"alternateLink\": \"https://canvas.instructure.com/courses/00000/assignments/12345\",\n \"id\": \"12345\"\n },\n \"classroom\": \"58c4725345cd836264f0b29e\",\n \"creationDate\": \"2017-06-12T13:56:19.613000Z\",\n \"creator\": \"5832bf149995c4024bd6de7d\",\n \"description\": \"Get started with Flat\",\n \"dueDate\": \"2017-07-12T13:56:19.613000Z\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory/a/first-assignment/detail\",\n \"id\": \"1235665432\"\n },\n \"lti\": {\n \"id\": \"12345\"\n },\n \"maxPoints\": 100,\n \"scheduledDate\": \"2017-06-18T13:56:19.613000Z\",\n \"state\": \"active\",\n \"submissions\": [\n {\n \"assignment\": \"58c49068524c03ec576ca43c\",\n \"attachments\": [\n {\n \"score\": \"58c4955a226ffff257211a8d\",\n \"title\": \"Hello - Student\",\n \"type\": \"flat\"\n }\n ],\n \"classroom\": \"58c4725345cd836264f0b29e\",\n \"creationDate\": \"2017-03-12T00:25:00.748000Z\",\n \"creator\": \"559eb5c7f0d4d5e46d03781d\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory/a/first-assignment/submissions/student/my-submission\",\n \"id\": \"CgsI-00000000000\",\n \"state\": \"turned_in\"\n },\n \"id\": \"58c4955c226ffff257211a90\",\n \"submissionDate\": \"2017-03-12T00:25:22.748000Z\"\n }\n ],\n \"title\": \"My first assignment\"\n}", "latency": 0, "statusCode": 200, "label": "The assignment details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4cbf85aa-a362-483a-8615-a56b0810533d", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4ae804f1-64d8-4dcf-b465-788f95f85cba", "documentation": "Copy an assignment", "method": "post", "endpoint": "classes/:class/assignments/:assignment/copy", "responses": [ { "uuid": "bdedb923-ad97-42a8-a4b5-84e92820b6fe", "body": "{\n \"attachments\": [\n {\n \"score\": \"0000000000000000\",\n \"type\": \"flat\"\n },\n {\n \"type\": \"link\",\n \"url\": \"https://flat.io/developers\"\n },\n {\n \"authorName\": \"Flat\",\n \"authorUrl\": \"https://www.youtube.com/channel/UCEUIbEP9Rba_g0r4eeGhmXw\",\n \"description\": \"Discover Flat on https://flat.io\",\n \"html\": \"\",\n \"thumbnailHeight\": 1052,\n \"thumbnailUrl\": \"https://i.ytimg.com/vi/SNbRUiBZ4Uw/maxresdefault.jpg\",\n \"thumbnailWidth\": 1868,\n \"title\": \"Flat - The online collaborative music notation software\",\n \"type\": \"video\",\n \"url\": \"https://www.youtube.com/watch?v=SNbRUiBZ4Uw\"\n }\n ],\n \"canvas\": {\n \"alternateLink\": \"https://canvas.instructure.com/courses/00000/assignments/12345\",\n \"id\": \"12345\"\n },\n \"classroom\": \"58c4725345cd836264f0b29e\",\n \"creationDate\": \"2017-06-12T13:56:19.613000Z\",\n \"creator\": \"5832bf149995c4024bd6de7d\",\n \"description\": \"Get started with Flat\",\n \"dueDate\": \"2017-07-12T13:56:19.613000Z\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory/a/first-assignment/detail\",\n \"id\": \"1235665432\"\n },\n \"lti\": {\n \"id\": \"12345\"\n },\n \"maxPoints\": 100,\n \"scheduledDate\": \"2017-06-18T13:56:19.613000Z\",\n \"state\": \"active\",\n \"submissions\": [\n {\n \"assignment\": \"58c49068524c03ec576ca43c\",\n \"attachments\": [\n {\n \"score\": \"58c4955a226ffff257211a8d\",\n \"title\": \"Hello - Student\",\n \"type\": \"flat\"\n }\n ],\n \"classroom\": \"58c4725345cd836264f0b29e\",\n \"creationDate\": \"2017-03-12T00:25:00.748000Z\",\n \"creator\": \"559eb5c7f0d4d5e46d03781d\",\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory/a/first-assignment/submissions/student/my-submission\",\n \"id\": \"CgsI-00000000000\",\n \"state\": \"turned_in\"\n },\n \"id\": \"58c4955c226ffff257211a90\",\n \"submissionDate\": \"2017-03-12T00:25:22.748000Z\"\n }\n ],\n \"title\": \"My first assignment\"\n}", "latency": 0, "statusCode": 200, "label": "The new created assingment", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "db60cba8-3377-46b5-8cc1-02be3da700eb", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6ae397d7-0a9b-4b8c-98b4-e5e3503ca6c9", "documentation": "List the students' submissions", "method": "get", "endpoint": "classes/:class/assignments/:assignment/submissions", "responses": [ { "uuid": "72b9f249-dd44-4e3c-951e-10c42c7f37a3", "body": "[\n {\n \"assignment\": \"58c49068524c03ec576ca43c\",\n \"attachments\": [\n {\n \"score\": \"58c4955a226ffff257211a8d\",\n \"title\": \"Hello - Student\",\n \"type\": \"flat\"\n }\n ],\n \"classroom\": \"58c4725345cd836264f0b29e\",\n \"creationDate\": \"2020-08-12T00:25:00.748000Z\",\n \"creator\": \"559eb5c7f0d4d5e46d03781d\",\n \"draftGrade\": 82,\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory/a/first-assignment/submissions/student/my-submission\",\n \"id\": \"CgsI-00000000000\",\n \"state\": \"turned_in\"\n },\n \"grade\": 80,\n \"id\": \"58c4955c226ffff257211a90\",\n \"returnCreator\": \"559eb5c7f0d4d5e46d000000\",\n \"returnDate\": \"2020-08-15T00:25:00.748000Z\",\n \"submissionDate\": \"2020-08-12T00:45:22.748000Z\"\n }\n]", "latency": 0, "statusCode": 200, "label": "The submissions", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "27536250-b162-49ba-a2aa-0e3a605a7a19", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6a15f6da-73ce-4be0-be44-4000648472d3", "documentation": "Create or edit a submission", "method": "put", "endpoint": "classes/:class/assignments/:assignment/submissions", "responses": [ { "uuid": "ab33f817-8b7b-479a-9d78-698ec983db1c", "body": "{\n \"assignment\": \"58c49068524c03ec576ca43c\",\n \"attachments\": [\n {\n \"score\": \"58c4955a226ffff257211a8d\",\n \"title\": \"Hello - Student\",\n \"type\": \"flat\"\n }\n ],\n \"classroom\": \"58c4725345cd836264f0b29e\",\n \"creationDate\": \"2020-08-12T00:25:00.748000Z\",\n \"creator\": \"559eb5c7f0d4d5e46d03781d\",\n \"draftGrade\": 82,\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory/a/first-assignment/submissions/student/my-submission\",\n \"id\": \"CgsI-00000000000\",\n \"state\": \"turned_in\"\n },\n \"grade\": 80,\n \"id\": \"58c4955c226ffff257211a90\",\n \"returnCreator\": \"559eb5c7f0d4d5e46d000000\",\n \"returnDate\": \"2020-08-15T00:25:00.748000Z\",\n \"submissionDate\": \"2020-08-12T00:45:22.748000Z\"\n}", "latency": 0, "statusCode": 200, "label": "The submission", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8ff87aef-4988-4564-8f49-b0d84c1d3210", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1d54c977-4bb2-43fa-b992-62a826a81630", "documentation": "CSV Grades exports", "method": "get", "endpoint": "classes/:class/assignments/:assignment/submissions/csv", "responses": [ { "uuid": "51dfdc4a-6d72-4442-8c5a-8bcef384a19a", "body": "", "latency": 0, "statusCode": 200, "label": "List of submissions", "headers": [{ "key": "Content-Type", "value": "text/csv" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a59d3add-a791-4657-aee4-1be4b839cf71", "body": "", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "text/csv" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8dd34991-a6a4-4248-bdfb-29db321260c0", "documentation": "Excel Grades exports", "method": "get", "endpoint": "classes/:class/assignments/:assignment/submissions/excel", "responses": [ { "uuid": "c6daab1a-f9f8-4816-a22a-f33bcbc85d4f", "body": "", "latency": 0, "statusCode": 200, "label": "List of submissions", "headers": [ { "key": "Content-Type", "value": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a7599c30-de5e-47c8-b4bd-c6a4e6405c59", "body": "", "latency": 0, "statusCode": 200, "label": "Error", "headers": [ { "key": "Content-Type", "value": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "18d1a96a-2f24-477b-a307-2f4db77afca5", "documentation": "Delete a submission", "method": "delete", "endpoint": "classes/:class/assignments/:assignment/submissions/:submission", "responses": [ { "uuid": "ae088057-67ca-42ff-960d-1e199b7dd499", "body": "", "latency": 0, "statusCode": 204, "label": "The submission has been deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c27961f2-fa05-4974-b5b6-243acc483abf", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fec1e8fc-95c2-4564-a706-9d33003f8432", "documentation": "Get a student submission", "method": "get", "endpoint": "classes/:class/assignments/:assignment/submissions/:submission", "responses": [ { "uuid": "384258ea-e7d1-43cf-8a2a-86f562aaf801", "body": "{\n \"assignment\": \"58c49068524c03ec576ca43c\",\n \"attachments\": [\n {\n \"score\": \"58c4955a226ffff257211a8d\",\n \"title\": \"Hello - Student\",\n \"type\": \"flat\"\n }\n ],\n \"classroom\": \"58c4725345cd836264f0b29e\",\n \"creationDate\": \"2020-08-12T00:25:00.748000Z\",\n \"creator\": \"559eb5c7f0d4d5e46d03781d\",\n \"draftGrade\": 82,\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory/a/first-assignment/submissions/student/my-submission\",\n \"id\": \"CgsI-00000000000\",\n \"state\": \"turned_in\"\n },\n \"grade\": 80,\n \"id\": \"58c4955c226ffff257211a90\",\n \"returnCreator\": \"559eb5c7f0d4d5e46d000000\",\n \"returnDate\": \"2020-08-15T00:25:00.748000Z\",\n \"submissionDate\": \"2020-08-12T00:45:22.748000Z\"\n}", "latency": 0, "statusCode": 200, "label": "A submission", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9ce46775-9f14-47cf-b707-55f7979dd1fa", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9dcde32c-4e36-4dcf-ae0d-8b09eb6ac3e6", "documentation": "Edit a submission", "method": "put", "endpoint": "classes/:class/assignments/:assignment/submissions/:submission", "responses": [ { "uuid": "8b15bd50-5d87-4c2a-a977-c69f52f3ad39", "body": "{\n \"assignment\": \"58c49068524c03ec576ca43c\",\n \"attachments\": [\n {\n \"score\": \"58c4955a226ffff257211a8d\",\n \"title\": \"Hello - Student\",\n \"type\": \"flat\"\n }\n ],\n \"classroom\": \"58c4725345cd836264f0b29e\",\n \"creationDate\": \"2020-08-12T00:25:00.748000Z\",\n \"creator\": \"559eb5c7f0d4d5e46d03781d\",\n \"draftGrade\": 82,\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory/a/first-assignment/submissions/student/my-submission\",\n \"id\": \"CgsI-00000000000\",\n \"state\": \"turned_in\"\n },\n \"grade\": 80,\n \"id\": \"58c4955c226ffff257211a90\",\n \"returnCreator\": \"559eb5c7f0d4d5e46d000000\",\n \"returnDate\": \"2020-08-15T00:25:00.748000Z\",\n \"submissionDate\": \"2020-08-12T00:45:22.748000Z\"\n}", "latency": 0, "statusCode": 200, "label": "The submission", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "189d4871-9eb7-485e-b2d2-697022255f1f", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "87a521b3-b573-432d-8416-d177e3d10ae8", "documentation": "List the feedback comments of a submission", "method": "get", "endpoint": "classes/:class/assignments/:assignment/submissions/:submission/comments", "responses": [ { "uuid": "4153834a-22ea-40a2-b892-8cb47ffbcffd", "body": "[\n {\n \"comment\": \"\",\n \"date\": \"{{faker 'date.recent' 365}}\",\n \"id\": \"\",\n \"modificationDate\": \"{{faker 'date.recent' 365}}\",\n \"submission\": \"\",\n \"unread\": {{faker 'datatype.boolean'}},\n \"user\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "The comments of the score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a5f763f2-d45f-4a19-bd7e-89d11c9b1f73", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this submission", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c9d0870b-f328-400a-aa59-82e2e1230fcf", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Submission not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7cacabce-71ad-4efe-8d7f-31f4c3ae91ff", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f6652641-433c-4c97-a7bb-d22d577ddc8b", "documentation": "Add a feedback comment to a submission", "method": "post", "endpoint": "classes/:class/assignments/:assignment/submissions/:submission/comments", "responses": [ { "uuid": "78557925-f79c-485e-822d-eb00ca45c27b", "body": "{\n \"comment\": \"\",\n \"date\": \"{{faker 'date.recent' 365}}\",\n \"id\": \"\",\n \"modificationDate\": \"{{faker 'date.recent' 365}}\",\n \"submission\": \"\",\n \"unread\": {{faker 'datatype.boolean'}},\n \"user\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The comment", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "416d16cc-7e65-49e4-9f4d-bc751b11de9a", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this submission", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "eb813a39-1d7f-402d-bb5a-7622b9869baf", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Submission not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bfac4c73-a3e3-4800-a755-e4763b630a6d", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7189a5ce-ca2f-416f-96d2-131b00d031d9", "documentation": "Delete a feedback comment to a submission", "method": "delete", "endpoint": "classes/:class/assignments/:assignment/submissions/:submission/comments/:comment", "responses": [ { "uuid": "bb366472-5a99-4b72-be07-6ed3f0ddb2ed", "body": "", "latency": 0, "statusCode": 204, "label": "The comment has been deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "47ac9931-65a6-4983-a5d1-29a19050aa3d", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f8450059-e42d-4f17-bc2f-8864c23375d0", "documentation": "Update a feedback comment to a submission", "method": "put", "endpoint": "classes/:class/assignments/:assignment/submissions/:submission/comments/:comment", "responses": [ { "uuid": "356ab3d3-bfd8-464e-9167-126b31004a39", "body": "{\n \"comment\": \"\",\n \"date\": \"{{faker 'date.recent' 365}}\",\n \"id\": \"\",\n \"modificationDate\": \"{{faker 'date.recent' 365}}\",\n \"submission\": \"\",\n \"unread\": {{faker 'datatype.boolean'}},\n \"user\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The comment", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ad707e1b-89a2-4928-9ca5-eb30846b0210", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this submission", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cdc12879-6ccd-4eda-bb44-48ef26e478d4", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Submission not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dbb6bc89-bb62-4f8e-ac7f-21088e6f13ba", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7de60bfa-4c65-44c1-9995-b7151303c045", "documentation": "Get the history of the submission", "method": "get", "endpoint": "classes/:class/assignments/:assignment/submissions/:submission/history", "responses": [ { "uuid": "9a631994-c46a-4887-b6c3-a50beb19f7af", "body": "[\n {\n \"attachment\": {\n \"revision\": \"\",\n \"score\": \"\"\n },\n \"date\": \"{{faker 'date.recent' 365}}\",\n \"draftGrade\": {{faker 'number.int' max=99999}},\n \"grade\": {{faker 'number.int' max=99999}},\n \"maxPoints\": {{faker 'number.int' max=99999}},\n \"state\": \"{{oneOf (array 'created' 'turnedIn' 'returned')}}\",\n \"users\": [\n \"\"\n ]\n }\n]", "latency": 0, "statusCode": 200, "label": "The history of the submission", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "56c84bf0-d1e7-4fb7-a5ee-e62fb950c15f", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this submission", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7798782b-3167-40d0-89a8-e5b4c3c20500", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Submission not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "842924b3-e87f-4035-b6f5-e7d8d33e772f", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1afa060e-62cf-41a2-9452-f37332f807a7", "documentation": "List the submissions for a student", "method": "get", "endpoint": "classes/:class/students/:user/submissions", "responses": [ { "uuid": "401e62e4-6af8-451d-9c47-d33e03b46b7b", "body": "[\n {\n \"assignment\": \"58c49068524c03ec576ca43c\",\n \"attachments\": [\n {\n \"score\": \"58c4955a226ffff257211a8d\",\n \"title\": \"Hello - Student\",\n \"type\": \"flat\"\n }\n ],\n \"classroom\": \"58c4725345cd836264f0b29e\",\n \"creationDate\": \"2020-08-12T00:25:00.748000Z\",\n \"creator\": \"559eb5c7f0d4d5e46d03781d\",\n \"draftGrade\": 82,\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory/a/first-assignment/submissions/student/my-submission\",\n \"id\": \"CgsI-00000000000\",\n \"state\": \"turned_in\"\n },\n \"grade\": 80,\n \"id\": \"58c4955c226ffff257211a90\",\n \"returnCreator\": \"559eb5c7f0d4d5e46d000000\",\n \"returnDate\": \"2020-08-15T00:25:00.748000Z\",\n \"submissionDate\": \"2020-08-12T00:45:22.748000Z\"\n }\n]", "latency": 0, "statusCode": 200, "label": "The list of submissions", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "771e051e-adf6-4de7-86db-95c5603e7054", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5bc95385-10b1-46e7-8e64-4941355a512c", "documentation": "Remove a user from the class", "method": "delete", "endpoint": "classes/:class/users/:user", "responses": [ { "uuid": "6b4b923b-7a96-4c0d-888f-476cfbf98221", "body": "", "latency": 0, "statusCode": 204, "label": "The user has been removed from the class", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5bf44da1-2b44-4007-8398-69d799a2bf1f", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e5f7c0c6-8cab-4b92-ab94-e46aeb43b70b", "documentation": "Add a user to the class", "method": "put", "endpoint": "classes/:class/users/:user", "responses": [ { "uuid": "9cec3aab-f26a-4cfd-ac8b-351ea9c15fbf", "body": "", "latency": 0, "statusCode": 204, "label": "The user has been added to the class", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "97fdee10-773a-4193-a6c0-fd2b4587fbc7", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "da4fcbb5-85bb-4176-9614-cacd84a59d24", "documentation": "List the collections", "method": "get", "endpoint": "collections", "responses": [ { "uuid": "e7f938b1-0226-4125-b7bd-1704d9639c9b", "body": "[\n {\n \"app\": \"\",\n \"capabilities\": {\n \"canAddScores\": {{faker 'datatype.boolean'}},\n \"canDelete\": {{faker 'datatype.boolean'}},\n \"canDeleteScores\": {{faker 'datatype.boolean'}},\n \"canEdit\": {{faker 'datatype.boolean'}},\n \"canShare\": {{faker 'datatype.boolean'}}\n },\n \"collaborators\": [\n {\n \"aclAdmin\": {{faker 'datatype.boolean'}},\n \"aclRead\": {{faker 'datatype.boolean'}},\n \"aclWrite\": {{faker 'datatype.boolean'}},\n \"isCollaborator\": {{faker 'datatype.boolean'}}\n }\n ],\n \"collections\": [\n \"\"\n ],\n \"creationDate\": \"{{faker 'date.recent' 365}}\",\n \"htmlUrl\": \"\",\n \"id\": \"\",\n \"privacy\": \"{{oneOf (array 'private')}}\",\n \"rights\": {\n \"aclAdmin\": true,\n \"aclRead\": true,\n \"aclWrite\": true,\n \"isCollaborator\": true\n },\n \"sharingKey\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'root' 'regular' 'sharedWithMe' 'sharedWithGroup' 'trash')}}\",\n \"user\": {\n \"firstname\": \"\",\n \"id\": \"\",\n \"isFlatTeam\": {{faker 'datatype.boolean'}},\n \"isPowerUser\": {{faker 'datatype.boolean'}},\n \"lastname\": \"\",\n \"name\": \"\",\n \"picture\": \"\",\n \"printableName\": \"\",\n \"type\": \"{{oneOf (array 'user' 'guest')}}\",\n \"username\": \"\"\n }\n }\n]", "latency": 0, "statusCode": 200, "label": "List of collections", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a7a47a95-6768-4079-9f97-8d7743cd1479", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7b51e6b5-dda5-4962-9c0e-b84423bf8d95", "documentation": "Create a new collection", "method": "post", "endpoint": "collections", "responses": [ { "uuid": "d4464f5e-c8c7-4086-840a-bcf905799df1", "body": "{\n \"app\": \"\",\n \"capabilities\": {\n \"canAddScores\": {{faker 'datatype.boolean'}},\n \"canDelete\": {{faker 'datatype.boolean'}},\n \"canDeleteScores\": {{faker 'datatype.boolean'}},\n \"canEdit\": {{faker 'datatype.boolean'}},\n \"canShare\": {{faker 'datatype.boolean'}}\n },\n \"collaborators\": [\n {\n \"aclAdmin\": {{faker 'datatype.boolean'}},\n \"aclRead\": {{faker 'datatype.boolean'}},\n \"aclWrite\": {{faker 'datatype.boolean'}},\n \"isCollaborator\": {{faker 'datatype.boolean'}}\n }\n ],\n \"collections\": [\n \"\"\n ],\n \"creationDate\": \"{{faker 'date.recent' 365}}\",\n \"htmlUrl\": \"\",\n \"id\": \"\",\n \"privacy\": \"{{oneOf (array 'private')}}\",\n \"rights\": {\n \"aclAdmin\": true,\n \"aclRead\": true,\n \"aclWrite\": true,\n \"isCollaborator\": true\n },\n \"sharingKey\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'root' 'regular' 'sharedWithMe' 'sharedWithGroup' 'trash')}}\",\n \"user\": {\n \"firstname\": \"\",\n \"id\": \"\",\n \"isFlatTeam\": {{faker 'datatype.boolean'}},\n \"isPowerUser\": {{faker 'datatype.boolean'}},\n \"lastname\": \"\",\n \"name\": \"\",\n \"picture\": \"\",\n \"printableName\": \"\",\n \"type\": \"{{oneOf (array 'user' 'guest')}}\",\n \"username\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Collection created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f8ce4d42-db1f-491e-bd85-6cff505cd817", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 400, "label": "Bad collection creation request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "60cda96d-f140-4720-8a21-34c3f3729d4c", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f95a6f2b-eeba-46d5-a595-921d7db3bc91", "documentation": "Delete the collection", "method": "delete", "endpoint": "collections/:collection", "responses": [ { "uuid": "a00c543b-d2bc-4809-8d60-5e7ca44997cf", "body": "", "latency": 0, "statusCode": 204, "label": "Collection deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "78d666e8-5d70-4fe1-98a3-ef8cb4e940ed", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this collection", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "903bd4c1-e1d8-4f06-958b-43644a9a0e58", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Collection not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c1eeb346-94a6-4fad-aaf1-2c0d7aae5552", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "77861f59-303f-429d-b51a-2acc4153c5ba", "documentation": "Get collection details", "method": "get", "endpoint": "collections/:collection", "responses": [ { "uuid": "b405e1f2-391d-49f9-8de9-0fa909b28fd0", "body": "{\n \"app\": \"\",\n \"capabilities\": {\n \"canAddScores\": {{faker 'datatype.boolean'}},\n \"canDelete\": {{faker 'datatype.boolean'}},\n \"canDeleteScores\": {{faker 'datatype.boolean'}},\n \"canEdit\": {{faker 'datatype.boolean'}},\n \"canShare\": {{faker 'datatype.boolean'}}\n },\n \"collaborators\": [\n {\n \"aclAdmin\": {{faker 'datatype.boolean'}},\n \"aclRead\": {{faker 'datatype.boolean'}},\n \"aclWrite\": {{faker 'datatype.boolean'}},\n \"isCollaborator\": {{faker 'datatype.boolean'}}\n }\n ],\n \"collections\": [\n \"\"\n ],\n \"creationDate\": \"{{faker 'date.recent' 365}}\",\n \"htmlUrl\": \"\",\n \"id\": \"\",\n \"privacy\": \"{{oneOf (array 'private')}}\",\n \"rights\": {\n \"aclAdmin\": true,\n \"aclRead\": true,\n \"aclWrite\": true,\n \"isCollaborator\": true\n },\n \"sharingKey\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'root' 'regular' 'sharedWithMe' 'sharedWithGroup' 'trash')}}\",\n \"user\": {\n \"firstname\": \"\",\n \"id\": \"\",\n \"isFlatTeam\": {{faker 'datatype.boolean'}},\n \"isPowerUser\": {{faker 'datatype.boolean'}},\n \"lastname\": \"\",\n \"name\": \"\",\n \"picture\": \"\",\n \"printableName\": \"\",\n \"type\": \"{{oneOf (array 'user' 'guest')}}\",\n \"username\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Collection details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "25611d13-3c3f-4cfe-b0c4-8a49bf7da9d4", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this collection", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "98343af5-9b33-4336-b617-24115db761f6", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Collection not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "32d9aada-e85e-4d0f-8f56-0bea012b3257", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "14afd25b-0840-4d1b-bd02-429ebe289c22", "documentation": "Update a collection's metadata", "method": "put", "endpoint": "collections/:collection", "responses": [ { "uuid": "32df571a-65de-4209-99a6-6f21b66f85ed", "body": "{\n \"app\": \"\",\n \"capabilities\": {\n \"canAddScores\": {{faker 'datatype.boolean'}},\n \"canDelete\": {{faker 'datatype.boolean'}},\n \"canDeleteScores\": {{faker 'datatype.boolean'}},\n \"canEdit\": {{faker 'datatype.boolean'}},\n \"canShare\": {{faker 'datatype.boolean'}}\n },\n \"collaborators\": [\n {\n \"aclAdmin\": {{faker 'datatype.boolean'}},\n \"aclRead\": {{faker 'datatype.boolean'}},\n \"aclWrite\": {{faker 'datatype.boolean'}},\n \"isCollaborator\": {{faker 'datatype.boolean'}}\n }\n ],\n \"collections\": [\n \"\"\n ],\n \"creationDate\": \"{{faker 'date.recent' 365}}\",\n \"htmlUrl\": \"\",\n \"id\": \"\",\n \"privacy\": \"{{oneOf (array 'private')}}\",\n \"rights\": {\n \"aclAdmin\": true,\n \"aclRead\": true,\n \"aclWrite\": true,\n \"isCollaborator\": true\n },\n \"sharingKey\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'root' 'regular' 'sharedWithMe' 'sharedWithGroup' 'trash')}}\",\n \"user\": {\n \"firstname\": \"\",\n \"id\": \"\",\n \"isFlatTeam\": {{faker 'datatype.boolean'}},\n \"isPowerUser\": {{faker 'datatype.boolean'}},\n \"lastname\": \"\",\n \"name\": \"\",\n \"picture\": \"\",\n \"printableName\": \"\",\n \"type\": \"{{oneOf (array 'user' 'guest')}}\",\n \"username\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Collection details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4cfb1b78-20df-45da-bc8b-2863248bbda7", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this collection", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "109c472e-bfd7-4de7-bf73-91d2b3421d57", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Collection not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b216ccd8-f143-4399-b47b-dcf6add14232", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0b20b5a5-90d3-403f-becf-7d38ab75979f", "documentation": "List the scores contained in a collection", "method": "get", "endpoint": "collections/:collection/scores", "responses": [ { "uuid": "c246e048-61da-4f78-9252-60598e524ac2", "body": "[\n {\n \"htmlUrl\": \"\",\n \"id\": \"\",\n \"privacy\": \"{{oneOf (array 'public' 'private' 'organizationPublic' 'privateLink')}}\",\n \"sharingKey\": \"\",\n \"title\": \"\",\n \"user\": {\n \"firstname\": \"\",\n \"id\": \"\",\n \"isFlatTeam\": {{faker 'datatype.boolean'}},\n \"isPowerUser\": {{faker 'datatype.boolean'}},\n \"lastname\": \"\",\n \"name\": \"\",\n \"picture\": \"\",\n \"printableName\": \"\",\n \"type\": \"{{oneOf (array 'user' 'guest')}}\",\n \"username\": \"\"\n }\n }\n]", "latency": 0, "statusCode": 200, "label": "List of scores", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "95c92c6a-24de-425a-b7e8-6db0cbf9dbb7", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5eea5333-7886-4cf5-8ff0-8fbf6b805bac", "documentation": "Delete a score from the collection", "method": "delete", "endpoint": "collections/:collection/scores/:score", "responses": [ { "uuid": "ec176c61-872f-496c-9b8f-aa2078bef588", "body": "", "latency": 0, "statusCode": 204, "label": "Score removed from the collection", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a357ec6b-a7c7-42c6-a3ef-ad75cdcceb37", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this collection", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "24e89c7b-92aa-45f5-8f6a-fae1c938eb21", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Collection not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cdaf1bd9-acce-4c4c-be0b-ae0668dcba39", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dc99523a-5d9d-43a8-a73d-e49fab8d1a1a", "documentation": "Add a score to the collection", "method": "put", "endpoint": "collections/:collection/scores/:score", "responses": [ { "uuid": "5c980be5-6a5a-4728-ba3b-30ea076ef87d", "body": "{\n \"htmlUrl\": \"\",\n \"id\": \"\",\n \"privacy\": \"{{oneOf (array 'public' 'private' 'organizationPublic' 'privateLink')}}\",\n \"sharingKey\": \"\",\n \"title\": \"\",\n \"user\": {\n \"firstname\": \"\",\n \"id\": \"\",\n \"isFlatTeam\": {{faker 'datatype.boolean'}},\n \"isPowerUser\": {{faker 'datatype.boolean'}},\n \"lastname\": \"\",\n \"name\": \"\",\n \"picture\": \"\",\n \"printableName\": \"\",\n \"type\": \"{{oneOf (array 'user' 'guest')}}\",\n \"username\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Score details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a4845166-8044-4a28-84e3-f682f66cabd6", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this collection or score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "da12f6d7-0e2a-4629-97c2-cd22a16b3dcd", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Collection or score not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ca7c5332-b401-4eca-a314-4e23cd2b02ed", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d1924aad-9523-4df5-9fb7-e03eb6d8de5d", "documentation": "Untrash a collection", "method": "post", "endpoint": "collections/:collection/untrash", "responses": [ { "uuid": "fc6a2817-696f-4734-978a-0d63382cb1c2", "body": "", "latency": 0, "statusCode": 204, "label": "The score has been untrashed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d138c9fb-06ca-4da0-96f2-44b60418a311", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to manage this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "28b0277b-922f-4453-ab28-5a7484d9d06c", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "13ec33ad-3f0b-430c-8ad1-bee85b10aeec", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e94c6e76-3cd9-4127-ae9d-5bd42aad2491", "documentation": "Get group information", "method": "get", "endpoint": "groups/:group", "responses": [ { "uuid": "b4043997-55a0-4099-bd7b-ffd40838b6db", "body": "{\n \"creationDate\": \"2017-07-02T15:02:40.207000Z\",\n \"id\": \"58c4955c226ffff257211a00\",\n \"name\": \"5th Grade - Teachers\",\n \"organization\": \"0000000000000000000000042\",\n \"readOnly\": false,\n \"type\": \"classTeachers\",\n \"usersCount\": 2\n}", "latency": 0, "statusCode": 200, "label": "The group details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ced4683e-854c-41e3-b51a-bac462192868", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "52422284-3425-4af6-8f52-9697ec2484d4", "documentation": "List group's scores", "method": "get", "endpoint": "groups/:group/scores", "responses": [ { "uuid": "b063c12c-6ce2-4bb5-939c-daf11bb5e1ca", "body": "[\n {\n \"htmlUrl\": \"\",\n \"id\": \"\",\n \"privacy\": \"{{oneOf (array 'public' 'private' 'organizationPublic' 'privateLink')}}\",\n \"sharingKey\": \"\",\n \"title\": \"\",\n \"user\": {\n \"firstname\": \"\",\n \"id\": \"\",\n \"isFlatTeam\": {{faker 'datatype.boolean'}},\n \"isPowerUser\": {{faker 'datatype.boolean'}},\n \"lastname\": \"\",\n \"name\": \"\",\n \"picture\": \"\",\n \"printableName\": \"\",\n \"type\": \"{{oneOf (array 'user' 'guest')}}\",\n \"username\": \"\"\n }\n }\n]", "latency": 0, "statusCode": 200, "label": "The group's scores", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "90c8ad38-5131-4f36-8a71-b058bce8c8ca", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "da1eab6b-9d2b-4644-8e5a-b5d77e99f68a", "documentation": "List group's users", "method": "get", "endpoint": "groups/:group/users", "responses": [ { "uuid": "c7770236-05d1-4155-92b2-0b491c2f43d8", "body": "[\n \"\"\n]", "latency": 0, "statusCode": 200, "label": "The list of users member of the group", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ea42c250-bdfd-4c47-8f46-0ba9779210bc", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c17daea5-429f-4f77-a349-6317935555e6", "documentation": "Get current user profile", "method": "get", "endpoint": "me", "responses": [ { "uuid": "34383f32-fc82-404d-80e3-132ef4c9b950", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Current user details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "73972420-038f-4a54-95a4-8fb8c6d43f9e", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "65b35f4c-05fc-4938-aa66-c2a9410b8ea6", "documentation": "List the organization invitations", "method": "get", "endpoint": "organizations/invitations", "responses": [ { "uuid": "fa74fee6-935c-4a7f-8d84-6f14b5e72674", "body": "[\n {\n \"creationDate\": \"2017-07-02T15:05:15.576000Z\",\n \"customCode\": \"u5raQ7pZ\",\n \"email\": \"edu@flat.io\",\n \"id\": \"59590bab53b1af260610000\",\n \"invitedBy\": \"55b8d8f395c8db031ed00000\",\n \"organization\": \"55df29a6694e4a3953100000\",\n \"organizationRole\": \"teacher\"\n }\n]", "latency": 0, "statusCode": 200, "label": "List of invitations", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "59947e62-312b-4467-af22-773fc66439d4", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "170ce10a-aad5-4817-a3ae-43dd6325a13a", "documentation": "Create a new invitation to join the organization", "method": "post", "endpoint": "organizations/invitations", "responses": [ { "uuid": "2f24bc0c-ebe7-40d3-9f18-0723a4566389", "body": "{\n \"creationDate\": \"2017-07-02T15:05:15.576000Z\",\n \"customCode\": \"u5raQ7pZ\",\n \"email\": \"edu@flat.io\",\n \"id\": \"59590bab53b1af260610000\",\n \"invitedBy\": \"55b8d8f395c8db031ed00000\",\n \"organization\": \"55df29a6694e4a3953100000\",\n \"organizationRole\": \"teacher\"\n}", "latency": 0, "statusCode": 200, "label": "New invitation created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "45aa2e4a-4079-4e20-87df-0660e5ad1f7d", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "62d99091-13b0-4cc1-b3df-df620649787c", "documentation": "Remove an organization invitation", "method": "delete", "endpoint": "organizations/invitations/:invitation", "responses": [ { "uuid": "00b235e0-9a36-4e0f-a515-aef76a26f063", "body": "", "latency": 0, "statusCode": 204, "label": "The invitation has been removed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "24138805-46d5-4332-9fbf-27b7a81591b7", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4d71fa28-b6c7-478f-8df7-bb4ea0493151", "documentation": "List LTI 1.x credentials", "method": "get", "endpoint": "organizations/lti/credentials", "responses": [ { "uuid": "bb3e92ce-a0ef-4532-a52b-aa1831cdca9e", "body": "[\n {\n \"consumerKey\": \"200082F5-FAFD-4C6E-BB19-7DAB5D6264D4\",\n \"consumerSecret\": \"168b6181c05eae14298176a274273e4ebef0d15555fe3e80c6a98ccd57d0c3b6\",\n \"creationDate\": \"2017-06-06T11:03:01.955000Z\",\n \"creator\": \"5832bf149995c4024bd6de7d\",\n \"id\": \"59368be5c66caf895ee02387\",\n \"lastUsage\": \"2017-06-13T16:02:34.324000Z\",\n \"lms\": \"canvas\",\n \"name\": \"My couple of credentials for Canvas\",\n \"organization\": \"5832c801a4bedc05f4fb4993\"\n }\n]", "latency": 0, "statusCode": 200, "label": "The list of LTI Credentials", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bfd0db7e-97c1-4d82-bf70-a96e8c3fc0c6", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not admin of an organization", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "79f80446-a163-4eca-8491-cd5e3fd1f73c", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c558164d-752e-46fc-a211-e5e55b30241c", "documentation": "Create a new couple of LTI 1.x credentials", "method": "post", "endpoint": "organizations/lti/credentials", "responses": [ { "uuid": "f30696cd-b7e0-4e66-8ee5-c31e32e899f3", "body": "{\n \"consumerKey\": \"200082F5-FAFD-4C6E-BB19-7DAB5D6264D4\",\n \"consumerSecret\": \"168b6181c05eae14298176a274273e4ebef0d15555fe3e80c6a98ccd57d0c3b6\",\n \"creationDate\": \"2017-06-06T11:03:01.955000Z\",\n \"creator\": \"5832bf149995c4024bd6de7d\",\n \"id\": \"59368be5c66caf895ee02387\",\n \"lastUsage\": \"2017-06-13T16:02:34.324000Z\",\n \"lms\": \"canvas\",\n \"name\": \"My couple of credentials for Canvas\",\n \"organization\": \"5832c801a4bedc05f4fb4993\"\n}", "latency": 0, "statusCode": 200, "label": "The LTI Credentials", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fe6b6d1f-43b6-4274-9e84-9ed141526f15", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not admin of an organization", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "15305a28-7336-45b7-8fe7-adf1744fcee3", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "71e7a655-36cf-4b3f-af14-51d154054a62", "documentation": "Revoke LTI 1.x credentials", "method": "delete", "endpoint": "organizations/lti/credentials/:credentials", "responses": [ { "uuid": "d3c1be96-f065-40ae-9847-9e7671b520f4", "body": "", "latency": 0, "statusCode": 204, "label": "Credentials revoked", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "63ca0373-cd5e-4b46-a094-952ab56216e2", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not admin of an organization", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "eaba9a75-529d-4d4a-b549-56150a13519d", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Credentials not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "722aa708-faf6-490b-bdd5-e557a60114ad", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6eaf293c-a00a-4f21-bc84-51883aef862f", "documentation": "List the organization users", "method": "get", "endpoint": "organizations/users", "responses": [ { "uuid": "200f45b0-c8e6-4569-8b40-24f98411adb8", "body": "[\n \"\"\n]", "latency": 0, "statusCode": 200, "label": "List of users", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "de67cee5-6826-4126-b860-576928ebadb5", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7ac3ad2b-029e-4804-960d-f59f1df6a161", "documentation": "Create a new user account", "method": "post", "endpoint": "organizations/users", "responses": [ { "uuid": "97509f04-5c6c-47d0-af13-3b2b94306c5a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "New user created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "71b9f20a-4a2a-4af5-8130-4e5bd6fabf32", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "99849622-f004-4eaa-92d4-ba5440f8f297", "documentation": "Count the organization users using the provided filters", "method": "get", "endpoint": "organizations/users/count", "responses": [ { "uuid": "ada00d5f-998c-4e57-83fd-0ce5b0962345", "body": "{{faker 'number.int' max=99999}}", "latency": 0, "statusCode": 200, "label": "Number of users", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b3f40705-602f-4b63-8922-05d143acf46a", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1aff3104-d45d-46e7-8efa-7ae588e24612", "documentation": "Remove an account from Flat", "method": "delete", "endpoint": "organizations/users/:user", "responses": [ { "uuid": "91ef1def-bd94-4f57-a859-ed74c8a59c00", "body": "", "latency": 0, "statusCode": 204, "label": "User deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d8c7fbc2-f120-4fd8-916c-32293f3b6470", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3428f4a0-0871-4746-aa9b-1694eb0954d3", "documentation": "Update account information", "method": "put", "endpoint": "organizations/users/:user", "responses": [ { "uuid": "0bc97f49-a411-481a-b30e-ad830569b835", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "User updated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "66733513-53ff-4eee-be23-92d614ce81d7", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "70da5807-0c8e-4a95-8856-951ead1e4395", "documentation": "Create a new score", "method": "post", "endpoint": "scores", "responses": [ { "uuid": "f2f1abe3-d3e4-4a83-97a5-613e7cb9c9e0", "body": "{\n \"htmlUrl\": \"\",\n \"id\": \"\",\n \"privacy\": \"{{oneOf (array 'public' 'private' 'organizationPublic' 'privateLink')}}\",\n \"sharingKey\": \"\",\n \"title\": \"\",\n \"user\": {\n \"firstname\": \"\",\n \"id\": \"\",\n \"isFlatTeam\": {{faker 'datatype.boolean'}},\n \"isPowerUser\": {{faker 'datatype.boolean'}},\n \"lastname\": \"\",\n \"name\": \"\",\n \"picture\": \"\",\n \"printableName\": \"\",\n \"type\": \"{{oneOf (array 'user' 'guest')}}\",\n \"username\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Score created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "911e1084-46e6-4691-9333-74ba203000ac", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 400, "label": "Bad score creation request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ac9c5e98-8af9-4d32-8754-31355b648ff0", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 402, "label": "Account overquota", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "565b52e0-880e-4f04-8a81-85848ba9dd7a", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3b0ced0a-f447-4b97-b3ca-77b06112e12e", "documentation": "Delete a score", "method": "delete", "endpoint": "scores/:score", "responses": [ { "uuid": "521396b6-981d-4b08-a3c7-e314ef177aca", "body": "", "latency": 0, "statusCode": 204, "label": "The score has been removed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d8a8ce0e-a8ed-46b0-9856-c02bb55f15b0", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to manage this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "48268875-9d38-4ae2-b935-d5fee306ecf2", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "98fa9156-3113-485f-a165-03661f9a1185", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "013fcc86-0f02-4956-8783-56e58cccbe8c", "documentation": "Get a score's metadata", "method": "get", "endpoint": "scores/:score", "responses": [ { "uuid": "3e20f81c-0bfa-4296-9698-52d0c245bcde", "body": "{\n \"htmlUrl\": \"\",\n \"id\": \"\",\n \"privacy\": \"{{oneOf (array 'public' 'private' 'organizationPublic' 'privateLink')}}\",\n \"sharingKey\": \"\",\n \"title\": \"\",\n \"user\": {\n \"firstname\": \"\",\n \"id\": \"\",\n \"isFlatTeam\": {{faker 'datatype.boolean'}},\n \"isPowerUser\": {{faker 'datatype.boolean'}},\n \"lastname\": \"\",\n \"name\": \"\",\n \"picture\": \"\",\n \"printableName\": \"\",\n \"type\": \"{{oneOf (array 'user' 'guest')}}\",\n \"username\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Score details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d88133ee-f3ed-4436-9d64-cc11f9276a9f", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 402, "label": "Account overquota and this document is out of the granted quota", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9cf3eaca-5a7c-4799-b7b3-2660bf42f26d", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7c69f355-90fd-4a13-b22e-c46fc1a75c9f", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e246dd04-0a63-40ef-ba85-4670e8e256a5", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bdcab3df-fb2b-458d-9eee-5da73ed15ca0", "documentation": "Edit a score's metadata", "method": "put", "endpoint": "scores/:score", "responses": [ { "uuid": "9d024657-f631-49e3-914b-786bc59d7375", "body": "{\n \"htmlUrl\": \"\",\n \"id\": \"\",\n \"privacy\": \"{{oneOf (array 'public' 'private' 'organizationPublic' 'privateLink')}}\",\n \"sharingKey\": \"\",\n \"title\": \"\",\n \"user\": {\n \"firstname\": \"\",\n \"id\": \"\",\n \"isFlatTeam\": {{faker 'datatype.boolean'}},\n \"isPowerUser\": {{faker 'datatype.boolean'}},\n \"lastname\": \"\",\n \"name\": \"\",\n \"picture\": \"\",\n \"printableName\": \"\",\n \"type\": \"{{oneOf (array 'user' 'guest')}}\",\n \"username\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Score details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "47d0027e-b979-4f70-9def-de983c779196", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 402, "label": "Account overquota", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f30c24b5-6a17-4553-aef9-96b96e57ff3c", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "63a15a8c-6f4a-4189-beca-83ea703e750c", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1697c8a4-1ac8-4cf9-ac79-23dae0e7294d", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d5bde3e7-6af4-44c3-ae0d-2593b66fcfcc", "documentation": "List the collaborators", "method": "get", "endpoint": "scores/:score/collaborators", "responses": [ { "uuid": "e02121d6-a1ac-4e1f-9a75-c7c0d42a1540", "body": "[\n {\n \"aclAdmin\": {{faker 'datatype.boolean'}},\n \"aclRead\": {{faker 'datatype.boolean'}},\n \"aclWrite\": {{faker 'datatype.boolean'}},\n \"isCollaborator\": {{faker 'datatype.boolean'}}\n }\n]", "latency": 0, "statusCode": 200, "label": "List of collaborators", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "230c9606-a57b-4989-ac99-5477493d75ad", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 402, "label": "Account overquota", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4252db9b-c11a-4f01-a6be-f5cc841a3d70", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7a1c2d34-f8ca-4083-bfce-3a92d06c008b", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0eba1189-c229-4e0d-9861-d26a2b55384c", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "842a1dfe-8660-44bd-9f55-0c7dadff5e05", "documentation": "Add a new collaborator", "method": "post", "endpoint": "scores/:score/collaborators", "responses": [ { "uuid": "28a6b62a-59da-4cd4-945a-31bb71662cc9", "body": "{\n \"aclAdmin\": {{faker 'datatype.boolean'}},\n \"aclRead\": {{faker 'datatype.boolean'}},\n \"aclWrite\": {{faker 'datatype.boolean'}},\n \"isCollaborator\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "The newly added collaborator metadata", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "314eb1d0-9e01-41fc-82b0-247fb86b2254", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 402, "label": "Account overquota", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8843a7b9-5d27-4517-8364-576ea9998019", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to manage this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "248342e4-b283-4d06-acfd-59d1620f8a51", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f96bfd78-7b9e-4b8b-9d1d-12203edd6e6a", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bf9844fe-dbf9-4e22-b8ec-eb9177472128", "documentation": "Delete a collaborator", "method": "delete", "endpoint": "scores/:score/collaborators/:collaborator", "responses": [ { "uuid": "758a2136-bc82-49a7-810e-4e17cd087561", "body": "", "latency": 0, "statusCode": 204, "label": "The collaborator has been removed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8dafcf77-299b-4058-8e2b-f13ca36ff3c4", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to manage this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "08536d4e-6ff1-4024-b8e8-ac21897e4b1e", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score or collaborator not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f2bf60d1-6af6-4d44-9cd0-46219e5fe99c", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5c96fa36-35a4-4b05-b25a-f6248c787e0e", "documentation": "Get a collaborator", "method": "get", "endpoint": "scores/:score/collaborators/:collaborator", "responses": [ { "uuid": "e3db929f-4e28-41e9-bb07-91b30420261d", "body": "{\n \"aclAdmin\": {{faker 'datatype.boolean'}},\n \"aclRead\": {{faker 'datatype.boolean'}},\n \"aclWrite\": {{faker 'datatype.boolean'}},\n \"isCollaborator\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Collaborator information", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "07a170a8-7d5d-4045-a1cd-5c0e2309665f", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 402, "label": "Account overquota", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ef887f30-de02-4d4c-8112-7cf528e659b2", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ff807ee3-321f-44bb-aed8-e58fac4d53bc", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score or collaborator not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "004145df-dc10-441b-94aa-778b50adb2b3", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "706047b5-3d2b-4302-9e87-c9454981a5e1", "documentation": "List comments", "method": "get", "endpoint": "scores/:score/comments", "responses": [ { "uuid": "4e1d76e6-e7a3-4467-9236-7bd9d4496e52", "body": "[\n {\n \"comment\": \"@[000000000000000000000000:flat] Great work!\",\n \"context\": {\n \"measureUuids\": [\n \"e6a6a60b-8710-f819-9a49-e907b19c6f1f\",\n \"da83d93c-e3a6-3c73-1bbe-15e5131d6437\",\n \"056ec5eb-9213-df56-6ae8-d9b99673dc48\"\n ],\n \"partUuid\": \"91982db7-2e6d-285e-7a19-76b4bd005b8b\",\n \"staffUuid\": \"9395d8f3-f42b-47b6-8c5d-6ba704961ec0\",\n \"startDpq\": 1,\n \"startTimePos\": 2,\n \"stopDpq\": 1,\n \"stopTimePos\": 3\n },\n \"date\": \"2017-01-26T20:29:10.622000Z\",\n \"id\": \"000000000000000000000010\",\n \"mentions\": [\n \"000000000000000000000000\"\n ],\n \"modificationDate\": \"2017-01-26T21:29:10.622000Z\",\n \"rawComment\": \"@flat: Great work!\",\n \"replyTo\": \"000000000000000000000000\",\n \"resolved\": true,\n \"resolvedBy\": \"000000000000000000000000\",\n \"revision\": \"000000000000000000000011\",\n \"score\": \"000000000000000000000042\",\n \"spam\": false,\n \"type\": \"inline\",\n \"user\": \"000000000000000000000001\"\n }\n]", "latency": 0, "statusCode": 200, "label": "The comments of the score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "024c1b1a-9ecf-4fc6-bf9f-ec002e0bdc24", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 402, "label": "Account overquota", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "878fa961-a734-4d02-bdbf-2eda4a80d0a8", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7172ecc6-6b53-4ad6-a309-15410c1b261a", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0155d6ec-ed02-4418-b4db-b3426461e916", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8caddf7b-0a85-4c4c-90e0-8c71e95417f7", "documentation": "Post a new comment", "method": "post", "endpoint": "scores/:score/comments", "responses": [ { "uuid": "377e62cc-360d-4ca8-b247-75ba522f23b2", "body": "{\n \"comment\": \"@[000000000000000000000000:flat] Great work!\",\n \"context\": {\n \"measureUuids\": [\n \"e6a6a60b-8710-f819-9a49-e907b19c6f1f\",\n \"da83d93c-e3a6-3c73-1bbe-15e5131d6437\",\n \"056ec5eb-9213-df56-6ae8-d9b99673dc48\"\n ],\n \"partUuid\": \"91982db7-2e6d-285e-7a19-76b4bd005b8b\",\n \"staffUuid\": \"9395d8f3-f42b-47b6-8c5d-6ba704961ec0\",\n \"startDpq\": 1,\n \"startTimePos\": 2,\n \"stopDpq\": 1,\n \"stopTimePos\": 3\n },\n \"date\": \"2017-01-26T20:29:10.622000Z\",\n \"id\": \"000000000000000000000010\",\n \"mentions\": [\n \"000000000000000000000000\"\n ],\n \"modificationDate\": \"2017-01-26T21:29:10.622000Z\",\n \"rawComment\": \"@flat: Great work!\",\n \"replyTo\": \"000000000000000000000000\",\n \"resolved\": true,\n \"resolvedBy\": \"000000000000000000000000\",\n \"revision\": \"000000000000000000000011\",\n \"score\": \"000000000000000000000042\",\n \"spam\": false,\n \"type\": \"inline\",\n \"user\": \"000000000000000000000001\"\n}", "latency": 0, "statusCode": 200, "label": "The new comment", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ae468bf4-9d6f-4cd6-b5e7-b2832ae1fe71", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 402, "label": "Account overquota", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a5c03051-1b60-4db9-a8d0-4b4dea51cbcc", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this score, to post a comment, or your API call triggered our spam filter.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f2f27dd1-9945-48e2-8730-3daa7b25e74d", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "05af1d9d-0285-4b71-b6f1-da3d94d77fde", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b7af4748-2b03-4c5e-bc4c-81d578857789", "documentation": "Delete a comment", "method": "delete", "endpoint": "scores/:score/comments/:comment", "responses": [ { "uuid": "63a02176-7066-4edb-a843-3d0f0a1f3bf7", "body": "", "latency": 0, "statusCode": 204, "label": "The comment has been deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fccb96c1-3faa-4bb6-8ecf-843f6d6569c5", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this score or not the original comment creator", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6024c2c9-6405-4ba2-bbad-ad7505f136f4", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score or comment not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3b5ee7ce-8af5-4ce1-ab5a-d77d4440fcbf", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9b3a89f7-863f-420d-bf39-2b5d25a20891", "documentation": "Update an existing comment", "method": "put", "endpoint": "scores/:score/comments/:comment", "responses": [ { "uuid": "d01a4844-4096-4bdc-b2f0-b1a9c4221203", "body": "{\n \"comment\": \"@[000000000000000000000000:flat] Great work!\",\n \"context\": {\n \"measureUuids\": [\n \"e6a6a60b-8710-f819-9a49-e907b19c6f1f\",\n \"da83d93c-e3a6-3c73-1bbe-15e5131d6437\",\n \"056ec5eb-9213-df56-6ae8-d9b99673dc48\"\n ],\n \"partUuid\": \"91982db7-2e6d-285e-7a19-76b4bd005b8b\",\n \"staffUuid\": \"9395d8f3-f42b-47b6-8c5d-6ba704961ec0\",\n \"startDpq\": 1,\n \"startTimePos\": 2,\n \"stopDpq\": 1,\n \"stopTimePos\": 3\n },\n \"date\": \"2017-01-26T20:29:10.622000Z\",\n \"id\": \"000000000000000000000010\",\n \"mentions\": [\n \"000000000000000000000000\"\n ],\n \"modificationDate\": \"2017-01-26T21:29:10.622000Z\",\n \"rawComment\": \"@flat: Great work!\",\n \"replyTo\": \"000000000000000000000000\",\n \"resolved\": true,\n \"resolvedBy\": \"000000000000000000000000\",\n \"revision\": \"000000000000000000000011\",\n \"score\": \"000000000000000000000042\",\n \"spam\": false,\n \"type\": \"inline\",\n \"user\": \"000000000000000000000001\"\n}", "latency": 0, "statusCode": 200, "label": "The edited comment", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4b0b7c70-78e1-4e4d-840d-e06dce5dd398", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 402, "label": "Account overquota", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "06ffd1ed-4129-4994-a88c-6ee1b31fe3ac", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this score or not the original comment creator", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d5df7cda-368b-4292-a526-15df140e3c6d", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "44503c82-3f20-4ffd-ba03-40ca52c51c4c", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "92407754-18d3-41c2-945c-9dde7d197f6b", "documentation": "Mark the comment as unresolved", "method": "delete", "endpoint": "scores/:score/comments/:comment/resolved", "responses": [ { "uuid": "6fbf4c88-554a-41e0-ab93-65169471669a", "body": "", "latency": 0, "statusCode": 204, "label": "The comment has been unmarked as resolved", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7153d671-8391-4c4e-9fe5-e2e141488db0", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to unmark this comment as resolved", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ec0f4bb5-219f-4bb9-9074-81f228a8276a", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score or comment not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "20372576-e1f5-4487-b1ba-7310a6170a00", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "700e77db-748b-45ae-aec2-5cd2e1cc41db", "documentation": "Mark the comment as resolved", "method": "put", "endpoint": "scores/:score/comments/:comment/resolved", "responses": [ { "uuid": "aaebd77f-29d6-4261-b652-39e3ef167891", "body": "", "latency": 0, "statusCode": 204, "label": "The comment has been marked as resolved", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "79cdb5ce-5b34-4b8f-94c0-2eb0abd1f415", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to mark this comment as resolved", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ac97aef3-701d-46b9-83ce-2503a7ead59f", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score or comment not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "46bb9c96-1a0f-406f-8373-2a138d07906c", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "93f07846-89f3-41c4-9dec-8ef10202aba2", "documentation": "Fork a score", "method": "post", "endpoint": "scores/:score/fork", "responses": [ { "uuid": "1f1a8719-092f-49ad-9b45-6d2337d50ea9", "body": "{\n \"htmlUrl\": \"\",\n \"id\": \"\",\n \"privacy\": \"{{oneOf (array 'public' 'private' 'organizationPublic' 'privateLink')}}\",\n \"sharingKey\": \"\",\n \"title\": \"\",\n \"user\": {\n \"firstname\": \"\",\n \"id\": \"\",\n \"isFlatTeam\": {{faker 'datatype.boolean'}},\n \"isPowerUser\": {{faker 'datatype.boolean'}},\n \"lastname\": \"\",\n \"name\": \"\",\n \"picture\": \"\",\n \"printableName\": \"\",\n \"type\": \"{{oneOf (array 'user' 'guest')}}\",\n \"username\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Score details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7e6c255e-08b7-4f1d-b856-06c6dd5d099a", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 402, "label": "Account overquota", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ce6d2561-e80a-4038-8d43-d85772aa30dc", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ec545714-28f2-4d7e-996f-929b3d54a65c", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f3f84d03-b2a5-49dc-acb4-16403a55c189", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8e2f1942-b244-44ff-b40e-084a6cc5a746", "documentation": "List the revisions", "method": "get", "endpoint": "scores/:score/revisions", "responses": [ { "uuid": "a8d309db-6b56-4f82-a1c0-b4e0381b1b41", "body": "[\n {\n \"autosave\": true,\n \"collaborators\": [\n \"000000000000000000000010\",\n \"000000000000000000000020\"\n ],\n \"creationDate\": \"2017-01-26T20:29:10.622000Z\",\n \"description\": \"New revision\",\n \"user\": \"000000000000000000000020\"\n }\n]", "latency": 0, "statusCode": 200, "label": "List of revisions", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bf7bc6b8-04f4-4483-8b6a-76e91a59e756", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 402, "label": "Account overquota", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "679dd439-ec3f-4243-9011-9cb501a6d129", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "afbaab79-1397-470e-82eb-51f42e177b18", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "14ec7648-be28-4280-92dd-fc52e4d657c9", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0ff889c7-2dd3-4909-84d5-bf18fbf5b48c", "documentation": "Create a new revision", "method": "post", "endpoint": "scores/:score/revisions", "responses": [ { "uuid": "e6bc60bc-1ada-44b7-a705-e02be35b37dd", "body": "{\n \"autosave\": true,\n \"collaborators\": [\n \"000000000000000000000010\",\n \"000000000000000000000020\"\n ],\n \"creationDate\": \"2017-01-26T20:29:10.622000Z\",\n \"description\": \"New revision\",\n \"user\": \"000000000000000000000020\"\n}", "latency": 0, "statusCode": 200, "label": "The new created revision metadata", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "227461c4-a410-4fc3-8512-5c0527818bc1", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 402, "label": "Account overquota", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "615385ca-dc42-4c0d-b8cb-b115d38ae789", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to modify this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d3b64d26-6501-48c1-a875-550bcb335dda", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7fd166f7-5e77-49e9-96b2-78c978e7fe7e", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9526e8af-de29-4c6b-a5cd-3a1845e2e620", "documentation": "Get a score revision", "method": "get", "endpoint": "scores/:score/revisions/:revision", "responses": [ { "uuid": "7cf83c7d-e8bc-43fd-93a5-ffc0a9df5f8c", "body": "{\n \"autosave\": true,\n \"collaborators\": [\n \"000000000000000000000010\",\n \"000000000000000000000020\"\n ],\n \"creationDate\": \"2017-01-26T20:29:10.622000Z\",\n \"description\": \"New revision\",\n \"user\": \"000000000000000000000020\"\n}", "latency": 0, "statusCode": 200, "label": "Revision metadata", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2f731a1d-0af9-42bf-b900-44272e3979c3", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 402, "label": "Account overquota", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "98293163-f494-4756-bbba-fba76fa1112f", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c702bb8f-d45d-41af-a17d-0d1b2879d8a1", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "25f68df2-c422-4ca7-ab7f-00bf1623afef", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7769e4d7-4c89-4048-b828-c3f2dc7c504f", "documentation": "Get a score revision data", "method": "get", "endpoint": "scores/:score/revisions/:revision/:format", "responses": [ { "uuid": "c0ca1010-232f-4dd6-9663-fcd8da2e9fa8", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Revision data", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1c2b3f85-667a-474d-9bce-0649f06d2ddc", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 402, "label": "Account overquota", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ef21dee4-0754-4059-9834-06fb1c45d91b", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "70c72a03-25e1-4dd2-acbd-68133d8ae277", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score or associated file not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "29ff9a05-33c2-411e-8ec9-9e02bc662806", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7c287012-a921-4b39-8b7f-a6a3c4e0e73d", "documentation": "List submissions related to the score", "method": "get", "endpoint": "scores/:score/submissions", "responses": [ { "uuid": "d6462d42-302a-4018-ae2f-c5abdaab4055", "body": "[\n {\n \"assignment\": \"58c49068524c03ec576ca43c\",\n \"attachments\": [\n {\n \"score\": \"58c4955a226ffff257211a8d\",\n \"title\": \"Hello - Student\",\n \"type\": \"flat\"\n }\n ],\n \"classroom\": \"58c4725345cd836264f0b29e\",\n \"creationDate\": \"2020-08-12T00:25:00.748000Z\",\n \"creator\": \"559eb5c7f0d4d5e46d03781d\",\n \"draftGrade\": 82,\n \"googleClassroom\": {\n \"alternateLink\": \"http://classroom.google.com/c/music-theory/a/first-assignment/submissions/student/my-submission\",\n \"id\": \"CgsI-00000000000\",\n \"state\": \"turned_in\"\n },\n \"grade\": 80,\n \"id\": \"58c4955c226ffff257211a90\",\n \"returnCreator\": \"559eb5c7f0d4d5e46d000000\",\n \"returnDate\": \"2020-08-15T00:25:00.748000Z\",\n \"submissionDate\": \"2020-08-12T00:45:22.748000Z\"\n }\n]", "latency": 0, "statusCode": 200, "label": "List of submissions", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ebcdac90-68d1-4a89-b7e2-e90c027ae6c1", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "93728ba2-3991-407a-a8f0-70d888da7ea1", "documentation": "List the audio or video tracks linked to a score", "method": "get", "endpoint": "scores/:score/tracks", "responses": [ { "uuid": "ad255ac2-ec9d-464f-8219-319b56780eac", "body": "[\n {\n \"creationDate\": \"2017-10-22T14:58:22.753000Z\",\n \"creator\": \"5815d4b53269d90d2c80b71c\",\n \"default\": true,\n \"id\": \"59ecb20e563736b1e1f75dce\",\n \"mediaId\": \"dQw4w9WgXcQ\",\n \"modificationDate\": \"2017-10-22T14:58:33.424000Z\",\n \"score\": \"59a29d96f35a6411d7508bdd\",\n \"state\": \"completed\",\n \"synchronizationPoints\": [\n {\n \"measureUuid\": \"5132a788-69e6-d0c6-84ec-4bd858658d7c\",\n \"time\": 0,\n \"type\": \"measure\"\n },\n {\n \"time\": 213,\n \"type\": \"end\"\n }\n ],\n \"title\": \"Rick Astley - Never Gonna Give You Up\",\n \"type\": \"youtube\",\n \"url\": \"https://www.youtube.com/watch?v=dQw4w9WgXcQ\"\n }\n]", "latency": 0, "statusCode": 200, "label": "List of tracks", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fe43ba99-267f-4b59-8cf0-dab230436c13", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "292e1bfa-ce86-4b2a-a21a-6efc0e15c4b0", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e9b2dc92-e4e4-4650-98ad-e35e038197ca", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3102c5b1-1f27-49c9-92bc-254ef524bb9d", "documentation": "Add a new video or audio track to the score", "method": "post", "endpoint": "scores/:score/tracks", "responses": [ { "uuid": "532045a1-d560-49c1-ab74-445511bdc113", "body": "{\n \"creationDate\": \"2017-10-22T14:58:22.753000Z\",\n \"creator\": \"5815d4b53269d90d2c80b71c\",\n \"default\": true,\n \"id\": \"59ecb20e563736b1e1f75dce\",\n \"mediaId\": \"dQw4w9WgXcQ\",\n \"modificationDate\": \"2017-10-22T14:58:33.424000Z\",\n \"score\": \"59a29d96f35a6411d7508bdd\",\n \"state\": \"completed\",\n \"synchronizationPoints\": [\n {\n \"measureUuid\": \"5132a788-69e6-d0c6-84ec-4bd858658d7c\",\n \"time\": 0,\n \"type\": \"measure\"\n },\n {\n \"time\": 213,\n \"type\": \"end\"\n }\n ],\n \"title\": \"Rick Astley - Never Gonna Give You Up\",\n \"type\": \"youtube\",\n \"url\": \"https://www.youtube.com/watch?v=dQw4w9WgXcQ\"\n}", "latency": 0, "statusCode": 200, "label": "Created track", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "296caf41-4442-4498-9f41-efc0811a4308", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "18c1bbff-63d8-43c2-847b-2a3fb2150230", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "75602bad-1b8a-4c4f-ad4e-330b2e57c490", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "50d96321-2841-46cd-ad95-dac2f4ae786e", "documentation": "Remove an audio or video track linked to the score", "method": "delete", "endpoint": "scores/:score/tracks/:track", "responses": [ { "uuid": "3f673e5c-f7ce-4ca4-818f-2ff156299241", "body": "", "latency": 0, "statusCode": 204, "label": "Track removed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1898cd5e-3aa1-4725-8576-d6f7a0a282bc", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "51af46e6-a30d-4d3e-a561-c0111cef49d7", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score or Track not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c3a67876-77a4-48fc-a654-c28223eabd7b", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9cf4569b-4c02-47ca-9a92-1a3ea2d94772", "documentation": "Retrieve the details of an audio or video track linked to a score", "method": "get", "endpoint": "scores/:score/tracks/:track", "responses": [ { "uuid": "77a6ac3e-474a-4d16-a69c-7e28685ddd06", "body": "{\n \"creationDate\": \"2017-10-22T14:58:22.753000Z\",\n \"creator\": \"5815d4b53269d90d2c80b71c\",\n \"default\": true,\n \"id\": \"59ecb20e563736b1e1f75dce\",\n \"mediaId\": \"dQw4w9WgXcQ\",\n \"modificationDate\": \"2017-10-22T14:58:33.424000Z\",\n \"score\": \"59a29d96f35a6411d7508bdd\",\n \"state\": \"completed\",\n \"synchronizationPoints\": [\n {\n \"measureUuid\": \"5132a788-69e6-d0c6-84ec-4bd858658d7c\",\n \"time\": 0,\n \"type\": \"measure\"\n },\n {\n \"time\": 213,\n \"type\": \"end\"\n }\n ],\n \"title\": \"Rick Astley - Never Gonna Give You Up\",\n \"type\": \"youtube\",\n \"url\": \"https://www.youtube.com/watch?v=dQw4w9WgXcQ\"\n}", "latency": 0, "statusCode": 200, "label": "Track details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "073bb151-e223-4b17-b406-92a7400d010f", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8481d453-c3e5-4e9d-b601-a76dbd8b6f97", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score or Track not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "aa08a884-90c1-44b9-90c2-4e43f04beac4", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6fd684ca-9337-4941-a752-ab5794ecf053", "documentation": "Update an audio or video track linked to a score", "method": "put", "endpoint": "scores/:score/tracks/:track", "responses": [ { "uuid": "7c3e016b-7383-4bd6-ab57-7fbefe3afbca", "body": "{\n \"creationDate\": \"2017-10-22T14:58:22.753000Z\",\n \"creator\": \"5815d4b53269d90d2c80b71c\",\n \"default\": true,\n \"id\": \"59ecb20e563736b1e1f75dce\",\n \"mediaId\": \"dQw4w9WgXcQ\",\n \"modificationDate\": \"2017-10-22T14:58:33.424000Z\",\n \"score\": \"59a29d96f35a6411d7508bdd\",\n \"state\": \"completed\",\n \"synchronizationPoints\": [\n {\n \"measureUuid\": \"5132a788-69e6-d0c6-84ec-4bd858658d7c\",\n \"time\": 0,\n \"type\": \"measure\"\n },\n {\n \"time\": 213,\n \"type\": \"end\"\n }\n ],\n \"title\": \"Rick Astley - Never Gonna Give You Up\",\n \"type\": \"youtube\",\n \"url\": \"https://www.youtube.com/watch?v=dQw4w9WgXcQ\"\n}", "latency": 0, "statusCode": 200, "label": "Updated track", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ac31cd69-9117-4027-96ad-e1b038e14c6f", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to access to this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b06f28a6-783c-4314-a612-f879c3c9df2c", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score or Track not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0b4aa367-0063-4d71-b814-63810851e646", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ba5ac1be-c586-4f2e-9ab4-ab0971d2a2ce", "documentation": "Untrash a score", "method": "post", "endpoint": "scores/:score/untrash", "responses": [ { "uuid": "1e096fd6-694f-4a76-9618-ae1be0105142", "body": "", "latency": 0, "statusCode": 204, "label": "The score has been untrashed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6437e3d8-fc6b-4e7f-a111-4e6493a0b9e6", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 403, "label": "Not granted to manage this score", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ab1e8eaa-1f3c-47d0-a911-b8533e38f25d", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 404, "label": "Score not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9ec21d2b-70fb-4366-af7c-eaaf03f04ee1", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e90301ab-849e-4216-97f2-49a66676cbe6", "documentation": "Get a public user profile", "method": "get", "endpoint": "users/:user", "responses": [ { "uuid": "a3dec542-dde5-49ed-90b1-d219513b8e4e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The user public details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a743ad8f-0471-4a1c-84b8-92a7c2784f4e", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "48771e9b-910b-493a-82c3-3178d932200d", "documentation": "List liked scores", "method": "get", "endpoint": "users/:user/likes", "responses": [ { "uuid": "7acb0b07-8bce-4fb8-a30b-311d9fbba73f", "body": "[\n {\n \"htmlUrl\": \"\",\n \"id\": \"\",\n \"privacy\": \"{{oneOf (array 'public' 'private' 'organizationPublic' 'privateLink')}}\",\n \"sharingKey\": \"\",\n \"title\": \"\",\n \"user\": {\n \"firstname\": \"\",\n \"id\": \"\",\n \"isFlatTeam\": {{faker 'datatype.boolean'}},\n \"isPowerUser\": {{faker 'datatype.boolean'}},\n \"lastname\": \"\",\n \"name\": \"\",\n \"picture\": \"\",\n \"printableName\": \"\",\n \"type\": \"{{oneOf (array 'user' 'guest')}}\",\n \"username\": \"\"\n }\n }\n]", "latency": 0, "statusCode": 200, "label": "List of liked scores", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9c8a980f-fc8f-48c2-a42d-fc5a7ad42f2d", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "78415554-0682-4171-ab30-983797a73754", "documentation": "List user's scores", "method": "get", "endpoint": "users/:user/scores", "responses": [ { "uuid": "2ba973e2-d634-4026-89f2-767d1074b1ad", "body": "[\n {\n \"htmlUrl\": \"\",\n \"id\": \"\",\n \"privacy\": \"{{oneOf (array 'public' 'private' 'organizationPublic' 'privateLink')}}\",\n \"sharingKey\": \"\",\n \"title\": \"\",\n \"user\": {\n \"firstname\": \"\",\n \"id\": \"\",\n \"isFlatTeam\": {{faker 'datatype.boolean'}},\n \"isPowerUser\": {{faker 'datatype.boolean'}},\n \"lastname\": \"\",\n \"name\": \"\",\n \"picture\": \"\",\n \"printableName\": \"\",\n \"type\": \"{{oneOf (array 'user' 'guest')}}\",\n \"username\": \"\"\n }\n }\n]", "latency": 0, "statusCode": 200, "label": "The user scores", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a50d67a3-eaed-44b1-875d-286efe1f8b53", "body": "{\n \"code\": \"CLIENT_ERROR\",\n \"id\": \"123456789\",\n \"message\": \"Invalid request\"\n}", "latency": 0, "statusCode": 200, "label": "Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "a19138e4-86b9-410e-a9e8-fc0ce14ace52" }, { "type": "route", "uuid": "2258897b-ce3d-4798-a834-b26b6e0265a6" }, { "type": "route", "uuid": "e7bde909-39d8-460d-a016-c397f1daa68d" }, { "type": "route", "uuid": "42064aeb-8845-4a0a-8992-694dec397d36" }, { "type": "route", "uuid": "0183f0ed-cb83-4620-a045-d913083c7a15" }, { "type": "route", "uuid": "b74375b5-c119-40a9-abb1-bfa3e19fb77b" }, { "type": "route", "uuid": "39d6a9c9-62f8-4135-b3fa-0b6d0992174d" }, { "type": "route", "uuid": "3149cdc7-311a-4a76-937e-d9801be27a7d" }, { "type": "route", "uuid": "f57c7aee-6137-48d3-86a9-4df5f2a05286" }, { "type": "route", "uuid": "c7675ee8-94e9-44be-9c62-cc51eabad4be" }, { "type": "route", "uuid": "549e6a3e-3562-4a11-94d7-a0c3c909adad" }, { "type": "route", "uuid": "e3834c52-cc74-4afc-9ed5-20a65e27b42e" }, { "type": "route", "uuid": "4ae804f1-64d8-4dcf-b465-788f95f85cba" }, { "type": "route", "uuid": "6ae397d7-0a9b-4b8c-98b4-e5e3503ca6c9" }, { "type": "route", "uuid": "6a15f6da-73ce-4be0-be44-4000648472d3" }, { "type": "route", "uuid": "1d54c977-4bb2-43fa-b992-62a826a81630" }, { "type": "route", "uuid": "8dd34991-a6a4-4248-bdfb-29db321260c0" }, { "type": "route", "uuid": "18d1a96a-2f24-477b-a307-2f4db77afca5" }, { "type": "route", "uuid": "fec1e8fc-95c2-4564-a706-9d33003f8432" }, { "type": "route", "uuid": "9dcde32c-4e36-4dcf-ae0d-8b09eb6ac3e6" }, { "type": "route", "uuid": "87a521b3-b573-432d-8416-d177e3d10ae8" }, { "type": "route", "uuid": "f6652641-433c-4c97-a7bb-d22d577ddc8b" }, { "type": "route", "uuid": "7189a5ce-ca2f-416f-96d2-131b00d031d9" }, { "type": "route", "uuid": "f8450059-e42d-4f17-bc2f-8864c23375d0" }, { "type": "route", "uuid": "7de60bfa-4c65-44c1-9995-b7151303c045" }, { "type": "route", "uuid": "1afa060e-62cf-41a2-9452-f37332f807a7" }, { "type": "route", "uuid": "5bc95385-10b1-46e7-8e64-4941355a512c" }, { "type": "route", "uuid": "e5f7c0c6-8cab-4b92-ab94-e46aeb43b70b" }, { "type": "route", "uuid": "da4fcbb5-85bb-4176-9614-cacd84a59d24" }, { "type": "route", "uuid": "7b51e6b5-dda5-4962-9c0e-b84423bf8d95" }, { "type": "route", "uuid": "f95a6f2b-eeba-46d5-a595-921d7db3bc91" }, { "type": "route", "uuid": "77861f59-303f-429d-b51a-2acc4153c5ba" }, { "type": "route", "uuid": "14afd25b-0840-4d1b-bd02-429ebe289c22" }, { "type": "route", "uuid": "0b20b5a5-90d3-403f-becf-7d38ab75979f" }, { "type": "route", "uuid": "5eea5333-7886-4cf5-8ff0-8fbf6b805bac" }, { "type": "route", "uuid": "dc99523a-5d9d-43a8-a73d-e49fab8d1a1a" }, { "type": "route", "uuid": "d1924aad-9523-4df5-9fb7-e03eb6d8de5d" }, { "type": "route", "uuid": "e94c6e76-3cd9-4127-ae9d-5bd42aad2491" }, { "type": "route", "uuid": "52422284-3425-4af6-8f52-9697ec2484d4" }, { "type": "route", "uuid": "da1eab6b-9d2b-4644-8e5a-b5d77e99f68a" }, { "type": "route", "uuid": "c17daea5-429f-4f77-a349-6317935555e6" }, { "type": "route", "uuid": "65b35f4c-05fc-4938-aa66-c2a9410b8ea6" }, { "type": "route", "uuid": "170ce10a-aad5-4817-a3ae-43dd6325a13a" }, { "type": "route", "uuid": "62d99091-13b0-4cc1-b3df-df620649787c" }, { "type": "route", "uuid": "4d71fa28-b6c7-478f-8df7-bb4ea0493151" }, { "type": "route", "uuid": "c558164d-752e-46fc-a211-e5e55b30241c" }, { "type": "route", "uuid": "71e7a655-36cf-4b3f-af14-51d154054a62" }, { "type": "route", "uuid": "6eaf293c-a00a-4f21-bc84-51883aef862f" }, { "type": "route", "uuid": "7ac3ad2b-029e-4804-960d-f59f1df6a161" }, { "type": "route", "uuid": "99849622-f004-4eaa-92d4-ba5440f8f297" }, { "type": "route", "uuid": "1aff3104-d45d-46e7-8efa-7ae588e24612" }, { "type": "route", "uuid": "3428f4a0-0871-4746-aa9b-1694eb0954d3" }, { "type": "route", "uuid": "70da5807-0c8e-4a95-8856-951ead1e4395" }, { "type": "route", "uuid": "3b0ced0a-f447-4b97-b3ca-77b06112e12e" }, { "type": "route", "uuid": "013fcc86-0f02-4956-8783-56e58cccbe8c" }, { "type": "route", "uuid": "bdcab3df-fb2b-458d-9eee-5da73ed15ca0" }, { "type": "route", "uuid": "d5bde3e7-6af4-44c3-ae0d-2593b66fcfcc" }, { "type": "route", "uuid": "842a1dfe-8660-44bd-9f55-0c7dadff5e05" }, { "type": "route", "uuid": "bf9844fe-dbf9-4e22-b8ec-eb9177472128" }, { "type": "route", "uuid": "5c96fa36-35a4-4b05-b25a-f6248c787e0e" }, { "type": "route", "uuid": "706047b5-3d2b-4302-9e87-c9454981a5e1" }, { "type": "route", "uuid": "8caddf7b-0a85-4c4c-90e0-8c71e95417f7" }, { "type": "route", "uuid": "b7af4748-2b03-4c5e-bc4c-81d578857789" }, { "type": "route", "uuid": "9b3a89f7-863f-420d-bf39-2b5d25a20891" }, { "type": "route", "uuid": "92407754-18d3-41c2-945c-9dde7d197f6b" }, { "type": "route", "uuid": "700e77db-748b-45ae-aec2-5cd2e1cc41db" }, { "type": "route", "uuid": "93f07846-89f3-41c4-9dec-8ef10202aba2" }, { "type": "route", "uuid": "8e2f1942-b244-44ff-b40e-084a6cc5a746" }, { "type": "route", "uuid": "0ff889c7-2dd3-4909-84d5-bf18fbf5b48c" }, { "type": "route", "uuid": "9526e8af-de29-4c6b-a5cd-3a1845e2e620" }, { "type": "route", "uuid": "7769e4d7-4c89-4048-b828-c3f2dc7c504f" }, { "type": "route", "uuid": "7c287012-a921-4b39-8b7f-a6a3c4e0e73d" }, { "type": "route", "uuid": "93728ba2-3991-407a-a8f0-70d888da7ea1" }, { "type": "route", "uuid": "3102c5b1-1f27-49c9-92bc-254ef524bb9d" }, { "type": "route", "uuid": "50d96321-2841-46cd-ad95-dac2f4ae786e" }, { "type": "route", "uuid": "9cf4569b-4c02-47ca-9a92-1a3ea2d94772" }, { "type": "route", "uuid": "6fd684ca-9337-4941-a752-ab5794ecf053" }, { "type": "route", "uuid": "ba5ac1be-c586-4f2e-9ab4-ab0971d2a2ce" }, { "type": "route", "uuid": "e90301ab-849e-4216-97f2-49a66676cbe6" }, { "type": "route", "uuid": "48771e9b-910b-493a-82c3-3178d932200d" }, { "type": "route", "uuid": "78415554-0682-4171-ab30-983797a73754" } ] }