This collection contains all the request for theFactor.e API. This API is used for managing all the documentation and recordings theFactor.e is creating while testing web and app designs with web visitors.
\nThe parameters in the content should be filled with your inputs. This documentation contains examples of body content and variables in the request URL.
Logs a user in.
\n","urlObject":{"path":["api","auth","login"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5b72449-013f-4ef5-b626-002f1247c2c1"},{"name":"logOut","id":"5d7b340f-7a2a-4122-b66f-6d5d5504ca33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{BearerToken}}"}],"url":"{{BaseUrl}}/api/auth/logout","description":"Logs a user out.
\n","urlObject":{"path":["api","auth","logout"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5d7b340f-7a2a-4122-b66f-6d5d5504ca33"},{"name":"user","id":"4c30e371-9811-4132-9e1c-1fda2a66ba34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{BearerToken}}","type":"text"}],"url":"{{BaseUrl}}/api/auth/user","description":"getUser will return the user that is currently logged in. If no user is logged in, it will give an 401 error: unauthorized.
This folder contains all authentication requests, for example requesting an token.
\n","event":[{"listen":"prerequest","script":{"id":"335ed157-3043-4e85-b10c-861d6c160c11","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ccf3b5c2-a52d-4218-94eb-9a0fb5fb0453","type":"text/javascript","exec":[""]}}],"_postman_id":"2347b4da-6d1a-4c89-b426-d01b4cf837ca"},{"name":"Video","item":[{"name":"getAllVideos","event":[{"listen":"test","script":{"id":"bcc43ea7-8714-4b51-ba00-de8d31fd2da9","exec":["// console.log('test: ' + data[\"linkedId\"]);","// console.log(pm.response.json().data.length);","","switch (data[\"loop\"]) {"," case 1:"," pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);"," });"," tests['JSON array is not empty'] = (pm.response.json().data.length > 0);"," break;"," "," case 2:"," pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);"," });"," tests['JSON array is not empty'] = (pm.response.json().data.length > 0);"," break;"," "," case 3:"," pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);"," });"," tests['JSON array empty'] = (pm.response.json().data.length === 0);"," break;"," "," case 4:"," pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);"," });"," tests['JSON array is empty'] = (pm.response.json().data.length === 0);"," break;","}"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"36c68a55-dde6-4fec-a8cf-636303d541a3","exec":[""],"type":"text/javascript"}}],"id":"946f94c9-a7ed-40ef-9458-390e02ae4ef7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{BearerToken}}"}],"url":"{{BaseUrl}}/api/get/video/{{projectId}}","description":"getAllVideos will return all the video in the database. If a projectId is given, it will return all the videos for that specific project.
This request contains an optional projectId parameter. This parameter specifies the ID of a project that is associated with a list of videos.
JSON Object with videos
\n","urlObject":{"path":["api","get","video","{{projectId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"946f94c9-a7ed-40ef-9458-390e02ae4ef7"},{"name":"createVideo","event":[{"listen":"test","script":{"id":"8790ef58-b1d5-4186-b305-0711dcdb3d97","exec":["// console.log('test: ' + data[\"linkedId\"]);","// console.log(Object.getOwnPropertyNames(pm.response.json().data).length);","","switch (data[\"loop\"]) {"," case 1:"," pm.test(\"Status code is 201\", function () {"," pm.response.to.have.status(201);"," });"," // tests['JSON is not empty'] = (Object.getOwnPropertyNames(pm.response.json().data).length !== 0);"," break;"," "," case 2:"," pm.test(\"Status code is 400\", function () {"," pm.response.to.have.status(400);"," });"," // tests['JSON is empty'] = (Object.getOwnPropertyNames(pm.response.json().data).length === 0);"," break;"," "," case 3:"," pm.test(\"Status code is 400\", function () {"," pm.response.to.have.status(400);"," });"," "," break;"," "," case 4:"," pm.test(\"Status code is 400\", function () {"," pm.response.to.have.status(400);"," });"," "," break;","}"],"type":"text/javascript"}}],"id":"4abe8ec7-db9f-4bd3-8a0e-fe8c72efcb12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{BearerToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"project_id\": {{int}},\n\t\"name\": \"{{string}}\",\n\t\"link\": \"{{string}}\",\n\t\"test_person\": \"{{string}}\"\n}"},"url":"{{BaseUrl}}/api/create/video","description":"createVideo will create a video for a specific project.
The variable project_id specifies the ID of a project that can be associated with a list of videos.
The variable name specifies the name of the video that is added.
The variable link specifies the link where the video is stored.
The variable test_person specifies the name of the person who tested the application.
JSON Object with the created video
\n","urlObject":{"path":["api","create","video"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4abe8ec7-db9f-4bd3-8a0e-fe8c72efcb12"},{"name":"updateVideo","event":[{"listen":"test","script":{"id":"3f4f9c19-ee94-4b30-98e7-87f8ce4fd392","exec":["// console.log('test: ' + data[\"linkedId\"]);","// console.log(Object.getOwnPropertyNames(pm.response.json().data).length);","","switch (data[\"loop\"]) {"," case 1:"," pm.test(\"Status code is 201\", function () {"," pm.response.to.have.status(201);"," });"," // tests['JSON is not empty'] = (Object.getOwnPropertyNames(pm.response.json().data).length !== 0);"," break;"," "," case 2:"," pm.test(\"Status code is 400\", function () {"," pm.response.to.have.status(400);"," });"," // tests['JSON is empty'] = (Object.getOwnPropertyNames(pm.response.json().data).length === 0);"," break;"," "," case 3:"," pm.test(\"Status code is 400\", function () {"," pm.response.to.have.status(400);"," });"," "," break;"," "," case 4:"," pm.test(\"Status code is 400\", function () {"," pm.response.to.have.status(400);"," });"," "," break;","}"],"type":"text/javascript"}}],"id":"8ef58e4c-b9eb-4546-a6a1-a3f0c7001a21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{BearerToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"project_id\": {{int}},\r\n\t\"name\": \"{{string}}\",\r\n\t\"link\": \"{{string}}\",\r\n\t\"test_person\": \"{{string}}\"\r\n}"},"url":"{{BaseUrl}}/api/update/video/{{videoId}}","description":"updateVideo will update a video for a specific project.
The parameter videoId specifies the ID of the to be updated video.
The variable project_id specifies the ID of a project that can be associated with a list of videos.
The variable name specifies the name of the video that is added.
The variable link specifies the link where the video is stored.
The variable test_person specifies the name of the person who tested the application.
JSON Object with the updated video properties
\n","urlObject":{"path":["api","update","video","{{videoId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8ef58e4c-b9eb-4546-a6a1-a3f0c7001a21"},{"name":"deleteVideo","id":"f1c1ba2b-772f-469b-8b2b-b1f036803e2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BearerToken}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Bearer {{BearerToken}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"body":{"mode":"formdata","formdata":[]},"url":"{{BaseUrl}}/api/delete/video/{{videoId}}","description":"deleteVideo will delete a video.
The parameter videoId specifies the ID of the to be deleted video.
JSON Object with a success or failure message
\n","urlObject":{"path":["api","delete","video","{{videoId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f1c1ba2b-772f-469b-8b2b-b1f036803e2b"}],"id":"4c24d3f5-ee5b-4135-8d96-b85dc255c344","description":"This folder contains all the video requests
\n","_postman_id":"4c24d3f5-ee5b-4135-8d96-b85dc255c344"},{"name":"Project","item":[{"name":"getAllProjects","id":"dbb00e1a-d2b7-4d97-8632-1231bf99b581","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{BearerToken}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{BaseUrl}}/api/get/project/{{companyId}}","description":"getAllProjects will return all the projects in the database. If a companyId is given, it will return all the videos for that specific company.
This request contains an optional companyId parameter. This parameter specifies the ID of a company that is associated with a list of projects.
JSON Object with projects
\n","urlObject":{"path":["api","get","project","{{companyId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dbb00e1a-d2b7-4d97-8632-1231bf99b581"},{"name":"createProject","id":"5bda86a7-16ec-476a-a2be-fd44a00c7747","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{BearerToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"company_id\": 4,\r\n\t\"name\": \"exampleName\",\r\n\t\"status\": 1,\r\n\t\"last_updated_by\": 3\r\n}"},"url":"{{BaseUrl}}/api/create/project","description":"createProject will create a project for a specific company.
The variable company_id specifies the ID of a company that is associated with a list of projects.
The variable name specifies the name of the company that is added.
The variable status specifies the status of the project.
The variable last_updated_by specifies the user ID of the person who last worked on this project.
JSON Object with the created project
\n","urlObject":{"path":["api","create","project"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5bda86a7-16ec-476a-a2be-fd44a00c7747"},{"name":"updateProject","event":[{"listen":"prerequest","script":{"id":"f0d18fbb-2dc3-4527-be6b-81cc9b3988a2","exec":[""],"type":"text/javascript"}}],"id":"94c0ec45-6b17-435e-88a5-8a4f547c38c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{BearerToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"company_id\": 5,\r\n\t\"name\": \"exampleName\",\r\n\t\"status\": 1,\r\n\t\"last_updated_by\": 3\r\n}"},"url":"{{BaseUrl}}/api/update/project/{{projectId}}","description":"updateProject will update a project for a specific company.
The parameter projecId specifies the ID of the to be deleted project.
The variable company_id specifies the ID of a company that is associated with a list of projects.
The variable name specifies the name of the company that is added.
The variable status specifies the status of the project.
The variable last_updated_by specifies the user ID of the person who last worked on this project.
JSON Object with the updated project properties
\n","urlObject":{"path":["api","update","project","{{projectId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"94c0ec45-6b17-435e-88a5-8a4f547c38c8"},{"name":"deleteProject","id":"0226770d-5389-4b2f-9ae7-d90caf693e7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{BearerToken}}","type":"text"}],"url":"{{BaseUrl}}/api/delete/project/{{projectId}}","description":"deleteProject will delete a project.
The parameter projecId specifies the ID of the to be deleted project.
JSON Object with a success or failure message
\n","urlObject":{"path":["api","delete","project","{{projectId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0226770d-5389-4b2f-9ae7-d90caf693e7e"}],"id":"619a6f07-7072-4461-a735-d6784bfb52bb","description":"This folder contains all project requests
\n","_postman_id":"619a6f07-7072-4461-a735-d6784bfb52bb"},{"name":"Note","item":[{"name":"getAllNotes","id":"703441bb-09f2-4b7e-9236-a1a4e217e193","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{BearerToken}}","type":"text"}],"url":"{{BaseUrl}}/api/get/note/{{projectId}}","description":"getAllNotes will return all the the notes in the database. If a projectId is given, it will return all the notes for that specific project.
This request contains an optional projectId parameter. This parameter specifies the ID of a project that is associated with a list of notes.
JSON Object with notes
\n","urlObject":{"path":["api","get","note","{{projectId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"703441bb-09f2-4b7e-9236-a1a4e217e193"},{"name":"createNote","id":"938a15bd-87d9-416a-b528-be1d806486fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{BearerToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"project_id\": 3,\n\t\"title\": \"exampleTitle\",\n\t\"content\": \"exampleContent\"\n}"},"url":"{{BaseUrl}}/api/create/note","description":"createNote will create a note for a specific project.
The variable project_id specifies the ID of a project that can be associated with a list of videos.
The variable title specifies the title of the note that is added.
The variable content specifies the content of the note.
JSON Object with the created note
\n","urlObject":{"path":["api","create","note"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"938a15bd-87d9-416a-b528-be1d806486fe"},{"name":"updateNote","id":"2a8bcaee-9d25-43c7-b50e-25d305e34f20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{BearerToken}}"}],"body":{"mode":"raw","raw":"{\n\t\"project_id\": 3,\n\t\"tittle\": \"exampleTitle\",\n\t\"content\": \"exampleContent\"\n}"},"url":"{{BaseUrl}}/api/update/note/{{noteId}}","description":"updateNote will update a note for a specific project.
The parameter noteId specifies the ID of the to be deleted note.
The variable project_id specifies the ID of a project that can be associated with a list of videos.
The variable title specifies the title of the note that is added.
The variable content specifies the content of the note.
JSON Object with the updated note properties
\n","urlObject":{"path":["api","update","note","{{noteId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2a8bcaee-9d25-43c7-b50e-25d305e34f20"},{"name":"deleteNote","id":"ee475de1-f522-41ca-aad6-d0691663cace","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Bearer {{BearerToken}}"}],"url":"{{BaseUrl}}/api/delete/note/{{noteId}}","description":"deleteNote will delete a note.
The parameter noteId specifies the ID of the to be deleted note.
JSON Object with a success or failure message
\n","urlObject":{"path":["api","delete","note","{{noteId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ee475de1-f522-41ca-aad6-d0691663cace"}],"id":"a1e8d679-ed60-497d-a83d-5607387fd613","description":"This folder contains all project requests
\n","_postman_id":"a1e8d679-ed60-497d-a83d-5607387fd613"},{"name":"Company","item":[{"name":"getAllCompanies","id":"ef035a8b-01d3-4995-987b-2d105191745e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{BearerToken}}","type":"text"}],"url":"{{BaseUrl}}/api/get/company","description":"getAllCompanies will return all the the companies in the database.
JSON Object with notes
\n","urlObject":{"path":["api","get","company"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef035a8b-01d3-4995-987b-2d105191745e"},{"name":"createCompany","id":"34b1693e-c476-4c06-93ff-92dd6c3114bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{BearerToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"name\": \"exampleName\", \r\n\t\"address\": \"exampleAddress\",\r\n\t\"phone\": \"examplePhone\",\r\n\t\"email\": \"exampleEmail\",\r\n\t\"image\": \"\"\r\n}"},"url":"{{BaseUrl}}/api/create/company","description":"createCompany will create a company.
The variable name specifies the name of the video that is added.
The variable address specifies the address of the company.
The variable phone specifies the phone number of the company.
The variable email specifies the e-mail address of the company.
The variable image specifies an image of the company.
JSON Object with the created video
\n","urlObject":{"path":["api","create","company"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"34b1693e-c476-4c06-93ff-92dd6c3114bd"},{"name":"updateCompany","id":"fd58238c-c8fc-4cf9-9110-098403d25e20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{BearerToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"name\": \"exampleName\", \r\n\t\"address\": \"exampleAddress\",\r\n\t\"phone\": \"examplePhone\",\r\n\t\"email\": \"exampleEmail\",\r\n\t\"image\": \"https://placekitten.com/200/300\"\r\n}"},"url":"{{BaseUrl}}/api/update/company/{{companyId}}","description":"updateCompany will update a company.
The parameter companyId specifies the ID of the to be deleted company.
The variable name specifies the name of the video that is added.
The variable address specifies the address of the company.
The variable phone specifies the phone number of the company.
The variable email specifies the e-mail address of the company.
The variable image specifies an image of the company.
JSON Object with the updated company properties
\n","urlObject":{"path":["api","update","company","{{companyId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fd58238c-c8fc-4cf9-9110-098403d25e20"},{"name":"deleteCompany","id":"a84f7ee9-7708-4bd1-a761-f765b14a6915","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[],"url":"{{BaseUrl}}/api/delete/company/{{companyId}}","description":"deleteCompany will delete a company.
The parameter companyId specifies the ID of the to be deleted company.
JSON Object with a success or failure message
\n","urlObject":{"path":["api","delete","company","{{companyId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a84f7ee9-7708-4bd1-a761-f765b14a6915"}],"id":"7f19b2b2-a01a-4e17-ba53-b9ba80d8a848","description":"This folder contains all project requests
\n","event":[{"listen":"prerequest","script":{"id":"40229a39-8902-40de-b36f-2a580713b7de","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fa8d8ef3-abb9-4779-ada6-df79204ae717","type":"text/javascript","exec":[""]}}],"_postman_id":"7f19b2b2-a01a-4e17-ba53-b9ba80d8a848"},{"name":"VideoNote","item":[{"name":"getAllVideoNotes","id":"55f833d1-e235-4fb8-94d8-67095224fb9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{BearerToken}}","type":"text"}],"url":"{{BaseUrl}}/api/get/video-note/{{videoId}}","description":"getAllVideoNotes will return all the the notes for a specific video if a videoId is given.
The parameter videoId specifies the ID of a video that is associated with a list of notes.
JSON Object with notes associated with a video
\n","urlObject":{"path":["api","get","video-note","{{videoId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"55f833d1-e235-4fb8-94d8-67095224fb9a"},{"name":"createVideoNote","id":"eb83aee3-89cd-499b-96ae-82ee83520640","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","type":"text","value":"Bearer {{BearerToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"video_id\": 2,\r\n\t\"content\": \"exampleContent\",\r\n\t\"timestamp\": 5.345,\r\n\t\"type\": 1\r\n}"},"url":"{{BaseUrl}}/api/create/video-note","description":"createVideoNote will create a note for a specific video.
The variable video_id specifies the ID of a video that can be associated with a list of notes.
The variable content specifies the content of the note.
The variable timestamp specifies the moment of when the note was added.
The variable type specifies the type of the note that is added.
JSON Object with the created note
\n","urlObject":{"path":["api","create","video-note"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"eb83aee3-89cd-499b-96ae-82ee83520640"},{"name":"updateVideoNote","id":"7f92d171-6890-4042-bed8-f5b62fd1babb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","type":"text","value":"Bearer {{BearerToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"video_id\": 2,\r\n\t\"content\": \"exampleContent\",\r\n\t\"timestamp\": 5.345,\r\n\t\"type\": 1\r\n}"},"url":"{{BaseUrl}}/api/update/video-note/{{videoNoteId}}","description":"updateVideoNote will update a note for a specific video.
The parameter videNoteId specifies the ID of the to be deleted video note.
The variable video_id specifies the ID of a video that can be associated with a list of notes.
The variable content specifies the content of the note.
The variable timestamp specifies the moment of when the note was added.
The variable type specifies the type of the note that is added.
JSON Object with the updated video note properties
\n","urlObject":{"path":["api","update","video-note","{{videoNoteId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7f92d171-6890-4042-bed8-f5b62fd1babb"},{"name":"deleteVideoNote","id":"6045f6fc-a785-40f1-aa11-753adec62a85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Bearer {{BearerToken}}"}],"url":"{{BaseUrl}}/api/delete/video-note/{{videoNoteId}}","description":"deleteVideoNote will delete a video note.
The parameter videNoteId specifies the ID of the to be deleted video note.
JSON Object with a success or failure message
\n","urlObject":{"path":["api","delete","video-note","{{videoNoteId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6045f6fc-a785-40f1-aa11-753adec62a85"}],"id":"cd6bcf06-39b8-401b-a47a-7c322ef37677","_postman_id":"cd6bcf06-39b8-401b-a47a-7c322ef37677","description":""},{"name":"Tag","item":[{"name":"getAllTags","id":"ea73e5a7-d7ed-4183-a3e4-b9acca62762c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{BearerToken}}"}],"url":"{{BaseUrl}}/api/get-all-tags/{{type}/{{typeId}}","description":"getAllTags will return all the tags that belong to a specific video or project. If there are no tags to be found, it will return an empty list.
The variable type specifies which tags need to be returned. There are only two inputs: video and project. Other inputs than these will result in an error.
The variable typeId specifies the ID of the video or project. Non-existing videos or projects will result in an error.
JSON Object with tags for a specific video or project
\n","urlObject":{"path":["api","get-all-tags","{{type}","{{typeId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"08807548-c1c1-46ac-99fd-33f83bcf55e2","name":"getAllTags (video 1)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json","disabled":true},{"key":"Authorization","type":"text","value":"Bearer {{BearerToken}}","disabled":true}],"url":"{{BaseUrl}}/api/get-all-tags/video/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ea73e5a7-d7ed-4183-a3e4-b9acca62762c"},{"name":"createTag","id":"7073b60d-d4df-4c88-be5b-391a1493557c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{BearerToken}}"}],"body":{"mode":"raw","raw":"{\n\t\"tag\": \"{{tagName}}\"\n}"},"url":"{{BaseUrl}}/api/create-tag/{{type}}/{{typeId}}","description":"createTag will create a tag for a specific video or project. If that tag already exists, no new tag will be made, there will only be a connection made between that existing tag and the video or project. The tag that needs to be created or connected is specified in the body, as seen down below.
The variable type specifies which tags need to be returned. There are only two inputs: video and project. Other inputs than these will result in an error.
The variable typeId specifies the ID of the video or project. Non-existing videos or projects will result in an error.
JSON Object with the added or connected tag
\n","urlObject":{"path":["api","create-tag","{{type}}","{{typeId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"67b91b4f-1653-4125-9476-e5027c994a70","name":"createTag (project 5 \"Leeuwarden\")","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{BearerToken}}"}],"body":{"mode":"raw","raw":"{\n\t\"tag\": \"Leeuwarden\"\n}"},"url":"{{BaseUrl}}/api/create-tag/project/5"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"7073b60d-d4df-4c88-be5b-391a1493557c"},{"name":"deleteTag","id":"2f672c6c-3f2e-45c3-b87b-b06ec2fcd1c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{BearerToken}}"}],"url":"{{BaseUrl}}/api/delete-tag/{{type}}/{{typeId}}/{{tagId}}","description":"deleteTag will delete a tag for a specific video or project, but only if that tag is not used elsewhere. If that tag however is used elsewhere, it will only disconnect it from the specified video or project.
The variable type specifies which tags need to be returned. There are only two inputs: video and project. Other inputs than these will result in an error.
The variable typeId specifies the ID of the video or project. Non-existing videos or projects will result in an error.
The variable tagId specifies the ID of the targeted tag. Non-existing tags will result in an error.
JSON Object with the disconnected or deleted tag
\n","urlObject":{"path":["api","delete-tag","{{type}}","{{typeId}}","{{tagId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2f672c6c-3f2e-45c3-b87b-b06ec2fcd1c5"}],"id":"e9f0663e-d2a1-433a-8c34-afb82ec5429d","_postman_id":"e9f0663e-d2a1-433a-8c34-afb82ec5429d","description":""},{"name":"Version","item":[{"name":"getVersion","id":"24da7467-65f8-45f9-a750-9c1ae8b2b90d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{BaseUrl}}/api/get-version","description":"getVersion will return the current version number from the .env file. If something goes wrong getting the version number, it will return an empty string.
JSON Object with the version number
\n","urlObject":{"path":["api","get-version"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"24da7467-65f8-45f9-a750-9c1ae8b2b90d"}],"id":"c5482f7b-8d76-44ca-8980-63fbfc529471","_postman_id":"c5482f7b-8d76-44ca-8980-63fbfc529471","description":""}],"event":[{"listen":"prerequest","script":{"id":"5692f5a6-69c1-49da-952a-aa570b6b14d3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fc17c9fa-d786-4bb1-91b3-397a9f8bc7b4","type":"text/javascript","exec":[""]}}]}