tasks

Tasks

Task object

{
  "title": "Title of the task",
  "purpose": "<why is this task needed>",
  "featureUrl": "<live url of the feature>",
  "type":"Dev | Group",
  "links": [
    <link1>,
    <link2>
  ],
  "endsOn":"<unix timestamp>",
  "startedOn":"<unix timestamp>",
  "status": "Active",
  "ownerId":"<app owner user id>",
  "percentCompleted":10,
  "dependsOn": [
    <task_id>,
    <task_id>
  ],
  "participants": [
    <user_id>
    <user_id>
  ],
  "completionAward": { gold: 3, bronze: 300 },
  "lossRate": { gold: 1 }  // Loss per day of overshoot after deadline,
  'isNoteworthy': true
}

Requests

Route	Description
GET /tasks	Returns all tasks
GET /tasks/self	Returns all tasks of a user
POST /tasks	Creates new task
PATCH /tasks/:id	Updates tasks

GET /tasks

Returns all the tasks

• Params
  None
• Query
  None
• Body
  None
• Headers
  None
• Cookie
  None
• Success Response:
• Code: 200
  • Content:

{
  message: 'Tasks returned successfully!'
  tasks: [
           {<task_object>},
           {<task_object>}
         ]
}

• Error Response:
  • Code: 500
    • Content: { 'statusCode': 500, 'error': 'Internal Server Error', 'message': 'An internal server error occurred' }

GET /tasks/self

Returns all the completed tasks of user if query completed=true is passed, else returns all the active and blocked tasks of the user.

• Params
  None
• Query
  completed=[boolean]
• Body
  None
• Headers
  Content-Type: application/json
• Cookie
  rds-session: <JWT>
• Success Response:
  • Code: 200
    • Content:

[
  {<task_object>},
  {<task_object>},
  {<task_object>},
  {<task_object>},
  {<task_object>}
]

• Error Response:
  • Code: 401
    • Content: { 'statusCode': 401, 'error': 'Unauthorized', 'message': 'Unauthenticated User' }
  • Code: 404
    • Content: { 'statusCode': 404, 'error': 'Not Found', 'message': 'User doesn't exist' }
  • Code: 500
    • Content: { 'statusCode': 500, 'error': 'Internal Server Error', 'message': 'An internal server error occurred' }

POST /tasks

• Params
  None
• Query
  None
• Headers
  Content-Type: application/json
• Body { <task_object> }
• Success Response:
• Code: 200
  • Content:

{
  message: 'Task created successfully!'
  task: {<task_object>}
  id: <newly created task id>
}

• Error Response:
  • Code: 500
    • Content: { 'statusCode': 500, 'error': 'Internal Server Error', 'message': 'An internal server error occurred' }

PATCH /tasks/:id

• Params
  Required: id=[string]

• Headers
  Content-Type: application/json

• Body { <task_object> }

• Success Response:

• Code: 204

  • Content: <No Content>

• Error Response:

  • Code 404
    • Content { 'statusCode': 404, 'error': 'Not found', 'message': 'No tasks found' }
  • Code: 500
    • Content: { 'statusCode': 500, 'error': 'Internal Server Error', 'message': 'An internal server error occurred' }