Ga naar inhoud

Foutcodes

Naast standaard HTTP-statuscodes retourneren verschillende RealityConnect API-bewerkingen een machineleesbare error-code in de response body om aan te geven waarom een verzoek is afgewezen. Deze pagina catalogiseert elke benoemde code per endpoint, wat de code veroorzaakt en hoe u deze afhandelt.


Bewerkingen die een benoemde code retourneren, gebruiken deze vorm, met extra contextspecifieke velden per endpoint hieronder:

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

message is optioneel en geeft, indien aanwezig, een leesbare toelichting. Baseer uw afhandeling op error, niet op message.

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

CodeBetekenisAanbevolen actie
AccessRightsChangeRequiredDe verplaatsing zou wijzigen wie toegang heeft tot de node; message legt de specifieke wijziging uitBekijk de toegangswijziging, of probeer het opnieuw met force: true als dat acceptabel is
MaxDepthExceededDe verplaatsing zou de maximaal toegestane hiërarchiediepte overschrijdenVerplaats de node naar een minder diepe locatie
CircularityFoundDe doelmap ligt binnen de substructuur van de te verplaatsen nodeKies een bovenliggende map buiten de eigen substructuur van de node
NodeHaveMembershipsAttachedDe node heeft lidmaatschapsgegevens die het verplaatsen over een rechtengrens heen blokkerenVerwijder eerst de lidmaatschappen, of verplaats binnen hetzelfde rechtenbereik
NodesInDifferentRegionsDe node en de doelmap zijn in verschillende regio’s geprovisioneerdNiet oplosbaar — nodes kunnen niet tussen regio’s worden verplaatst
NodeCannotBeMovedDit nodetype ondersteunt geen verplaatsingNiet oplosbaar voor dit nodetype
DerivativesNotInCommonParentDe derivaten van de node liggen niet allemaal onder een gemeenschappelijke bovenliggende map met het verplaatsingsdoelHerorganiseer de derivaten en probeer het opnieuw
SourcesNotInCommonParentDe bronnen van de node liggen niet allemaal onder een gemeenschappelijke bovenliggende mapHerorganiseer de bronnen en probeer het opnieuw
DataBundleLinkedToTwinDe data bundle van de node is gekoppeld aan een twinOntkoppel eerst de twin
DoesNotMeetHierarchyConstraintsDe verplaatsing schendt een typespecifieke hiërarchieregelControleer welke subtypen de doelmap toestaat
MoveNodeFailedDe verplaatsing is afgewezen om een reden zonder specifiekere codeProbeer het opnieuw; neem contact op met support als dit blijft optreden

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

CodeBetekenisAanbevolen actie
NodeHasDerivativesDe node heeft derivaten die eerst verwijderd moeten worden, vermeld in derivatives[]Verwijder of verplaats de vermelde derivaten en probeer het opnieuw
NodeNotInDeletableStateDe node wordt momenteel verwerkt of de verwerking is mislukt, zie isProcessing / isFailedWacht tot de verwerking is voltooid, of los de fout op, en probeer het opnieuw
NodeHasBundleDependantsDe data bundle van de node heeft afhankelijke elementen die verwijdering blokkerenVerwijder eerst de afhankelijke elementen
DeleteNodeFailedHet verwijderen is afgewezen om een reden zonder specifiekere codeProbeer het opnieuw; neem contact op met support als dit blijft optreden

Een verwijderde node herstellen of definitief verwijderen

Section titled “Een verwijderde node herstellen of definitief verwijderen”
EndpointStatusCodeBetekenisAanbevolen actie
PATCH /v1/nodes/{id}/restore409StorageLimitExceededHet herstellen van de node zou de opslagquota van de organisatie overschrijdenMaak opslagruimte vrij of verhoog de quota, en probeer het opnieuw
DELETE /v1/nodes/{id}/hard409NoNodeRemovedDe node is niet gevonden in de prullenbak in een verwijderbare statusControleer de node-id en de status in de prullenbak

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

CodeBetekenisAanbevolen actie
ProcessingCostMismatchDe opgegeven verwerkingskosten komen niet meer overeen met de huidige kostenHaal een nieuwe kostenraming op en probeer het opnieuw
NoInputDataFoundForProcessingEr zijn geen invoergegevens gevonden om voor deze bundle te verwerkenControleer of de uploadsessie is afgerond voordat verwerking wordt gestart
InsufficientProcessingCapacityEr is momenteel geen verwerkingscapaciteit beschikbaarProbeer het later opnieuw
FailedToLaunchProcessingDe verwerkingstaak kon niet worden gestartProbeer het opnieuw; neem contact op met support als dit blijft optreden
EndpointStatusCodeBetekenisAanbevolen actie
POST /v1/site-files403StorageLimitExceededDe opslagquota van de organisatie is overschredenMaak opslagruimte vrij of verhoog de quota
POST /v1/site-files409FileAlreadyExistsEr bestaat al een bestand met dezelfde identiteitGebruik het bestaande bestand, of upload onder een andere naam
POST /v1/site-files/{fileId}/finalize400FileNotCompatibleHet formaat van het geüploade bestand is niet compatibel met het verwachte bestandstypeControleer het bestandsformaat en upload opnieuw
POST /v1/bundles/{bundleId}/upload-sessions403StorageLimitExceededDe opslagquota van de organisatie is overschredenMaak opslagruimte vrij of verhoog de quota
POST /v1/bundles/{bundleId}/upload-sessions/{sessionId}/files403StorageLimitExceededDe opslagquota van de organisatie is overschredenMaak opslagruimte vrij of verhoog de quota
POST /v1/twin/{contextId}/object/attachments409StorageLimitExceededDe opslagquota van de organisatie is overschredenMaak opslagruimte vrij of verhoog de quota
POST /v1/twin/{contextId}/object/attachments409FileAlreadyExistsEr bestaat al een bijlage met dezelfde identiteitGebruik de bestaande bijlage, of upload onder een andere naam

PUT /v1/groups/{groupId}/users/{userId} (lid toevoegen) — 409 Conflict

CodeBetekenisAanbevolen actie
GroupHasSamlLinkHet lidmaatschap van de groep wordt beheerd via een SAML/SSO-integratieBeheer het lidmaatschap via de SAML-provider
CannotInviteToSCIMGroupHet lidmaatschap van de groep wordt beheerd via SCIM-provisioningBeheer het lidmaatschap via de SCIM-provider
UserAlreadyMemberDe gebruiker is al lid van de groepGeen actie nodig

DELETE /v1/groups/{groupId}/users/{userId} (lid verwijderen) — 409 Conflict

CodeBetekenisAanbevolen actie
GroupHasSamlLinkHet lidmaatschap van de groep wordt beheerd via een SAML/SSO-integratieBeheer het lidmaatschap via de SAML-provider
CannotRemoveMemberFromSCIMGroupHet lidmaatschap van de groep wordt beheerd via SCIM-provisioningBeheer het lidmaatschap via de SCIM-provider

Groepen aanmaken, hernoemen en verwijderen

Section titled “Groepen aanmaken, hernoemen en verwijderen”

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

CodeBetekenisAanbevolen actie
DuplicateGroupNameEr bestaat al een groep met deze naam in de organisatieKies een andere naam
CannotUpdateMemberFromSCIMGroupHet lidmaatschap van de groep wordt beheerd via SCIM-provisioningBeheer het lidmaatschap via de SCIM-provider

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

CodeBetekenisAanbevolen actie
CannotRemoveSCIMGroupHet lidmaatschap van de groep wordt beheerd via SCIM-provisioningBeheer het lidmaatschap via de SCIM-provider
CannotRemoveOrganizationGroupDe groep heeft geen enkele eigenaardivisieNiet oplosbaar — deze groep kan niet via dit endpoint worden verwijderd

POST /v1/nodes/{nodeId}/invitations en POST /v1/invitations gebruiken dezelfde foutcodes.

StatusCodeBetekenisAanbevolen actie
409UserAlreadyInvitedDe gebruiker heeft al een openstaande uitnodigingGeen actie nodig
409UserAlreadyMemberDe gebruiker is al lidGeen actie nodig
403InvalidEmailDomainHet domein van het uitgenodigde e-mailadres is niet toegestaan voor deze organisatieGebruik een e-mailadres met een toegestaan domein
400CustomRoleNotAssignableToDataNodeDe opgegeven aangepaste rol kan niet aan deze node worden toegewezenKies een rol die aan deze node kan worden toegewezen
400CustomRoleNotFoundDe opgegeven aangepaste rol bestaat nietControleer de rol-id
400AdminsitrativeRoleNotFound*De opgegeven administratieve rol bestaat nietControleer de rol-id
400AdministrativeRoleInvalidNodeEen administratieve rol was gericht op een node die dit niet ondersteuntWijs de administratieve rol toe op organisatieniveau
422InvitationEmailRejectedDe e-mailprovider heeft het adres van de ontvanger permanent afgewezenCorrigeer het e-mailadres voordat u het opnieuw probeert
503InvitationEmailNotSentDe e-mailprovider is tijdelijk niet beschikbaar; er is niets opgeslagenProbeer het verzoek ongewijzigd opnieuw

* Deze codenaam bevat een typefout in de huidige response van de API — gebruik deze exact zoals weergegeven, niet AdministrativeRoleNotFound.

Rate limiting, authenticatie en toegangscontrole

Section titled “Rate limiting, authenticatie en toegangscontrole”

Een 403 kan afkomstig zijn van elk van de drie toegangscontrolelagen die worden beschreven in Aan de slag — Beveiligingsmodel: OAuth-scopes, rollen per node en contenttoegang. Alle drie delen momenteel dezelfde statuscode, en de meeste delen dezelfde generieke body, dus behandel een 403 als “niet geautoriseerd om een van deze redenen” in plaats van er altijd van uit te gaan dat het om een scopeprobleem gaat.

StatusCodeBetekenis
429rate_limitedDe aanvraagbucket van de organisatie is uitgeput — zie Rate Limits
401not_authenticatedHet verzoek mist een bearer-token, of het token kon niet worden verwerkt
401invalid_tokenDe controle van de handtekening of vervaldatum van het token is mislukt
403(geen code — message: "Insufficient OAuth scopes")Het token bevat niet de scope die de bewerking vereist — zie OAuth-scopesreferentie
403(geen code — message: "Forbidden resource")De rol of contenttoegang van de aanroeper op deze node staat de actie niet toe, of de organisatie heeft een licentie-/gebruikerslimiet bereikt — de body maakt geen onderscheid tussen deze gevallen
403errorCode: "SSORestrictedResource"Deze resource is beperkt tot aanroepers die zijn geauthenticeerd via een specifieke SSO-/identiteitsprovider-sessie
  • Zie de API-referentie voor volledige verzoek- en responsschema’s per bewerking.