Code-Beispiele

Folgend eine gesammelte Übersicht über Code-Beispiele (in Python), welche in anderen Bereichen der Dokumentation verwendet werden.

Alle diese Beispiele haben gemeinsam, dass eine session vorbereitet und verwendet werden muss, welche die richtigen Authorization und Accept Headers setzt:

import requests

session = requests.Session()
session.auth = ('username', 'password')
session.headers.update({'Accept': 'application/json'})

Siehe Headers und Authentisierung

Inhalte lesen (GET)

url = 'https://example.org/ordnungssystem/fuehrung/'
response = session.get(url)
title = response.json()['title']

Inhalte erstellen (POST)

dossier_data = {
    "@type": "opengever.dossier.businesscasedossier",
    "title": "Ein neues Dossier via API",
    "responsible": "peter.muster",
    "custody_period": 30,
    "archival_value": "unchecked",
    "retention_period": 10,
}

url = 'https://example.org/ordnungssystem/fuehrung/'
response = session.post(url, json=dossier_data)
new_dossier_url = response.headers['Location']

Inhalte bearbeiten (PATCH)

dossier_data = {
    "title": "Neuer Titel"
}

url = 'https://example.org/ordnungssystem/fuehrung/dossier-42'
response = session.patch(url, json=dossier_data)