Summarische Auflistungen

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

Über den Parameter metadata_fields kann die gewünschte Liste der Felder jedoch angegeben werden, um spezifische Metadaten in der summarischen Auflistung zu erhalten.

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

• @type (Inhaltstyp)
• created (Erstellungsdatum)
• creator (Ersteller)
• description (Beschreibung)
• dossier_type (Dossier-Typ, falls Dossier)
• 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 metadata_fields kann verwendet werden, um die in summarische Auflistungen für GET requests zu steuern.

Bemerkung

Die summarischen Auflistungen von Suchresultaten des @search endpoints verwenden den gleichen Mechanismus (metdata_fields).

Beispiel anhand eines GET requests

GET /(path)?metadata_fields=(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?metadata_fields:list=filesize&metadata_fields:list=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",
      "@type": "opengever.document.document"
      "UID": "ab8b9fa59b9c4a9a9ef0555a9bbb49bf",
      "review_state": "document_state_draft"
      "description": "..."
      "title": "..."
      "filesize": 42560,
      "filename": "vortrag.docx",


    },
    {
      "@id": "https://example.org/ordnungssystem/fuehrung/dossier-23/document-260",
      "@type": "opengever.document.document"
      "UID": "bb8b9fa59b9c4a9a9ef0555a9bbb49bf",
      "review_state": "document_state_draft"
      "description": "..."
      "title": "..."
      "filesize": 73536,
      "filename": "bewerbung.docx",
    }
  ],
  "parent": {
    "@id": "https://example.org/ordnungssystem/fuehrung",
    "@type": "opengever.document.document"
    "UID": "cb8b9fa59b9c4a9a9ef0555a9bbb49bf",
    "review_state": "document_state_draft"
    "description": "..."
    "title": "..."
    "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']