Skip to main content

Job Management API (1.0.0)

Download OpenAPI specification:Download

API for managing job in a to-do list application.

Retrieve all jobs

Returns a list of jobs.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new job

Adds a job to the to-do list.

Request Body schema: application/json
required
title
required
string

The title of the job

description
string

The details of the job

dueDate
string <date-time>

The due date of the job

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "dueDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "description": "string",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "completed": true
}

Retrieve a specific job

Returns a job by its ID.

path Parameters
jobId
required
string

The ID of the job to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "description": "string",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "completed": true
}

Update a specific job

Updates the details of a job by its ID.

path Parameters
jobId
required
string

The ID of the job to update

Request Body schema: application/json
required
title
required
string

The title of the job

description
string

The details of the job

dueDate
string <date-time>

The due date of the job

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "dueDate": "2019-08-24T14:15:22Z"
}

Delete a specific job

Removes a job from the list.

path Parameters
jobId
required
string

The ID of the job to delete

Responses