Referenz erstellen

Verknüpft eine Aufgabe mit einem anderen Datensatz.

Hinweis: Dieser Endpoint erfordert einen benutzerbezogenen OAuth-Token. Ein reiner client_credentials-Token ohne Benutzerkontext wird mit 400 invalid_request abgelehnt.

Hinweis: Der Aufruf ist idempotent. Ist das Ziel bereits verknüpft, wird keine doppelte Referenz angelegt – die Antwort liefert stattdessen die bestehende Referenz mit 200 OK statt 201 Created.

Hinweis: Die Prüfung, dass der Zieldatensatz zum selben Unternehmen gehört, gilt nur beim Anlegen neuer Referenzen. Bereits bestehende Referenzen auf Datensätze eines anderen Unternehmens – etwa über die Offisy-Oberfläche angelegt – bleiben über GET abrufbar und können weiterhin per DELETE entfernt werden.

Request

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

Header

Header	Wert
Authorization	Bearer {access_token}
Content-Type	application/json

URL-Parameter

Parameter	Typ	Pflicht	Beschreibung
uuid	string	Ja	Eindeutige Aufgaben-ID

Body-Parameter

Feld	Typ	Pflicht	Beschreibung
type	string	Ja	Typ des Ziels (siehe Erforderliche Scopes)
uuid	string	Ja	UUID des Zieldatensatzes

Erforderliche Scopes

Neben todos ist zusätzlich der Scope des jeweiligen Ziels erforderlich. Alle 24 Typen sind lesend und schreibend unterstützt.

Zusätzlicher Scope	type-Werte
medicals	MedicalDiagnosis, MedicalDoctorLetter, MedicalPatientLetter, MedicalExternalLetter, MedicalEvidence, MedicalFile, MedicalHealthNotification, MedicalIllnessNotification, MedicalLabResult, MedicalMotherChildPass, MedicalPsychotherapy, MedicalReceipt, MedicalReferral, MedicalRegulation, MedicalSportsExemption, MedicalTransport, MedicalVisitConfirmation, FeeNoteService, Transmission, DVPReportEntry
notices	AdminCustomerNotice
customers	AdminCustomerValue
appointments	Appointment
invoices	Invoice

Response

Erfolg (201 Created / 200 OK)

{
  "data": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "type": "MedicalDiagnosis",
    "target": "c3d4e5f6-a7b8-9012-cdef-234567890123"
  }
}

201 Created bei einer neu angelegten Referenz, 200 OK wenn das Ziel bereits verknüpft war.

Response-Felder

Siehe Referenzen abrufen für die vollständige Feldbeschreibung des Objekts.

Beispiele

bash

curl -X POST "https://my.offisy.at/api/oauth/v2/resource/todos/b2c3d4e5-f6a7-8901-bcde-f01234567890/references" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "beispiel",
    "uuid": "b2c3d4e5-f6a7-8901-bcde-f01234567890"
  }'

Server

Client-ID

Client-Secret

Parameter

uuid Pfad*string

type *string

uuid Body*string

Zuerst Token anfordern

Mögliche Fehler

Status	Code	Beschreibung
400	validation_error	type oder uuid fehlt/leer, type wird nicht unterstützt, oder Aufgabe ist bereits gelöscht
400	validation_error	Zieldatensatz gehört zu einem anderen Unternehmen als die Aufgabe – eine Aufgabe darf nur Datensätze des eigenen Unternehmens referenzieren (error_description: uuid must belong to the same company as the todo.)
400	invalid_request	Access Token ohne Benutzerkontext
401	invalid_client	Ungültiger oder fehlender Access Token
403	insufficient_scope	Scope todos oder der zum type gehörende Scope nicht vorhanden
404	not_found	Aufgabe nicht gefunden, uuid hat kein gültiges UUID-Format, oder Zieldatensatz existiert nicht, oder der Client darf ihn nicht sehen