Kommentare

Das Kommentarobjekt repräsentiert Kommentare zu Ideen.

Das Kommentarobjekt

{
  "id": "b0373e42-2ac9-4c5b-9dae-0e0be53f4320",
  "createdAt": "2025-03-07T13:22:12.557Z",
  "updatedAt": "2025-03-07T13:22:12.557Z",
  "text": "Hello World",
  "phase": {
    "name": "Grow",
    "kind": "GROW"
  },
  "sender": {
    "email": "test@test.com",
    "firstName": "Test"
  }
}

Felder

Feld	Typ	Beschreibung
id	`string`	Der eindeutige Bezeichner des Kommentars.
createdAt	`ISODate`	Das Datum, an dem der Kommentar erstellt wurde.
updatedAt	`ISODate`	Das Datum, an dem der Kommentar zuletzt aktualisiert wurde.
text	`string`	Der Inhalt des Kommentars
phase	Phase	Die Phase, in der der Kommentar erstellt wurde
Absender	Nutzer	Der Nutzer, der diesen Kommentar erstellt hat

Kommentare zu einer Idee auflisten

curl -X GET "https://api.ideanote.io/v1/ideas/c469e730-043d-4bda-a3a0-5e029f56c027/comments?fields=id,text,sender.firstName" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <API Token>"

const result = await fetch("https://api.ideanote.io/v1/ideas/c469e730-043d-4bda-a3a0-5e029f56c027/comments?fields=id,text,sender.firstName", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer <API Token>",
  }
});

const comment = await result.json();

Der obige Befehl gibt JSON in folgender Struktur zurück:

[
  {
    "sender": {}
  },
  {
    "sender": {}
  },
  {
    "sender": {}
  }
]

Dieser Endpunkt listet alle Kommentare zu einer Idee auf.

HTTP-Anfrage

GET /v1/ideas/:idea_id/comments

Abfrageparameter

Parameter	Beschreibung
idea_id	Die ID der Idee, für die Kommentare aufgelistet werden sollen

Kommentar abrufen

curl -X GET "https://api.ideanote.io/v1/comments/b0373e42-2ac9-4c5b-9dae-0e0be53f4320?fields=id,text,sender.firstName" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <API Token>"

const result = await fetch("https://api.ideanote.io/v1/comments/b0373e42-2ac9-4c5b-9dae-0e0be53f4320?fields=id,text,sender.firstName", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer <API Token>",
  }
});

const comment = await result.json();

Der obige Befehl gibt JSON in folgender Struktur zurück:

{
  "sender": {}
}

Dieser Endpunkt ruft einen bestimmten Kommentar ab.

HTTP-Anfrage

GET /v1/comments/:comment_id

Abfrageparameter

Parameter	Beschreibung
comment_id	Die ID des abzurufenden Kommentars

Kommentar aktualisieren

curl -X PUT "https://api.ideanote.io/v1/comments/b0373e42-2ac9-4c5b-9dae-0e0be53f4320?fields=id,text,sender.firstName" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <API Token>" \
     -d '{"text":"This is an edited comment"}'

const result = await fetch("https://api.ideanote.io/v1/comments/b0373e42-2ac9-4c5b-9dae-0e0be53f4320?fields=id,text,sender.firstName", {
  method: "PUT",
  body: {
    "text": "This is an edited comment"
  },
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer <API Token>",
  }
});

const comment = await result.json();

Der obige Befehl gibt JSON in folgender Struktur zurück:

{
  "sender": {}
}

Dieser Endpunkt aktualisiert einen bestimmten Kommentar.

HTTP-Anfrage

PUT /v1/comments/:comment_id

Abfrageparameter

Parameter	Beschreibung
comment_id	Die ID des zu aktualisierenden Kommentars

Kommentar löschen

curl -X DELETE "https://api.ideanote.io/v1/comments/b0373e42-2ac9-4c5b-9dae-0e0be53f4320" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <API Token>"

const result = await fetch("https://api.ideanote.io/v1/comments/b0373e42-2ac9-4c5b-9dae-0e0be53f4320", {
  method: "DELETE",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer <API Token>",
  }
});

Dieser Endpunkt löscht einen bestimmten Kommentar.

HTTP-Anfrage

DELETE /v1/comments/:comment_id

Abfrageparameter

Parameter	Beschreibung
comment_id	Die ID des zu löschenden Kommentars