The GitScrum API gives users the ability to assign Youtube videos to Tasks. It provides endpoints for managing, creating and editing these videos, as well as other related resources.
Users can access the API and its features to keep track of all their tasks and videos.
| GET |
/videos |
| POST |
/videos |
| GET |
/videos/:slug |
| DELETE |
/videos/:slug |
Attributes
uuid STRING
Unique identifier for the task video object.
title STRING
The title of a video on YouTube is an attribute that is used to easily identify and reference the video. The title is not editable, as it is automatically generated by YouTube when the video is uploaded. The title may be composed of keywords related to the topic of the video or the creator’s name, or it may simply be descriptive of what is in the video. This helps viewers find relevant videos quickly when searching on YouTube.
resource STRING
The resource attribute of a task video is an object that contains information about the task. The object typically includes two key-value pairs, type and uuid, which describe the type of task and its unique identifier. For example, the resource attribute for a task may look like this: { type: task, uuid: 39579ac6-c93c-4c13-8c8e-da0e7f5ebc8f }. These two key-value pairs provide the necessary information to identify the specific task within the system.
video_id STRING
The video_id attribute is a unique identifier for a video stored in a string format as a UUID (Universally Unique Identifier). This attribute can be used to track a specific video and its associated data, making it an important attribute when categorizing video files and organizing video data.
url STRING
The url attribute of a task video is a string containing the URL of a video hosted on YouTube. This attribute is used to link to the video hosted on YouTube, so it can be viewed or interacted with by a user.
More Attributes
{
"id": number,
"uuid": number,
"resource": object,
"video_id": string,
"url": string,
"title": string,
"thumbnail": string,
"user": object,
"created_at": object
}The GitScrum API's Create Task Video endpoint enables users to append Youtube videos to a task by utilizing a POST request.
Parameters
youtube_url STRING REQUIRED
The youtube_url parameter should provide a valid and publicly available YouTube video URL.
task_uuid STRING REQUIRED
The task_uuid is a universally unique identifier (UUID) that identifies a particular task.
POST /videos
{
"data": {
"id": 950,
"uuid": 950,
"resource": {
"type": "task",
"uuid": "39579ac6-c93c-4c13-8c8e-da0e7f5ebc8f"
},
"video_id": "Eurq9un3tRM",
"url": "https://www.youtube.com/watch?v=Eurq9un3tRM",
"title": "Stop Overthinking - Lofi hip hop mix ~ Deep Focus, Meditation Music",
"thumbnail": "//img.youtube.com/vi/Eurq9un3tRM/1.jpg",
"user": {
"name": "Renato Marinho de Carvalho",
"headline": "GitScrum Founder",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/5467e2bdd31886166112fea09debe9f72aae06dd.png",
"location": "Lisbon",
"timezone_id": 29,
"timezone_name": "Europe/Lisbon",
"since": "October 2019"
},
"created_at": {
"date_for_humans": "12 seconds ago",
"timezone": "2023-05-10 13:10:02",
"timestamp": 1683724202
}
}
}The Retrieve a Task Videos resource of the GitScrum API enables users to access information about a specific video associated with a Task by providing its unique Slug. This Slug can be obtained from a request for creating a new Task Video or from the list of existing Task Videos, upon which GitScrum will return relevant details.
Parameters
No parameters.
Returns
Returns a task object if a valid identifier is supplied.
GET /videos/:slug
{
"data": {
"id": 950,
"uuid": 950,
"resource": {
"type": "task",
"uuid": "39579ac6-c93c-4c13-8c8e-da0e7f5ebc8f"
},
"video_id": "Eurq9un3tRM",
"url": "https://www.youtube.com/watch?v=Eurq9un3tRM",
"title": "Stop Overthinking - Lofi hip hop mix ~ Deep Focus, Meditation Music",
"thumbnail": "//img.youtube.com/vi/Eurq9un3tRM/1.jpg",
"user": {
"name": "Renato Marinho de Carvalho",
"headline": "GitScrum Founder",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/5467e2bdd31886166112fea09debe9f72aae06dd.png",
"location": "Lisbon",
"timezone_id": 29,
"timezone_name": "Europe/Lisbon",
"since": "October 2019"
},
"created_at": {
"date_for_humans": "12 seconds ago",
"timezone": "2023-05-10 13:10:02",
"timestamp": 1683724202
}
}
}Return a sorted list of your Task Videos, with the most recently created Task Videos appearing first, using a GET request.
Parameters
task_uuid STRING REQUIRED
The Task UUID is a universally unique identifier (UUID) that identifies a particular task.
page NUMBER OPTIONAL
The page parameter can be used in subsequent calls to access additional pages of results after the initial page. It allows for pagination, allowing the user to navigate through multiple pages of search results.
GET /videos
{
"data": [
{ ... },
{ ... },
{ ... }
],
"total": 20,
"count": 20,
"per_page": 15,
"current_page": 1,
"total_pages": 2
}