Manage data

This module will allow you to create a full-fledged application for managing reminders. Create reminders, attach images, manage tags, set deadlines, and use flexible post search.

The functionality of this part module repeats that used on MacOS. You can make the application interface similar to that in MacOS.

1. Get module in Postman collection

ToDo | Migrate.runPostman

2. CRUD reminders

Create

This is a simple POST request with a JSON object, which will be listed below.

{
  "title": "Call to John",
  "description": "Discuss task details",
  "priority": "medium",
  "tags": ["work", "meeting", "backend"],
  "scheduledAt": "2023-09-01 16:30:00"
}

The priority field can contain the following values: low, medium, high

The tags field can contain an array of up to 10 elements. This can be any string value up to 50 characters long.

The scheduledAt field can contain a date in the format Y-m-d H:i:s . This field is required to set a task deadline.

Read

You can get a list of reminders using this request. Since the reminder entity has few fields, you will not find an request for getting a specific entity by ID.

The response will cotain a list of reminders, sorted and with a maximum limit of 100 entries per request. Below we will look at all the parameters for this request that are specified in Postman.

• page - Page number for pagination

• limit - Limit of records for page (max 100)

• isCompleted - Filter by this attribute

• scheduledAtFrom - ****date in the format Y-m-d H:i:s

• scheduledAtTo - date in the format Y-m-d H:i:s

• priority - field can contain the following values: low, medium, high

Update

The set of fields is identical to those used to create a record, with the exception of one field:

• isCompleted - boolean value

Delete

Nothing special. Use this request.

3. Common requests

Search

Use this request to search for reminders.

The searchQuery parameter can contain a string of no more than 50 characters. The search is carried out using the title attribute. In the response you will receive a list of reminders identical to the "Get list" method, no more than 50 entries long.

Search using tags

Find reminders that contain tags passed in the tags parameter. Tag search works on the OR principle.

The body of the request is shown below:

{
    "limit": 10, // Max: 50. Optional
    "tags": [ // Max size: 10
        "backend",
        "newValue"
    ]
}

Get tags

To get a unique list of tags that were added when creating reminders, use this request.

The response is presented below:

{
    "notification": null,
    "warning": null,
    "variables": null,
    "internalStatus": "000000",
    "response": [
        "work",
        "meeting",
        "backend"
    ],
    "errors": null
}