Back to explore

storage

Notes

Credits: 0.000001

Create

POST /v1/notes/Create

Create a new note

Request

textstring

note text

titlestring

note title

Response

noteobject

The created note

Request

Response

{
    "note": {
        "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
        "created": "2021-09-29T13:33:03+01:00",
        "updated": "2021-09-29T13:33:03+01:00",
        "title": "New Note",
        "text": "This is my note"
    }
}

Credits: 0.000001

Delete

POST /v1/notes/Delete

Delete a note

Request

idstring

specify the id of the note

Response

noteobject

Request

Response

{
    "note": {
        "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
        "created": "2021-09-29T13:33:03+01:00",
        "updated": "2021-09-29T13:50:20+01:00",
        "title": "Update Note",
        "text": "Updated note text"
    }
}

Credits: 0.000001

Events

POST /v1/notes/Events

Subscribe to notes events

Request

idstring

optionally specify a note id

Response

eventstring

the event which occured; create, delete, update

noteobject

the note which the operation occured on

Request

Response

{
    "event": "deleted",
    "note": {
        "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
        "created": "2021-09-29T13:33:03+01:00",
        "updated": "2021-09-29T13:50:20+01:00",
        "title": "Update Note",
        "text": "Updated note text"
    }
}

Credits: 0.000001

List

POST /v1/notes/List

List all the notes

Request

{}

Response

notesarray

the list of notes

Request

Response

{
    "notes": [
        {
            "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
            "created": "2021-09-29T13:33:03+01:00",
            "updated": "2021-09-29T13:33:03+01:00",
            "title": "New Note",
            "text": "This is my note"
        }
    ]
}

Credits: 0.000001

Read

POST /v1/notes/Read

Read a note

Request

idstring

the note id

Response

noteobject

The note

Request

Response

{
    "note": {
        "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
        "created": "2021-09-29T13:33:03+01:00",
        "updated": "2021-09-29T13:33:03+01:00",
        "title": "New Note",
        "text": "This is my note"
    }
}

Credits: 0.000001

Update

POST /v1/notes/Update

Update a note

Request

noteobject

Response

noteobject

Request

Response

{
    "note": {
        "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
        "created": "2021-09-29T13:33:03+01:00",
        "updated": "2021-09-29T13:50:20+01:00",
        "title": "Update Note",
        "text": "Updated note text"
    }
}