Sample Todo / Home
Overview

Sample Todo API

A REST API generated from your data model. Start with the model below — click any entity to open its attributes and endpoints.

Entity relationship model
%%{init: {'theme':'neutral'}}%%
erDiagram
  TASK

Rendered with Mermaid — a filled end marks the “one” side, a branched end the “many”.

Entity

Task

A task in the application.

Attributes
FieldTypeNotes
id uuid
created_at datetime
updated_at datetime
title string The display title.
description string A short description.
document attachment The document.
photo attachment The photo.
Relationships
%%{init: {'theme':'neutral'}}%%
erDiagram
  TASK

Task and its direct relationships.

Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›
Endpoint
GET /tasks

List Task records.

Response 200 OK
[ { "id": "uuid", "created_at": "datetime", "updated_at": "datetime", "title": "Sample Title", "description": "A short description.", "document": "example.pdf", "photo": "example.pdf" } ]
Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›
Endpoint
POST /tasks

Create Task.

Request body
{ "title": "Sample Title", "description": "A short description.", "document": "example.pdf", "photo": "example.pdf" }
Response 201 Created
{ "id": "uuid", "created_at": "datetime", "updated_at": "datetime", "title": "Sample Title", "description": "A short description.", "document": "example.pdf", "photo": "example.pdf" }
Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›
Endpoint
DELETE /tasks

Delete Task records by id.

Request body
{ "ids": [ "uuid", "uuid" ] }
Response 200 OK
{ "deleted": [ "uuid" ], "not_found": [ "uuid" ], "failed": [] }
Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›
Endpoint
GET /tasks/:id

Return Task by id.

Response 200 OK
{ "id": "uuid", "created_at": "datetime", "updated_at": "datetime", "title": "Sample Title", "description": "A short description.", "document": "example.pdf", "photo": "example.pdf" }
Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›
Endpoint
PATCH /tasks/:id

Update Task.

Request body
{ "title": "Sample Title", "description": "A short description.", "document": "example.pdf", "photo": "example.pdf" }
Response 200 OK
{ "id": "uuid", "created_at": "datetime", "updated_at": "datetime", "title": "Sample Title", "description": "A short description.", "document": "example.pdf", "photo": "example.pdf" }
Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›
Endpoint
PUT /tasks/:id

Link Task.

Response

204 No Content — no body.

Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›
Endpoint
DELETE /tasks/:id

Delete Task.

Response

204 No Content — no body.

Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›
Endpoint
POST /tasks/:id/document

Task endpoint.

Response 200 OK
{ "id": "uuid", "created_at": "datetime", "updated_at": "datetime", "title": "Sample Title", "description": "A short description.", "document": "example.pdf", "photo": "example.pdf" }
Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›
Endpoint
GET /tasks/:id/document

Task endpoint.

Response 200 OK
{ "id": "uuid", "created_at": "datetime", "updated_at": "datetime", "title": "Sample Title", "description": "A short description.", "document": "example.pdf", "photo": "example.pdf" }
Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›
Endpoint
GET /tasks/:id/document/content

Task endpoint.

Response 200 OK
{ "id": "uuid", "created_at": "datetime", "updated_at": "datetime", "title": "Sample Title", "description": "A short description.", "document": "example.pdf", "photo": "example.pdf" }
Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›
Endpoint
DELETE /tasks/:id/document

Task endpoint.

Response 200 OK
{ "id": "uuid", "created_at": "datetime", "updated_at": "datetime", "title": "Sample Title", "description": "A short description.", "document": "example.pdf", "photo": "example.pdf" }
Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›
Endpoint
POST /tasks/:id/photo

Task endpoint.

Response 200 OK
{ "id": "uuid", "created_at": "datetime", "updated_at": "datetime", "title": "Sample Title", "description": "A short description.", "document": "example.pdf", "photo": "example.pdf" }
Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›
Endpoint
GET /tasks/:id/photo

Task endpoint.

Response 200 OK
{ "id": "uuid", "created_at": "datetime", "updated_at": "datetime", "title": "Sample Title", "description": "A short description.", "document": "example.pdf", "photo": "example.pdf" }
Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›
Endpoint
GET /tasks/:id/photo/content

Task endpoint.

Response 200 OK
{ "id": "uuid", "created_at": "datetime", "updated_at": "datetime", "title": "Sample Title", "description": "A short description.", "document": "example.pdf", "photo": "example.pdf" }
Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›
Endpoint
DELETE /tasks/:id/photo

Task endpoint.

Response 200 OK
{ "id": "uuid", "created_at": "datetime", "updated_at": "datetime", "title": "Sample Title", "description": "A short description.", "document": "example.pdf", "photo": "example.pdf" }
Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›
Endpoint
GET /tasks/aggregate

Count Task records.

Response 200 OK
{ "count": 0 }
Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›
Endpoint
HEAD /tasks

Return the Task list's headers.

Response

200 OK — no body.

Endpoints
GET /tasks List Task records. ›
POST /tasks Create Task. ›
DELETE /tasks Delete Task records by id. ›
GET /tasks/:id Return Task by id. ›
PATCH /tasks/:id Update Task. ›
PUT /tasks/:id Link Task. ›
DELETE /tasks/:id Delete Task. ›
POST /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document Task endpoint. ›
GET /tasks/:id/document/content Task endpoint. ›
DELETE /tasks/:id/document Task endpoint. ›
POST /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo Task endpoint. ›
GET /tasks/:id/photo/content Task endpoint. ›
DELETE /tasks/:id/photo Task endpoint. ›
GET /tasks/aggregate Count Task records. ›
HEAD /tasks Return the Task list's headers. ›