Missionen

Das Mission-Objekt repräsentiert eine Mission-Sammlung und enthält Ideen.

Das Mission-Objekt

{
  "id": "b3f0255d-6dc9-4c4e-b932-7186d7268a66",
  "createdAt": "2025-03-07T13:22:11.878Z",
  "updatedAt": "2025-03-07T13:22:11.957Z",
  "title": "My mission",
  "question": "How might we improve the coffee?",
  "details": null,
  "friendlyId": 1,
  "archived": false,
  "canEdit": true,
  "canCreate": true,
  "stats": {
    "ideas": {
      "total": 1,
      "days7": 1
    }
  },
  "defaultPhase": {
    "name": "Comment",
    "kind": "GROW"
  },
  "section": {
    "title": "General"
  },
  "cover": {
    "url": {
      "thumbnail": "https://uploads.staging.ideanote.dev/static/gradients/1024x256/gradient869.jpg"
    }
  }
}

Felder

Feld	Typ	Beschreibung
Kennung	`string`	Der eindeutige Bezeichner der Mission.
createdAt	`ISODate`	Das Datum, an dem die Mission erstellt wurde.
updatedAt	`ISODate`	Das Datum, an dem die Mission zuletzt aktualisiert wurde.
Titel	`string`	Der Titel der Mission
Frage	`string`	Die Frage der Mission
details	`string`	Die Details der Mission
friendlyId	`string`	Die menschenlesbare ID der Mission
archiviert	`boolean`	Gibt an, ob diese Mission archiviert ist
canEdit	`boolean`	Gibt an, ob der autorisierte Nutzer diese Mission bearbeiten kann
canCreate	`boolean`	Gibt an, ob der autorisierte Nutzer Ideen in der Mission erstellen kann
stats.ideas.total	`number`	Die Gesamtzahl der Ideen in der Mission
stats.ideas.days7	`number`	Die Gesamtzahl der Ideen in der Mission, die in den letzten 7 Tagen erstellt wurden
defaultPhase	Phase	Die Standardphase der Ideen in der Mission
Abschnitt	`Section`	Der Abschnitt, dem die Mission zugeordnet wurde
Titelbild	Medien	Das Titelbild der Mission

Missionen auflisten

curl -X GET "https://api.ideanote.io/v1/missions?fields=id,title,question,details,stats.ideas.total,cover.url.thumbnail" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <API Token>"

const result = await fetch("https://api.ideanote.io/v1/missions?fields=id,title,question,details,stats.ideas.total,cover.url.thumbnail", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer <API Token>",
  }
});

const missions = await result.json();

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

[
  {
    "details": null,
    "stats": {
      "ideas": {
        "total": 1
      }
    },
    "cover": {
      "url": {
        "thumbnail": "https://uploads.ideanote.dev/static/gradients/1024x256/gradient869.jpg"
      }
    }
  },
  {
    "details": null,
    "stats": {
      "ideas": {
        "total": 2
      }
    },
    "cover": {
      "url": {
        "thumbnail": "https://uploads.ideanote.dev/static/gradients/1024x256/gradient673.jpg"
      }
    }
  }
]

Dieser Endpunkt listet Missionen auf.

HTTP-Anfrage

GET /v1/missions

Mission abrufen

curl -X GET "https://api.ideanote.io/v1/missions/b3f0255d-6dc9-4c4e-b932-7186d7268a66?fields=id,title,question,details,stats.ideas.total,cover.url.thumbnail" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <API Token>"

const result = await fetch("https://api.ideanote.io/v1/missions/b3f0255d-6dc9-4c4e-b932-7186d7268a66?fields=id,title,question,details,stats.ideas.total,cover.url.thumbnail", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer <API Token>",
  }
});

const mission = await result.json();

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

{
  "details": null,
  "stats": {
    "ideas": {
      "total": 1
    }
  },
  "cover": {
    "url": {
      "thumbnail": "https://uploads.ideanote.dev/static/gradients/1024x256/gradient869.jpg"
    }
  }
}

Dieser Endpunkt ruft eine bestimmte Mission ab.

HTTP-Anfrage

GET /v1/missions/:mission_id

Abfrageparameter

Parameter	Beschreibung
mission_id	Die ID der abzurufenden Mission

Mission erstellen

curl -X POST "https://api.ideanote.io/v1/missions?fields=id,title,question,details,stats.ideas.total,cover.url.thumbnail" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <API Token>" \
     -d '{"question":"How do we improve the coffee?"}'

const result = await fetch("https://api.ideanote.io/v1/missions?fields=id,title,question,details,stats.ideas.total,cover.url.thumbnail", {
  method: "POST",
  body: {
    "question": "How do we improve the coffee?"
  },
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer <API Token>",
  }
});

const missions = await result.json();

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

{
  "title": null,
  "details": null,
  "stats": {
    "ideas": {
      "total": 0
    }
  },
  "cover": null
}

Dieser Endpunkt erstellt eine neue Mission.

HTTP-Anfrage

POST /v1/missions

Mission aktualisieren

curl -X PUT "https://api.ideanote.io/v1/missions/b3f0255d-6dc9-4c4e-b932-7186d7268a66?fields=id,title,question,details,stats.ideas.total,cover.url.thumbnail" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <API Token>" \
     -d '{"question":"How do we improve the cantina?"}'

const result = await fetch("https://api.ideanote.io/v1/missions/b3f0255d-6dc9-4c4e-b932-7186d7268a66?fields=id,title,question,details,stats.ideas.total,cover.url.thumbnail", {
  method: "PUT",
  body: {
    "question": "How do we improve the cantina?"
  },
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer <API Token>",
  }
});

const mission = await result.json();

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

{
  "details": null,
  "stats": {
    "ideas": {
      "total": 1
    }
  },
  "cover": {
    "url": {
      "thumbnail": "https://uploads.ideanote.dev/static/gradients/1024x256/gradient869.jpg"
    }
  }
}

Dieser Endpunkt aktualisiert eine bestimmte Mission.

HTTP-Anfrage

PUT /v1/missions/:mission_id

Abfrageparameter

Parameter	Beschreibung
mission_id	Die ID der zu aktualisierenden Mission

Mission löschen

curl -X DELETE "https://api.ideanote.io/v1/missions/b3f0255d-6dc9-4c4e-b932-7186d7268a66" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <API Token>"

const result = await fetch("https://api.ideanote.io/v1/missions/b3f0255d-6dc9-4c4e-b932-7186d7268a66", {
  method: "DELETE",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer <API Token>",
  }
});

Dieser Endpunkt löscht eine bestimmte Mission.

HTTP-Anfrage

DELETE /v1/missions/:mission_id

Abfrageparameter

Parameter	Beschreibung
mission_id	Die ID der zu löschenden Mission