Kommentarer

Kommentarobjektet repræsenterer kommentarer til ideer.

Kommentarobjektet

{
  "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"
  }
}

Felter

Felt	Type	Beskrivelse
identifikator	`string`	Kommentarens unikke identifikator.
createdAt	`ISODate`	Datoen, hvor kommentaren blev oprettet.
updatedAt	`ISODate`	Datoen, hvor kommentaren sidst blev opdateret.
tekst	`string`	Kommentarens indhold
fase	Fase	Den fase, hvor kommentaren blev oprettet
afsender	Bruger	Brugeren, der oprettede denne kommentar

Vis kommentarer til en ide

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();

Ovenstående kommando returnerer JSON med følgende struktur:

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

Dette endpoint viser alle kommentarer til en ide.

HTTP-anmodning

GET /v1/ideas/:idea_id/comments

Forespørgselsparametre

Parameter	Beskrivelse
idea_id	ID'et på den ide, hvis kommentarer skal vises

Hent kommentar

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();

Ovenstående kommando returnerer JSON med følgende struktur:

{
  "sender": {}
}

Dette endpoint henter en bestemt kommentar.

HTTP-anmodning

GET /v1/comments/:comment_id

Forespørgselsparametre

Parameter	Beskrivelse
comment_id	ID'et på den kommentar, der skal hentes

Opdater kommentar

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();

Ovenstående kommando returnerer JSON med følgende struktur:

{
  "sender": {}
}

Dette endpoint opdaterer en bestemt kommentar.

HTTP-anmodning

PUT /v1/comments/:comment_id

Forespørgselsparametre

Parameter	Beskrivelse
comment_id	ID'et på den kommentar, der skal opdateres

Slet kommentar

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>",
  }
});

Dette endpoint sletter en bestemt kommentar.

HTTP-anmodning

DELETE /v1/comments/:comment_id

Forespørgselsparametre

Parameter	Beskrivelse
comment_id	ID'et på den kommentar, der skal slettes