API Jestyc Notes

La liste des requêtes de l'outil de gestion des notes :

Pour effectuer une requête sur un outil, vous devez disposer d'un token valide et de l'ID de l'outil (plus de détails).

Note

Cette requête vous permet de récupérer toutes les données d'une note en fonction de son ID (l'ID de la note peut être obtenue avec Notes ou avec NoteWrite lorsque vous ajoutez une nouvelle note).

https://api.jestyc.com/v1/Note
{
    "p": {
        "token": "TOKEN",
        "tool_id": 234,
        "note_id": 5678
    }
}
tokenToken (requis)
tool_idID de l'outil (requis)
note_idID de la note (requis)

Exemple de réponse au format JSON :

{
    "title": "Mauris molestie pharetra",
    "notes": "Etiam gravida molestie arcu. Sed eu nibh vulputate mauris sagittis placerat. Cras dictum ultricies ligula. Nullam enim.",
    "color": "1b16f9",
    "creation_date": "1589093361",
    "edition_date": "1603707423"
}

NoteDelete

Cette requête vous permet de supprimer une note en fonction de son ID (l'ID de la note peut être obtenue avec Notes ou avec NoteWrite lorsque vous ajoutez une nouvelle note).

https://api.jestyc.com/v1/NoteDelete
{
    "p": {
        "token": "TOKEN",
        "tool_id": 234,
        "note_id": 5678
    }
}
tokenToken (requis)
tool_idID de l'outil (requis)
note_idID de la note (requis)

Exemple de réponse au format JSON :

{
    "request": "success"
}

Notes

Cette requête vous permet de récupérer les données des notes qui répondent aux critères définis.

https://api.jestyc.com/v1/Notes
{
    "p": {
        "token": "TOKEN",
        "tool_id": 234,
        "user_id": 456,
        "color": "ffffff",
        "search": "lorem",
        "search_mode": 2,
        "order_by": 4,
        "limit": 10,
        "page": 1
    }
}
tokenToken (requis)
tool_idID de l'outil (requis)
user_idRecherche des notes d'un utilisateur en fonction de son ID (facultatif)
colorRecherche des notes en fonction d'une couleur (facultatif)
searchRecherche dans les notes en fonction d'un ou de plusieurs mots-clés (facultatif)
search_modeMode de recherche (facultatif, par défaut : 0, requiert le paramètre "search")
  • 0 : rechercher dans les titres et les notes
  • 1 : rechercher dans les titres uniquement
  • 2 : rechercher dans les notes uniquement
order_byMode de tri (facultatif, par défaut : 0)
  • 0 : trier par date de modification (desc)
  • 1 : trier par date de modification (asc
  • 2 : trier par date de création (desc)
  • 3 : trier par date de création (asc)
  • 4 : trier par titre (asc)
  • 5 : trier par titre (desc)
  • 6 : trier par auteur (asc)
  • 7 : trier par auteur (desc)
  • 8 : trier par couleur (asc)
  • 9 : trier par couleur (desc)
limitNombre de résultats au maximum (facultatif, par défaut : 6, au maximum : 10000)
pagePage de résultats (facultatif, par défaut : 1, requiert le paramètre "limit")

Exemple de réponse au format JSON :

[
    {
        "id": "45",
        "title": "In at pede. Cras vulputate velit eu",
        "notes": "lorem, vehicula et, rutrum eu, ultrices sit amet, risus. Donec nibh enim, gravida sit amet, dapibus id, blandit at, nisi. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus",
        "color": "",
        "creation_date": "1586379400",
        "created_by": {
            "id": "4",
            "name": "Sébastien"
        },
        "edition_date": "1600552384",
        "edited_by": {
            "id": "5",
            "name": "Paul"
        }
    },
    {
        "id": "127",
        "title": "tortor. Nunc commodo auctor velit. Aliquam",
        "notes": "lacus. Mauris non dui nec urna suscipit nonummy. Fusce fermentum fermentum arcu. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Phasellus ornare. Fusce mollis. Duis sit amet diam eu dolor egestas rhoncus. Proin nisl sem, consequat nec, mollis vitae, posuere at, velit. Cras lorem",
        "color": "",
        "creation_date": "1586061085",
        "created_by": {
            "id": "4",
            "name": "Sébastien"
        },
        "edition_date": "1603982019",
        "edited_by": {
            "id": "5",
            "name": "Paul"
        }
    },
    {
        "id": "118",
        "title": "ullamcorper. Duis at lacus. Quisque purus sapien,",
        "notes": "metus sit amet ante. Vivamus non lorem vitae odio sagittis semper. Nam tempor diam dictum sapien. Aenean massa. Integer",
        "color": "",
        "creation_date": "1582572117",
        "created_by": {
            "id": "4",
            "name": "Sébastien"
        },
        "edition_date": "1600629022",
        "edited_by": {
            "id": null,
            "name": null
        }
    }
]

NotesUsers

Cette requête vous permet d'obtenir la liste des utilisateurs ayant créé une ou plusieurs notes dans l'outil, ainsi que le nombre de notes créées par chaque utilisateur.

https://api.jestyc.com/v1/NotesUsers
{
    "p": {
        "token": "TOKEN",
        "tool_id": 234
    }
}
tokenToken (requis)
tool_idID de l'outil (requis)

Exemple de réponse au format JSON :

[
    {
        "id": "6",
        "name": "Julie",
        "count": "30"
    },
    {
        "id": "5",
        "name": "Paul",
        "count": "22"
    },
    {
        "id": "4",
        "name": "Sébastien",
        "count": "20"
    }
]
Les résultats sont triés par "name".

NoteWrite

Cette requête vous permet d'ajouter une nouvelle note ou de modifier une note existante (si l'ID de la note est renseigné, il s'agira d'une modification et s'il n'est pas renseigné ce sera un ajout).

https://api.jestyc.com/v1/NoteWrite
{
    "p": {
        "token": "TOKEN",
        "tool_id": 234,
        "note_id": 5678
    },
    "d": {
        "title": "Exemple de note",
        "notes": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum convallis porttitor velit, accumsan placerat quam eleifend in. Praesent eu lorem vitae lorem congue vulputate. Aenean scelerisque, tortor in consequat sagittis, tellus mauris suscipit urna, eget hendrerit mauris enim sed nibh.\r\n\r\nNullam sit amet ornare ante. In dictum tempor accumsan. Pellentesque dictum elit a laoreet rhoncus. Integer in felis sapien. Mauris ac vestibulum dui. Sed luctus ac odio quis rhoncus. Duis sed mattis est. Ut eget feugiat lectus.",
        "color": "ff00ff"
    }
}
tokenToken (requis)
tool_idID de l'outil (requis)
note_idID de la note (requis pour une modification, non requis pour un ajout)

Entrez dans le second tableau uniquement les valeurs des champs à modifier (ou des champs renseignés en cas d'ajout) :

titleTitre de la note (requis pour un ajout, facultatif pour une modification)
notesTexte de la note (facultatif)
colorCode couleur de la note au format hexadécimal, sans # (facultatif)

Exemple de réponse au format JSON :

{
    "request": "success"
}
S'il s'agit d'un ajout, la réponse contient également l'ID de la nouvelle note.