Summarische Auflistungen

Einträge in summarischen Auflistungen von Containern (“Foldern”) enthalten standardmässig die Felder @type, title, description und review_state.

Über den Query-String Parameter items.fl kann die gewünschte Liste der Felder jedoch angegeben werden (kommagetrennt), um spezifische Metadaten in der summarischen Auflistung zu erhalten.

Die zur Zeit unterstützden Felder für summarische Auflistungen sind die folgenden:

  • @type (Inhaltstyp)
  • created (Erstellungsdatum)
  • creator (Ersteller)
  • description (Beschreibung)
  • filename (Dateiname, falls Dokument)
  • filesize (Dateigrösse, falls Dokument)
  • mimetype (Datetyp, falls Dokument)
  • modified (Modifikationsdatum)
  • review_state (Workflow-Status ID)
  • review_state_label (Workflow-Status Bezeichnung)
  • title (Titel)

Der Query-String Parameter items.fl kann verwendet werden, um die in summarische Auflistungen für GET requests zu steuern.

Bemerkung

Die summarischen Auflistungen von Suchresultaten des @search endpoints haben einen ähnlichen Mechanismus (metdata_fields), der aber Kenntnis der internen Index-Namen voraussetzt, und deshalb anders benannt ist.

Beispiel anhand eines GET requests

GET /(path)?items.fl=(fieldlist)

Liefert die Attribute des Objekts unter path zurück, mit den in fieldlist angegebenen Feldern in der summarischen Auflistung der children (items).

Beispiel-Request:

GET /ordnungssystem/fuehrung/dossier-23?items.fl=filesize,filename HTTP/1.1
Accept: application/json

Beispiel-Response:

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

{
  "@context": "http://www.w3.org/ns/hydra/context.jsonld",
  "@id": "https://example.org/ordnungssystem/fuehrung/dossier-23",
  "@type": "opengever.dossier.businesscasedossier",
  "title": "Ein Geschäftsdossier",

  "...": "",

  "items": [
    {
      "@id": "https://example.org/ordnungssystem/fuehrung/dossier-23/document-259",
      "filesize": 42560,
      "filename": "vortrag.docx",
    },
    {
      "@id": "https://example.org/ordnungssystem/fuehrung/dossier-23/document-260",
      "filesize": 73536,
      "filename": "bewerbung.docx",
    }
  ],
  "parent": {
    "@id": "https://example.org/ordnungssystem/fuehrung",
    "filesize": null,
    "filename": null,
  },

  "...": ""

}
Code-Beispiel (Python)
url = 'https://example.org/ordnungssystem/fuehrung/?items.fl=filesize,filename'
response = session.get(url)
items = response.json()['items']