Referenzen abrufen

Eine Aufgabe kann mit anderen Datensätzen verknüpft werden, z.B. mit einer Diagnose oder einem Termin. Diese Verknüpfungen sind bewusst nicht Teil des Aufgaben-Objekts – das Auflösen der Ziele ist aufwändig und erfolgt daher über diesen eigenen Endpoint.

Gibt die Referenzen einer Aufgabe zurück.

Hinweis: Aufgaben werden nur weich gelöscht (Soft Delete). Ihre Referenzen bleiben dabei erhalten und sind weiterhin über diesen Endpoint abrufbar. Die Aufgabe selbst ist danach aber unveränderlich: POST und DELETE auf /references liefern dann 400.

Hinweis: Referenzen, deren Ziel der Client nicht sehen darf, werden stillschweigend herausgefiltert. meta.total zählt daher nur die für den Client sichtbaren Referenzen, nicht alle gespeicherten.

Request

GET /api/oauth/v2/resource/todos/{uuid}/references

Header

Header	Wert
Authorization	Bearer {access_token}

URL-Parameter

Parameter	Typ	Pflicht	Beschreibung
uuid	string	Ja	Eindeutige Aufgaben-ID

Query-Parameter

Parameter	Typ	Pflicht	Beschreibung
offset	integer	Nein	Startposition (Standard: 0)
limit	integer	Nein	Anzahl Ergebnisse (Standard: 50, Max: 200)

Response

Erfolg (200 OK)

{
  "data": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "type": "MedicalDiagnosis",
      "target": "c3d4e5f6-a7b8-9012-cdef-234567890123"
    }
  ],
  "meta": {
    "total": 3,
    "offset": 0,
    "limit": 50
  }
}

Response-Felder

Feld	Typ	Beschreibung
data[].id	string (UUID)	Eindeutige Referenz-ID
data[].type	string	Typ des verknüpften Ziels (siehe Erforderliche Scopes). Bei älteren Referenzen kann hier ein historischer Wert stehen (z.B. invoice oder MedicalReceiptPosition), den POST nicht akzeptiert – ein Neuanlegen der Referenz mit diesem Typ ist daher nicht möglich
data[].target	string (UUID) | null	UUID des verknüpften Datensatzes, ohne eingebettete Kurzbezeichnung. Für die Typen MedicalExternalLetter, MedicalMotherChildPass, MedicalPsychotherapy, MedicalReceipt, DVPReportEntry und Transmission gibt es keinen eigenen OAuth-Endpoint zum Nachladen – die UUID identifiziert das Ziel, ohne dass sie hier auflösbar ist
meta.total	integer	Anzahl der für den Client sichtbaren Referenzen
meta.offset	integer	Aktuelle Startposition
meta.limit	integer	Anzahl der zurückgegebenen Einträge

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/todos/b2c3d4e5-f6a7-8901-bcde-f01234567890/references?offset=0&limit=50" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

uuid *string

offset integer

limit integer

Zuerst Token anfordern

Mögliche Fehler

Status	Code	Beschreibung
401	invalid_client	Ungültiger oder fehlender Access Token
403	insufficient_scope	Scope todos nicht vorhanden
404	not_found	Aufgabe nicht gefunden