Journal-Einträge

Der @journal Endpoint behandelt Journaleinträge.

Achtung: Ein nachträgliches Bearbeiten von bestehenden Journaleinträgen ist nicht möglich.

Journaleintrag hinzufügen:

Mit einem POST Request wird ein neuer Journaleintrag erzeugt. Im Body wird das Attribut comment erwartet.

Parameter:

Pflicht:

comment: String
Titel des Journaleintrages.

Optional:

category: String
Journal-Kategory. Mögliche Werte können über den endpoint @vocabularies/opengever.journal.manual_entry_categories abgeholt werden.
related_documents: String[]
URLs zu Gever-Dokumenten

Beispiel-Request:

POST /dossier-1/@journal HTTP/1.1
Accept: application/json

{
  "comment": "Dossier mit externem Tool archiviert",
  "category": "phone-call",
  "related_documents": [
    "http://localhost:8080/fd/ordnungssystem/fuehrung/kommunikation/allgemeines/dossier-1/document-1",
    "http://localhost:8080/fd/ordnungssystem/fuehrung/gemeinderecht/dossier-14/document-33"
  ]
}

Beispiel-Response:

HTTP/1.1 204 No content

Journaleinträge abrufen:

Ein GET Request gibt die Journaleinträge eines Inhalts zurück.

Beispiel-Request:

GET /dossier-1/@journal HTTP/1.1
Accept: application/json

Beispiel-Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "items": [
    {
      "actor_fullname": "zopemaster",
      "actor_id": "zopemaster",
      "comments": "Ich bin ein neuer Journaleintrag",
      "related_documents": [
        {
          "@id": "http://localhost:8080/fd/ordnungssystem/fuehrung/gemeinderecht/dossier-1/document-1",
          "@type": "opengever.document.document",
          "checked_out": "robert.ziegler",
          "description": "",
          "file_extension": ".docx"
          "is_leafnode": null,
          "review_state": "document-state-draft",
          "title": "Ein Dokument"
        }
      ],
      "time": "2019-04-15T14:00:48+00:00",
      "title": "Manueller Eintrag: Telefongespräch"
    },
    {
      "actor_fullname": "zopemaster",
      "actor_id": "zopemaster",
      "comments": "Ich bin ein neuer Journaleintrag",
      "related_documents": [],
      "time": "2019-04-15T13:59:21+00:00",
      "title": "Manueller Eintrag: Telefongespräch"
    }
  ],
  "items_total": 2
}

Bemerkung

Suchresultate werden paginiert wenn die Anzahl Resultate die voreingestellte Seitengrösse (default: 25) überschreitet. Siehe Paginierung zu Details zum Umgang mit paginierten Resultaten.