Zum Inhalt springen

Fehlercodes

Über die Standard-HTTP-Statuscodes hinaus geben mehrere Operationen der RealityConnect API einen maschinenlesbaren error-Code im Antwortkörper zurück, um eindeutig anzugeben, warum eine Anfrage abgelehnt wurde. Diese Seite katalogisiert jeden benannten Code nach Endpunkt, was ihn auslöst und wie er zu behandeln ist.


Operationen, die einen benannten Code zurückgeben, verwenden dieses Format; zusätzliche kontextspezifische Felder werden unten pro Endpunkt vermerkt:

{
"statusCode": 409,
"error": "NodeHasDerivatives",
"message": "..."
}

message ist optional und liefert, wenn vorhanden, eine menschenlesbare Detailangabe. Richten Sie Ihre Behandlung nach error, nicht nach message.

PATCH /v1/nodes/{nodeId}/move/{newParentId} — 409 Conflict

CodeBedeutungEmpfohlene Aktion
AccessRightsChangeRequiredDas Verschieben würde ändern, wer auf den Knoten zugreifen kann; message erläutert die konkrete ÄnderungPrüfen Sie die Zugriffsänderung, oder wiederholen Sie die Anfrage mit force: true, falls akzeptabel
MaxDepthExceededDas Verschieben würde die maximal zulässige Hierarchietiefe überschreitenVerschieben Sie den Knoten an eine flachere Position
CircularityFoundDas Zielelternelement befindet sich innerhalb des Teilbaums des zu verschiebenden KnotensWählen Sie ein Elternelement außerhalb des eigenen Teilbaums des Knotens
NodeHaveMembershipsAttachedDer Knoten verfügt über Mitgliedschaftseinträge, die das Verschieben über eine Berechtigungsgrenze hinweg blockierenEntfernen Sie zuerst die Mitgliedschaften, oder verschieben Sie innerhalb desselben Berechtigungsbereichs
NodesInDifferentRegionsDer Knoten und das Zielelternelement sind in unterschiedlichen Regionen bereitgestelltNicht behebbar — Knoten können nicht regionsübergreifend verschoben werden
NodeCannotBeMovedDieser Knotentyp unterstützt kein VerschiebenFür diesen Knotentyp nicht behebbar
DerivativesNotInCommonParentDie abgeleiteten Ausgaben des Knotens befinden sich nicht alle unter einem gemeinsamen Elternelement mit dem VerschiebezielOrganisieren Sie die abgeleiteten Objekte neu und wiederholen Sie dann die Anfrage
SourcesNotInCommonParentDie Quelleingaben des Knotens befinden sich nicht alle unter einem gemeinsamen ElternelementOrganisieren Sie die Quellen neu und wiederholen Sie dann die Anfrage
DataBundleLinkedToTwinDas Data Bundle des Knotens ist mit einem Twin verknüpftHeben Sie zuerst die Verknüpfung mit dem Twin auf
DoesNotMeetHierarchyConstraintsDas Verschieben verstößt gegen eine typspezifische HierarchieregelPrüfen Sie, welche untergeordneten Typen das Zielelternelement zulässt
MoveNodeFailedDas Verschieben wurde aus einem Grund abgelehnt, für den kein spezifischerer Code vorliegtWiederholen Sie die Anfrage; wenden Sie sich an den Support, falls das Problem weiterhin besteht

DELETE /v1/nodes/{nodeId} — 409 Conflict

CodeBedeutungEmpfohlene Aktion
NodeHasDerivativesDer Knoten hat abgeleitete Ausgaben, die zuerst entfernt werden müssen; aufgeführt in derivatives[]Löschen oder verschieben Sie die aufgeführten abgeleiteten Objekte und wiederholen Sie dann die Anfrage
NodeNotInDeletableStateDer Knoten wird derzeit verarbeitet, oder die Verarbeitung ist fehlgeschlagen, gemäß isProcessing / isFailedWarten Sie, bis die Verarbeitung abgeschlossen ist, oder beheben Sie den Fehler, und wiederholen Sie dann die Anfrage
NodeHasBundleDependantsDas Data Bundle des Knotens hat abhängige Objekte, die das Löschen blockierenEntfernen Sie zuerst die abhängigen Objekte
DeleteNodeFailedDas Löschen wurde aus einem Grund abgelehnt, für den kein spezifischerer Code vorliegtWiederholen Sie die Anfrage; wenden Sie sich an den Support, falls das Problem weiterhin besteht

Knoten im Papierkorb wiederherstellen oder endgültig löschen

Abschnitt betitelt „Knoten im Papierkorb wiederherstellen oder endgültig löschen“
EndpunktStatusCodeBedeutungEmpfohlene Aktion
PATCH /v1/nodes/{id}/restore409StorageLimitExceededDas Wiederherstellen des Knotens würde das Speicherkontingent der Organisation überschreitenGeben Sie Speicherplatz frei oder erhöhen Sie das Kontingent, und wiederholen Sie dann die Anfrage
DELETE /v1/nodes/{id}/hard409NoNodeRemovedDer Knoten wurde im Papierkorb nicht in einem löschbaren Zustand gefundenÜberprüfen Sie die Knoten-ID und deren Papierkorbstatus

POST /v1/bundles/{bundleId}/processing — 409 Conflict

CodeBedeutungEmpfohlene Aktion
ProcessingCostMismatchDie übermittelten Verarbeitungskosten stimmen nicht mehr mit den aktuellen Kosten übereinRufen Sie eine aktuelle Kostenschätzung ab und wiederholen Sie die Anfrage
NoInputDataFoundForProcessingFür dieses Bundle wurden keine zu verarbeitenden Eingabedaten gefundenStellen Sie sicher, dass die Upload-Sitzung abgeschlossen wurde, bevor Sie die Verarbeitung auslösen
InsufficientProcessingCapacityDerzeit ist keine Verarbeitungskapazität verfügbarVersuchen Sie es später erneut
FailedToLaunchProcessingDer Verarbeitungsjob konnte nicht gestartet werdenWiederholen Sie die Anfrage; wenden Sie sich an den Support, falls das Problem weiterhin besteht
EndpunktStatusCodeBedeutungEmpfohlene Aktion
POST /v1/site-files403StorageLimitExceededDas Speicherkontingent der Organisation ist ausgeschöpftGeben Sie Speicherplatz frei oder erhöhen Sie das Kontingent
POST /v1/site-files409FileAlreadyExistsEs existiert bereits eine Datei mit derselben IdentitätVerwenden Sie die vorhandene Datei, oder laden Sie sie unter einem anderen Namen hoch
POST /v1/site-files/{fileId}/finalize400FileNotCompatibleDas Format der hochgeladenen Datei ist mit dem erwarteten Dateityp nicht kompatibelÜberprüfen Sie das Dateiformat und laden Sie die Datei erneut hoch
POST /v1/bundles/{bundleId}/upload-sessions403StorageLimitExceededDas Speicherkontingent der Organisation ist ausgeschöpftGeben Sie Speicherplatz frei oder erhöhen Sie das Kontingent
POST /v1/bundles/{bundleId}/upload-sessions/{sessionId}/files403StorageLimitExceededDas Speicherkontingent der Organisation ist ausgeschöpftGeben Sie Speicherplatz frei oder erhöhen Sie das Kontingent
POST /v1/twin/{contextId}/object/attachments409StorageLimitExceededDas Speicherkontingent der Organisation ist ausgeschöpftGeben Sie Speicherplatz frei oder erhöhen Sie das Kontingent
POST /v1/twin/{contextId}/object/attachments409FileAlreadyExistsEs existiert bereits ein Anhang mit derselben IdentitätVerwenden Sie den vorhandenen Anhang, oder laden Sie ihn unter einem anderen Namen hoch

PUT /v1/groups/{groupId}/users/{userId} (Mitglied hinzufügen) — 409 Conflict

CodeBedeutungEmpfohlene Aktion
GroupHasSamlLinkDie Mitgliedschaft der Gruppe wird über eine SAML/SSO-Integration verwaltetVerwalten Sie die Mitgliedschaft über den SAML-Anbieter
CannotInviteToSCIMGroupDie Mitgliedschaft der Gruppe wird über SCIM-Provisioning verwaltetVerwalten Sie die Mitgliedschaft über den SCIM-Anbieter
UserAlreadyMemberDer Benutzer ist bereits Mitglied der GruppeKeine Aktion erforderlich

DELETE /v1/groups/{groupId}/users/{userId} (Mitglied entfernen) — 409 Conflict

CodeBedeutungEmpfohlene Aktion
GroupHasSamlLinkDie Mitgliedschaft der Gruppe wird über eine SAML/SSO-Integration verwaltetVerwalten Sie die Mitgliedschaft über den SAML-Anbieter
CannotRemoveMemberFromSCIMGroupDie Mitgliedschaft der Gruppe wird über SCIM-Provisioning verwaltetVerwalten Sie die Mitgliedschaft über den SCIM-Anbieter

POST /v1/groups und PATCH /v1/groups/{groupId} — 409 Conflict

CodeBedeutungEmpfohlene Aktion
DuplicateGroupNameIn der Organisation existiert bereits eine Gruppe mit diesem NamenWählen Sie einen anderen Namen
CannotUpdateMemberFromSCIMGroupDie Mitgliedschaft der Gruppe wird über SCIM-Provisioning verwaltetVerwalten Sie die Mitgliedschaft über den SCIM-Anbieter

DELETE /v1/groups/{groupId} — 409 Conflict

CodeBedeutungEmpfohlene Aktion
CannotRemoveSCIMGroupDie Mitgliedschaft der Gruppe wird über SCIM-Provisioning verwaltetVerwalten Sie die Mitgliedschaft über den SCIM-Anbieter
CannotRemoveOrganizationGroupDie Gruppe hat keine einzelne zugehörige DivisionNicht behebbar — diese Gruppe kann nicht über diesen Endpunkt gelöscht werden

POST /v1/nodes/{nodeId}/invitations und POST /v1/invitations verwenden dieselben Fehlercodes.

StatusCodeBedeutungEmpfohlene Aktion
409UserAlreadyInvitedFür den Benutzer liegt bereits eine ausstehende Einladung vorKeine Aktion erforderlich
409UserAlreadyMemberDer Benutzer ist bereits MitgliedKeine Aktion erforderlich
403InvalidEmailDomainDie Domain der eingeladenen E-Mail-Adresse ist für diese Organisation nicht zulässigVerwenden Sie eine E-Mail-Adresse mit einer zulässigen Domain
400CustomRoleNotAssignableToDataNodeDie angegebene benutzerdefinierte Rolle kann diesem Knoten nicht zugewiesen werdenWählen Sie eine Rolle, die diesem Knoten zugewiesen werden kann
400CustomRoleNotFoundDie angegebene benutzerdefinierte Rolle existiert nichtÜberprüfen Sie die Rollen-ID
400AdminsitrativeRoleNotFound*Die angegebene administrative Rolle existiert nichtÜberprüfen Sie die Rollen-ID
400AdministrativeRoleInvalidNodeEine administrative Rolle wurde auf einen Knoten angewendet, der dies nicht unterstütztWeisen Sie die administrative Rolle statt dessen auf Organisationsebene zu
422InvitationEmailRejectedDer Mailanbieter hat die Empfängeradresse dauerhaft abgelehntKorrigieren Sie die E-Mail-Adresse, bevor Sie es erneut versuchen
503InvitationEmailNotSentDer Mailanbieter ist vorübergehend nicht verfügbar; es wurde nichts gespeichertWiederholen Sie die Anfrage unverändert

* Dieser Codename enthält einen Tippfehler in der aktuellen API-Antwort — verwenden Sie ihn exakt wie angegeben, nicht AdministrativeRoleNotFound.

Ratenbegrenzung, Authentifizierung und Zugriffskontrolle

Abschnitt betitelt „Ratenbegrenzung, Authentifizierung und Zugriffskontrolle“

Ein 403 kann von einer der drei in Erste Schritte — Sicherheitsmodell beschriebenen Zugriffskontrollebenen stammen: OAuth-Scopes, knotenbezogene Rollen und Inhaltszugriff. Alle drei verwenden derzeit denselben Statuscode, und die meisten teilen sich denselben generischen Antwortkörper. Behandeln Sie ein 403 daher als „aus einem dieser Gründe nicht autorisiert“ und nicht als reines Scope-Problem.

StatusCodeBedeutung
429rate_limitedDer Anfragen-Bucket der Organisation ist ausgeschöpft — siehe Rate Limits
401not_authenticatedDer Anfrage fehlt ein Bearer-Token, oder das Token konnte nicht verarbeitet werden
401invalid_tokenDie Signatur- oder Ablaufprüfung des Tokens ist fehlgeschlagen
403(kein Code — message: "Insufficient OAuth scopes")Das Token enthält nicht den vom Vorgang benötigten Scope — siehe OAuth-Scopes-Referenz
403(kein Code — message: "Forbidden resource")Die Rolle oder der Inhaltszugriff des Aufrufers auf diesen Knoten erlaubt die Aktion nicht, oder die Organisation hat ein Lizenz-/Platzlimit erreicht — der Antwortkörper unterscheidet nicht, welcher Fall zutrifft
403errorCode: "SSORestrictedResource"Diese Ressource ist auf Aufrufer beschränkt, die über eine bestimmte SSO-/Identity-Provider-Sitzung authentifiziert sind
  • Siehe die API-Referenz für vollständige Anfrage- und Antwortschemata pro Operation.