task-scheduler

A simple RESTful app that lets you input and schedule tasks.

Scheduling Procedure

1. Create a Project Plan
2. Add tasks to Project Plan
3. Create Schedule

Environment Setup

These environment variables are required to make this application work:

Variable	Description	Example Value
DB_DRIVER_DEPENDENCY	The maven artifact for your database driver. In gradle format	org.postgresql:postgresql:42.2.2
DB_URL	JDBC-compatible connection string.	jdbc:postgresql://localhost:5432/task_scheduler
DB_USERNAME	The username used to connect to the database.	myname
DB_PASSWORD	The password used to connect to the database.	str0nk_p@ssW0rd*1234

REST Endpoints

Project Plan

// Example Project Plan Entity
{
  "id": 1,
  "name": "Plan Name"
}

Show all project plans

• URL: GET /api/v1/plan
• Response: List of Project Plan Entities

Show project plan

• URL: GET /api/v1/plan/{id}
  • {id} - A valid plan ID
• Response: A single Project Plan Entity

Create project plan

• URL: POST /api/v1/plan
• Body: A Project Plan Entity (Without the id)
• Response: The created Project Plan Entity

Task

// Example Task Entity
{
  "id": 3,
  "name": "Task Name",
  "dayDuration": 1,
  "dependencyIds": [1, 2]
}

Show all tasks

• URL: GET /api/v1/plan/{planId}/task
  • {planId} - The plan ID where the tasks will be fetched from.
• Response: List of Task Entities

Show task

• URL: GET /api/v1/plan/{planId}/task/{taskId}
  • {planId} - The plan ID where the task will be fetched from.
  • {taskId} - A valid task ID that belongs to the given planId
• Response: A single Task Entity

Create Task

• URL: POST /api/v1/plan/{planId}
  • {planId} - The plan ID where the task will belong to.
• Body: A Task Entity (Without the id)
• Response: The created Task Entity

Schedule

Create Schedule

• URL: POST /api/v1/schedule

• Body:

  {
    "planId": 1,
    "startDate": "2018-07-14"
  }

  Field	Description
  planId	The ID of the plan where the tasks are scheduled from.
  startDate	Date in yyyy-mm-dd format where the schedule will start.

• Response:

  {
    "plan": {
      "id": 1,
      "name": "Plan Name"
    },
    "startDate": "2018-07-14",
    "tasks": [
        {
          "task": {
            "id": 1,
            "name": "Sample Task #1",
            "dayDuration": 1
          },
          "startDate": "2018-07-14",
          "endDate": "2018-07-15"
        },
        {
          "task": {
            "id": 2,
            "name": "Sample Task #2",
            "dayDuration": 2
          },
          "startDate": "2018-07-15",
          "endDate": "2018-07-17"
        }
    ]
  }