Verwalten logischer Ressourcen

Über das Antwort- und Anfrageschema

Um das Antwort- und Abfrageschema anzuzeigen, klicken Sie auf die Schaltfläche Operationen erweitern (Expand Operations) neben der Ressource, für die Sie sich interessieren.

Im Abschnitt Antwortklasse (Response Class) können Sie das gesamte Modell der Ressource zusammen mit Erklärungen über das Ausfüllen von Parametern oder ein Beispiel anzeigen, wie die von Ihnen angeforderten Informationen aussehen können.

Der Abschnitt Parameter (Parameters) enthält alle von der ausgewählten Ressource unterstützten verfügbaren Parameter zusammen mit einer kurzen Erklärung. Darüber hinaus können alle unterstützten Parameter mit Informationen ausgefüllt werden, sodass Sie die Orchestrator-API beim Lesen der Dokumentation ausprobieren können.

Listenoperationen

Um alle für eine bestimmte Ressource verfügbaren Operationen anzuzeigen, klicken Sie auf die Schaltfläche Operationen auflisten (List Operationen) neben der Ressource, für die Sie sich interessieren.

Verwenden des Antwortmodells zum Erstellen von Anforderungsparametern

Das Antwortmodell jeder beliebigen Ressource hilft Ihnen, deren Struktur zu verstehen und wie man bei späteren Anfragen damit arbeitet. Es hat die folgende Anatomie:

Die Haupteinheit oder das DTO (Datentransferobjekt) und dessen Eigenschaften. Für jede Eigenschaft werden folgende Informationen angezeigt:
- der akzeptierte Werttyp, in Klammern geschrieben;
- obligatorisch oder optional - optionale Parameter sind als solche gekennzeichnet.
- Eine Erklärung bezüglich der Parameter und der maximal akzeptierten Werte.
Die Einheit der zweiten Stufe - wird nur angezeigt, wenn die Haupteinheit eine Ressource als Parameter enthält. Bitte beachten Sie, dass je nach der Hauptressource mehrere Einheiten der zweiten Stufe vorhanden sein können.

Die Gesamtanzahl der Ressourcenstufen ist von der Haupteinheit abhängig. Zum Beispiel hat RobotDto drei Stufen, während EnvironmentsDto zwei Stufen besitzt.

Strikte API

Sie können die potenzielle Belastung durch API-Anforderungen verringern, indem Sie die Mandanteneinstellung Strikte API verwenden, die im Abschnitt API-Einstellungen auf der Registerkarte Allgemein verfügbar ist. Wenn diese Einstellung aktiviert ist, können die folgenden Felder nicht gefiltert und/oder nicht sortiert werden:

Entität	Feld	Non-filterable	Non-sortable
Warteschlangenelemente	`OutputData`	Ja	Ja
	`AnalyticsData`	Ja	Ja
	`ReviewerUserId`	Keine Angabe	Ja
	`Key`	Ja	Ja
	`Reference`	Keine Angabe	Ja
	`DueDate`	Ja	Ja
	`RiskSlaDate`	Ja	Ja
	`DeferDate`	Ja	Ja
	`StartProcessing`	Ja	Keine Angabe
	`EndProcessing`	Ja	Keine Angabe
	`SecondsInPreviousAttempts`	Ja	Ja
	`AncestorId`	Ja	Ja
	`RetryNumber`	Ja	Ja
	`SpecificData`	Ja	Ja
	`CreationTime`	Ja	Ja
	`Progress`	Ja	Ja
	`RowVersion`	Ja	Ja
	`OrganizationUnitId`	Ja	Ja
	`OrganizationUnitFullyQualifiedName`	Ja	Ja