Task API

Task API provides basic means for task management.
More information: https://black32167.github.io/social_api
Contact Info: none@nowhere
Version: 0.0.1
BasePath:/v1
MIT license
https://opensource.org/licenses/MIT

Access

  1. HTTP Basic Authentication
  2. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

Task

Task

Up 
post /task
Creates task (createTask)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Task Task (required)
Body Parameter —

Return type

Task

Example data

Content-Type: application/json
{
  "title" : "Build the spaceship",
  "creator" : "John",
  "assignee" : "Jane"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created Task
Up 
get /task/{taskId}
Returns a task. (getTask)

Path parameters

taskId (required)
Path Parameter — task identifier default: null

Return type

Task

Example data

Content-Type: application/json
{
  "title" : "Build the spaceship",
  "creator" : "John",
  "assignee" : "Jane"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

task Task
Up 
get /task
Returns a list of tasks. (getTasks)

Query parameters

filter (optional)
Query Parameter — default: null

Return type

Tasks

Example data

Content-Type: application/json
{
  "items" : [ {
    "title" : "Build the spaceship",
    "creator" : "John",
    "assignee" : "Jane"
  }, {
    "title" : "Colonize Mars",
    "creator" : "Jane",
    "assignee" : "John"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

list of tasks Tasks

Models

[ Jump to Methods ]

Table of Contents

  1. Task -
  2. Tasks -

Task - Up

id (optional)
String
title (optional)
String
creator (optional)
String
assignee (optional)
String

Tasks - Up

tasks (optional)
array[Task]